Run pre-commit and linting

Author: ericholscher

.travis.yml

@@ -1,11 +1,12 @@
 language: python
 python:
-  - 2.7
   - 3.6
 env:
   - ES_VERSION=6.2.4 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
 matrix:
   include:
+    - python: 3.6
+      env: TOXENV=py36 ES_VERSION=1.3.9 ES_DOWNLOAD_URL=https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
     - python: 3.6
       env: TOXENV=docs
     - python: 3.6
@@ -45,6 +46,6 @@ notifications:
 
 branches:
   only:
-  - master 
+  - master
   - rel # Community release branch
   - relcorp # Corporate release branch

common

@@ -6,7 +6,6 @@
 import sys
 
 import sphinx_rtd_theme
-from recommonmark.parser import CommonMarkParser
 
 sys.path.insert(0, os.path.abspath('..'))
 sys.path.append(os.path.dirname(__file__))
@@ -29,13 +28,11 @@
     'doc_extensions',
     'sphinx_tabs.tabs',
     'sphinx-prompt',
+    'recommonmark',
 ]
 templates_path = ['_templates']
 
 source_suffix = ['.rst', '.md']
-source_parsers = {
-    '.md': CommonMarkParser,
-}
 
 master_doc = 'index'
 project = u'Read the Docs'

docs/conf.py

@@ -233,7 +233,7 @@ We deploy readthedocs.org from the `rel` branch in our GitHub repository. You ca
 
 
 How can I avoid search results having a deprecated version of my docs?
----------------------------------------------------------------------
+----------------------------------------------------------------------
 
 If readers search something related to your docs in Google, it will probably return the most relevant version of your documentation.
 It may happen that this version is already deprecated and you want to stop Google indexing it as a result,

docs/faq.rst

@@ -602,10 +602,8 @@ def save(self, *args, **kwargs):  # noqa
         """
         if self.pk is None or self._config_changed:
             previous = self.previous
-            if (
-                previous is not None and self._config and
-                self._config == previous.config
-            ):
+            if (previous is not None and self._config and
+                    self._config == previous.config):
                 previous_pk = previous._config.get(self.CONFIG_KEY, previous.pk)
                 self._config = {self.CONFIG_KEY: previous_pk}
         super().save(*args, **kwargs)

readthedocs/builds/models.py

@@ -4,6 +4,7 @@
 
 import logging
 import textwrap
+from urllib.parse import urlparse
 
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
@@ -17,12 +18,11 @@
 from django.utils.decorators import method_decorator
 from django.views.generic import DetailView, ListView
 from requests.utils import quote
-from urllib.parse import urlparse
 
-from readthedocs.doc_builder.exceptions import BuildEnvironmentError
 from readthedocs.builds.models import Build, Version
 from readthedocs.core.permissions import AdminPermission
 from readthedocs.core.utils import trigger_build
+from readthedocs.doc_builder.exceptions import BuildEnvironmentError
 from readthedocs.projects.models import Project
 
 
@@ -110,7 +110,8 @@ def get_context_data(self, **kwargs):
         context['project'] = self.project
 
         build = self.get_object()
-        if build.error != BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(build_id=build.pk):
+        if build.error != BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(
+                build_id=build.pk):
             # Do not suggest to open an issue if the error is not generic
             return context
 

readthedocs/builds/views.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # pylint: disable=too-many-lines
 
 """Build configuration for rtd."""
@@ -63,13 +64,14 @@
 INVALID_KEYS_COMBINATION = 'invalid-keys-combination'
 INVALID_KEY = 'invalid-key'
 
-DOCKER_DEFAULT_IMAGE = getattr(settings, 'DOCKER_DEFAULT_IMAGE', 'readthedocs/build')
+DOCKER_DEFAULT_IMAGE = getattr(
+    settings, 'DOCKER_DEFAULT_IMAGE', 'readthedocs/build'
+)
 DOCKER_DEFAULT_VERSION = getattr(settings, 'DOCKER_DEFAULT_VERSION', '2.0')
 # These map to corresponding settings in the .org,
 # so they haven't been renamed.
 DOCKER_IMAGE = getattr(
-    settings,
-    'DOCKER_IMAGE',
+    settings, 'DOCKER_IMAGE',
     '{}:{}'.format(DOCKER_DEFAULT_IMAGE, DOCKER_DEFAULT_VERSION)
 )
 DOCKER_IMAGE_SETTINGS = getattr(settings, 'DOCKER_IMAGE_SETTINGS', {})
@@ -240,9 +242,7 @@ def python_full_version(self):
             # Get the highest version of the major series version if user only
             # gave us a version of '2', or '3'
             ver = max(
-                v
-                for v in self.get_valid_python_versions()
-                if v < ver + 1
+                v for v in self.get_valid_python_versions() if v < ver + 1
             )
         return ver
 
@@ -467,9 +467,7 @@ def validate_requirements_file(self):
         if not requirements_file:
             return None
         with self.catch_validation_error('requirements_file'):
-            requirements_file = validate_file(
-                requirements_file, self.base_path
-            )
+            requirements_file = validate_file(requirements_file, self.base_path)
         return requirements_file
 
     def validate_formats(self):
@@ -744,24 +742,21 @@ def validate_python_install(self, index):
             requirements_key = key + '.requirements'
             with self.catch_validation_error(requirements_key):
                 requirements = validate_file(
-                    self.pop_config(requirements_key),
-                    self.base_path
+                    self.pop_config(requirements_key), self.base_path
                 )
                 python_install['requirements'] = requirements
         elif 'path' in raw_install:
             path_key = key + '.path'
             with self.catch_validation_error(path_key):
                 path = validate_directory(
-                    self.pop_config(path_key),
-                    self.base_path
+                    self.pop_config(path_key), self.base_path
                 )
                 python_install['path'] = path
 
             method_key = key + '.method'
             with self.catch_validation_error(method_key):
                 method = validate_choice(
-                    self.pop_config(method_key, PIP),
-                    self.valid_install_method
+                    self.pop_config(method_key, PIP), self.valid_install_method
                 )
                 python_install['method'] = method
 
@@ -1026,13 +1021,9 @@ def python(self):
         python = self._config['python']
         for install in python['install']:
             if 'requirements' in install:
-                python_install.append(
-                    PythonInstallRequirements(**install)
-                )
+                python_install.append(PythonInstallRequirements(**install))
             elif 'path' in install:
-                python_install.append(
-                    PythonInstall(**install)
-                )
+                python_install.append(PythonInstall(**install))
         return Python(
             version=python['version'],
             install=python_install,

readthedocs/config/config.py

@@ -22,10 +22,7 @@ def __init__(self, **kwargs):
             setattr(self, name, kwargs[name])
 
     def as_dict(self):
-        return {
-            name: to_dict(getattr(self, name))
-            for name in self.__slots__
-        }
+        return {name: to_dict(getattr(self, name)) for name in self.__slots__}
 
 
 class Build(Base):
@@ -45,7 +42,11 @@ class PythonInstallRequirements(Base):
 
 class PythonInstall(Base):
 
-    __slots__ = ('path', 'method', 'extra_requirements',)
+    __slots__ = (
+        'path',
+        'method',
+        'extra_requirements',
+    )
 
 
 class Conda(Base):

readthedocs/config/models.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """Shared functions for the config module."""
 
 
@@ -6,22 +7,13 @@ def to_dict(value):
     if hasattr(value, 'as_dict'):
         return value.as_dict()
     if isinstance(value, list):
-        return [
-            to_dict(v)
-            for v in value
-        ]
+        return [to_dict(v) for v in value]
     if isinstance(value, dict):
-        return {
-            k: to_dict(v)
-            for k, v in value.items()
-        }
+        return {k: to_dict(v) for k, v in value.items()}
     return value
 
 
 def list_to_dict(list_):
     """Transform a list to a dictionary with its indices as keys."""
-    dict_ = {
-        str(i): element
-        for i, element in enumerate(list_)
-    }
+    dict_ = {str(i): element for i, element in enumerate(list_)}
     return dict_

readthedocs/config/utils.py

@@ -15,9 +15,5 @@ class Command(BaseCommand):
     def handle(self, *args, **options):
         if args:
             for slug in args:
-                for service in GitHubService.for_user(
-                    User.objects.get(
-                        username=slug,
-                    ),
-                ):
+                for service in GitHubService.for_user(User.objects.get(username=slug,),):
                     service.sync()

readthedocs/core/management/commands/import_github.py

@@ -37,7 +37,9 @@ def handle(self, *args, **options):
             print('Invalid GitHub token, exiting')
             return
 
-        for project in Project.objects.filter(programming_language__in=['none', '', 'words']).filter(repo__contains='github'):  # noqa
+        for project in Project.objects.filter(
+                programming_language__in=['none', '', 'words']
+        ).filter(repo__contains='github'):  # noqa
             user = repo = ''
             repo_url = project.repo
             for regex in GITHUB_REGEXS:

readthedocs/core/management/commands/import_github_language.py

@@ -68,8 +68,7 @@ def process_request(self, request):
             subdomain = domain_parts[0]
             is_www = subdomain.lower() == 'www'
             if not is_www and (  # Support ports during local dev
-                    public_domain in host or public_domain in full_host
-            ):
+                    public_domain in host or public_domain in full_host):
                 if not Project.objects.filter(slug=subdomain).exists():
                     raise Http404(_('Project not found'))
                 request.subdomain = True
@@ -78,10 +77,8 @@ def process_request(self, request):
                 return None
 
         # Serve CNAMEs
-        if (
-            public_domain not in host and production_domain not in host and
-            'localhost' not in host and 'testserver' not in host
-        ):
+        if (public_domain not in host and production_domain not in host and
+                'localhost' not in host and 'testserver' not in host):
             request.cname = True
             domains = Domain.objects.filter(domain=host)
             if domains.count():
@@ -97,10 +94,8 @@ def process_request(self, request):
                             ),
                         )
                         break
-            if (
-                not hasattr(request, 'domain_object') and
-                'HTTP_X_RTD_SLUG' in request.META
-            ):
+            if (not hasattr(request, 'domain_object') and
+                    'HTTP_X_RTD_SLUG' in request.META):
                 request.slug = request.META['HTTP_X_RTD_SLUG'].lower()
                 request.urlconf = SUBDOMAIN_URLCONF
                 request.rtdheader = True
@@ -253,25 +248,23 @@ class FooterNoSessionMiddleware(SessionMiddleware):
     """
 
     IGNORE_URLS = [
-        '/api/v2/footer_html', '/sustainability/view', '/sustainability/click',
+        '/api/v2/footer_html',
+        '/sustainability/view',
+        '/sustainability/click',
     ]
 
     def process_request(self, request):
         for url in self.IGNORE_URLS:
-            if (
-                request.path_info.startswith(url) and
-                settings.SESSION_COOKIE_NAME not in request.COOKIES
-            ):
+            if (request.path_info.startswith(url) and
+                    settings.SESSION_COOKIE_NAME not in request.COOKIES):
                 # Hack request.session otherwise the Authentication middleware complains.
                 request.session = {}
                 return
         super().process_request(request)
 
     def process_response(self, request, response):
         for url in self.IGNORE_URLS:
-            if (
-                request.path_info.startswith(url) and
-                settings.SESSION_COOKIE_NAME not in request.COOKIES
-            ):
+            if (request.path_info.startswith(url) and
+                    settings.SESSION_COOKIE_NAME not in request.COOKIES):
                 return response
         return super().process_response(request, response)

readthedocs/core/middleware.py

@@ -152,7 +152,8 @@ def symlink_cnames(self, domain=None):
         if domain:
             domains = [domain]
         else:
-            domains = Domain.objects.filter(project=self.project).values_list('domain', flat=True)
+            domains = Domain.objects.filter(project=self.project
+                                            ).values_list('domain', flat=True)
         for dom in domains:
             log_msg = 'Symlinking CNAME: {} -> {}'.format(
                 dom,
@@ -191,11 +192,8 @@ def remove_symlink_cname(self, domain):
         """
         log_msg = 'Removing symlink for CNAME {}'.format(domain)
         log.info(
-            constants.LOG_TEMPLATE.format(
-                project=self.project.slug,
-                version='',
-                msg=log_msg
-            ),
+            constants.LOG_TEMPLATE
+            .format(project=self.project.slug, version='', msg=log_msg),
         )
         symlink = os.path.join(self.CNAME_ROOT, domain)
         safe_unlink(symlink)

readthedocs/core/symlink.py

@@ -205,7 +205,8 @@ def github_build(request):  # noqa: D205
             else:
                 data = json.loads(request.body)
             http_url = data['repository']['url']
-            http_search_url = http_url.replace('http://', '').replace('https://', '')
+            http_search_url = http_url.replace('http://',
+                                               '').replace('https://', '')
             ssh_url = data['repository']['ssh_url']
             ssh_search_url = ssh_url.replace('git@', '').replace('.git', '')
             branches = [data['ref'].replace('refs/heads/', '')]
@@ -300,7 +301,9 @@ def bitbucket_build(request):
             else:
                 data = json.loads(request.body)
 
-            version = 2 if request.META.get('HTTP_USER_AGENT') == 'Bitbucket-Webhooks/2.0' else 1  # yapf: disabled  # noqa
+            version = 2 if request.META.get(
+                'HTTP_USER_AGENT'
+            ) == 'Bitbucket-Webhooks/2.0' else 1  # yapf: disabled  # noqa
             if version == 1:
                 branches = [
                     commit.get('branch', '') for commit in data['commits']