Lint search branch

Author: ericholscher

common

@@ -5,9 +5,7 @@
 import fnmatch
 import logging
 import os
-from six.moves import shlex_quote
 
-from builtins import object  # pylint: disable=redefined-builtin
 from django.conf import settings
 from django.contrib.auth.models import User
 from django.db import models
@@ -658,10 +656,7 @@ def full_dash_path(self, version=LATEST):
 
     def full_json_path(self, version=LATEST):
         """The path to the build json docs in the project."""
-        json_path = os.path.join(
-            self.conf_dir(version),
-            '_build', 'json'
-        )
+        json_path = os.path.join(self.conf_dir(version), '_build', 'json')
         return json_path
 
     def full_singlehtml_path(self, version=LATEST):
@@ -849,7 +844,8 @@ def get_latest_build(self, finished=True):
     def api_versions(self):
         from readthedocs.builds.models import APIVersion
         ret = []
-        for version_data in api.project(self.pk).active_versions.get()['versions']:
+        for version_data in api.project(self.pk
+                                        ).active_versions.get()['versions']:
             version = APIVersion(**version_data)
             ret.append(version)
         return sort_version_aware(ret)
@@ -1044,13 +1040,8 @@ def __init__(self, *args, **kwargs):
         ad_free = (not kwargs.pop('show_advertising', True))
         # These fields only exist on the API return, not on the model, so we'll
         # remove them to avoid throwing exceptions due to unexpected fields
-        for key in [
-                'users',
-                'resource_uri',
-                'absolute_url',
-                'downloads',
-                'main_language_project',
-                'related_projects']:
+        for key in ['users', 'resource_uri', 'absolute_url', 'downloads',
+                    'main_language_project', 'related_projects']:
             try:
                 del kwargs[key]
             except KeyError:
@@ -1134,9 +1125,9 @@ def json_file_path(self):
         basename = os.path.splitext(self.path)[0]
         file_path = basename + '.fjson'
 
-        full_json_path = self.project.get_production_media_path(type_='json',
-                                                                version_slug=self.version.slug,
-                                                                include_file=False)
+        full_json_path = self.project.get_production_media_path(
+            type_='json', version_slug=self.version.slug, include_file=False
+        )
 
         file_path = os.path.join(full_json_path, file_path)
         return file_path
@@ -1146,12 +1137,11 @@ def get_processed_json(self):
         try:
             return process_file(file_path)
         except Exception:
-            log.warning('Unhandled exception during search processing file: %s' % file_path)
+            log.warning(
+                'Unhandled exception during search processing file: %s' % file_path
+            )
         return {
-            'headers': [],
-            'content': '',
-            'path': file_path,
-            'title': '',
+            'headers': [], 'content': '', 'path': file_path, 'title': '',
             'sections': []
         }
 
@@ -1296,36 +1286,30 @@ def add_features(sender, **kwargs):
         (USE_SETUPTOOLS_LATEST, _('Use latest version of setuptools')),
         (ALLOW_DEPRECATED_WEBHOOKS, _('Allow deprecated webhook views')),
         (PIP_ALWAYS_UPGRADE, _('Always run pip install --upgrade')),
-        (SKIP_SUBMODULES, _('Skip git submodule checkout')),
-        (
+        (SKIP_SUBMODULES, _('Skip git submodule checkout')), (
             DONT_OVERWRITE_SPHINX_CONTEXT,
             _(
                 'Do not overwrite context vars in conf.py with Read the Docs context',
             ),
-        ),
-        (
+        ), (
             ALLOW_V2_CONFIG_FILE,
             _(
                 'Allow to use the v2 of the configuration file',
             ),
-        ),
-        (
+        ), (
             MKDOCS_THEME_RTD,
             _('Use Read the Docs theme for MkDocs as default theme')
-        ),
-        (
+        ), (
             DONT_SHALLOW_CLONE,
             _(
                 'Do not shallow clone when cloning git repos',
             ),
-        ),
-        (
+        ), (
             USE_TESTING_BUILD_IMAGE,
             _(
                 'Use Docker image labelled as `testing` to build the docs',
             ),
-        ),
-        (API_LARGE_DATA, _('Try alternative method of posting large data'))
+        ), (API_LARGE_DATA, _('Try alternative method of posting large data'))
     )
 
     projects = models.ManyToManyField(

readthedocs/projects/models.py

@@ -15,9 +15,9 @@
 
 files_changed = django.dispatch.Signal(providing_args=['project', 'files'])
 
-bulk_post_create = django.dispatch.Signal(providing_args=["instance_list"])
+bulk_post_create = django.dispatch.Signal(providing_args=['instance_list'])
 
-bulk_post_delete = django.dispatch.Signal(providing_args=["instance_list"])
+bulk_post_delete = django.dispatch.Signal(providing_args=['instance_list'])
 
 # Used to force verify a domain (eg. for SSL cert issuance)
 domain_verify = django.dispatch.Signal(providing_args=['domain'])

readthedocs/projects/signals.py

@@ -62,16 +62,15 @@
 from readthedocs.restapi.client import api as api_v2
 from readthedocs.vcs_support import utils as vcs_support_utils
 from readthedocs.worker import app
+
 from .constants import LOG_TEMPLATE
 from .exceptions import RepositoryError
-from .models import Domain, ImportedFile, Project
-from .models import HTMLFile
+from .models import Domain, HTMLFile, ImportedFile, Project
 from .signals import (
     after_build,
     after_vcs,
     before_build,
     before_vcs,
-    files_changed,
     bulk_post_create,
     bulk_post_delete,
     domain_verify,
@@ -1153,8 +1152,9 @@ def _manage_imported_files(version, path, commit):
             else:
                 model_class = ImportedFile
 
-            dirpath = os.path.join(root.replace(path, '').lstrip('/'),
-                                   filename.lstrip('/'))
+            dirpath = os.path.join(
+                root.replace(path, '').lstrip('/'), filename.lstrip('/')
+            )
             full_path = os.path.join(root, filename)
             md5 = hashlib.md5(open(full_path, 'rb').read()).hexdigest()
             try:
@@ -1184,8 +1184,10 @@ def _manage_imported_files(version, path, commit):
 
     # Delete the HTMLFile first from previous commit and
     # send bulk_post_delete signal for bulk removing from Elasticsearch
-    delete_queryset = (HTMLFile.objects.filter(project=version.project, version=version)
-                                       .exclude(commit=commit))
+    delete_queryset = (
+        HTMLFile.objects.filter(project=version.project,
+                                version=version).exclude(commit=commit)
+    )
     # Keep the objects into memory to send it to signal
     instance_list = list(delete_queryset)
     # Safely delete from database
@@ -1194,8 +1196,11 @@ def _manage_imported_files(version, path, commit):
     bulk_post_delete.send(sender=HTMLFile, instance_list=instance_list)
 
     # Delete ImportedFiles from previous versions
-    (ImportedFile.objects.filter(project=version.project, version=version)
-                         .exclude(commit=commit).delete())
+    (
+        ImportedFile.objects.filter(project=version.project,
+                                    version=version).exclude(commit=commit
+                                                             ).delete()
+    )
     changed_files = [
         resolve_path(
             version.project,

readthedocs/projects/tasks.py

@@ -24,7 +24,7 @@
 from readthedocs.builds.constants import LATEST
 from readthedocs.builds.models import Version
 from readthedocs.builds.views import BuildTriggerMixin
-from readthedocs.projects.models import ImportedFile, Project
+from readthedocs.projects.models import Project
 from readthedocs.search.documents import PageDocument
 from readthedocs.search.views import LOG_TEMPLATE
 
@@ -262,8 +262,10 @@ def elastic_project_search(request, project_slug):
 
     if query:
         req = PageDocument.simple_search(query=query)
-        filtered_query = (req.filter('term', project=project.slug)
-                             .filter('term', version=version_slug))
+        filtered_query = (
+            req.filter('term', project=project.slug)
+            .filter('term', version=version_slug)
+        )
         paginated_query = filtered_query[:50]
         results = paginated_query.execute()
 

readthedocs/projects/views/public.py

@@ -7,7 +7,13 @@
 from rest_framework import routers
 
 from readthedocs.constants import pattern_opts
-from readthedocs.restapi.views import (core_views, footer_views, task_views, integrations)
+from readthedocs.restapi.views import (
+    core_views,
+    footer_views,
+    integrations,
+    task_views,
+)
+
 from .views.model_views import (
     BuildCommandViewSet,
     BuildViewSet,
@@ -105,12 +111,10 @@
     ),
 ]
 
-
 urlpatterns += function_urls
 urlpatterns += task_urls
 urlpatterns += integration_urls
 
-
 if 'readthedocsext.donate' in settings.INSTALLED_APPS:
     # pylint: disable=import-error
     from readthedocsext.donate.restapi.urls import urlpatterns \

readthedocs/restapi/urls.py

@@ -27,10 +27,8 @@ def process_all_json_files(version, build_dir=True):
     html_files = []
     for root, _, files in os.walk(full_path):
         for filename in fnmatch.filter(files, '*.fjson'):
-            if filename in [
-                    'search.fjson',
-                    'genindex.fjson',
-                    'py-modindex.fjson']:
+            if filename in ['search.fjson', 'genindex.fjson',
+                            'py-modindex.fjson']:
                 continue
             html_files.append(os.path.join(root, filename))
     page_list = []

readthedocs/search/parse_json.py

@@ -12,9 +12,10 @@
 from readthedocs.search.documents import PageDocument, ProjectDocument
 from readthedocs.search.tasks import index_objects_to_es
 
-before_project_search = django.dispatch.Signal(providing_args=["body"])
-before_file_search = django.dispatch.Signal(providing_args=["body"])
-before_section_search = django.dispatch.Signal(providing_args=["body"])
+
+before_project_search = django.dispatch.Signal(providing_args=['body'])
+before_file_search = django.dispatch.Signal(providing_args=['body'])
+before_section_search = django.dispatch.Signal(providing_args=['body'])
 
 
 @receiver(bulk_post_create, sender=HTMLFile)

readthedocs/search/signals.py

@@ -1,14 +1,13 @@
+# -*- coding: utf-8 -*-
 
 import pytest
 from django.core.urlresolvers import reverse
 from django_dynamic_fixture import G
-
 from pyquery import PyQuery as pq
 
-
 from readthedocs.builds.constants import LATEST
 from readthedocs.builds.models import Version
-from readthedocs.projects.models import Project, HTMLFile
+from readthedocs.projects.models import HTMLFile, Project
 from readthedocs.search.tests.utils import get_search_query_from_project_file
 
 
@@ -34,7 +33,7 @@ def test_search_by_project_name(self, client, project):
         assert project.name.encode('utf-8') in result.text().encode('utf-8')
 
     def test_search_project_show_languages(self, client, project):
-        """Test that searching project should show all available languages"""
+        """Test that searching project should show all available languages."""
         # Create a project in bn and add it as a translation
         G(Project, language='bn', name=project.name)
 
@@ -49,7 +48,7 @@ def test_search_project_show_languages(self, client, project):
         assert 'bn' in content.text()
 
     def test_search_project_filter_language(self, client, project):
-        """Test that searching project filtered according to language"""
+        """Test that searching project filtered according to language."""
         # Create a project in bn and add it as a translation
         translate = G(Project, language='bn', name=project.name)
         search_params = {'q': project.name, 'language': 'bn'}
@@ -94,7 +93,8 @@ def test_file_search(self, client, project, data_type, page_num):
 
     @pytest.mark.parametrize('case', ['upper', 'lower', 'title'])
     def test_file_search_case_insensitive(self, client, project, case):
-        """Check File search is case insensitive
+        """
+        Check File search is case insensitive.
 
         It tests with uppercase, lowercase and camelcase
         """
@@ -111,10 +111,11 @@ def test_file_search_case_insensitive(self, client, project, case):
         assert query_text in result.text()
 
     def test_file_search_exact_match(self, client, project):
-        """Check quoted query match exact phrase
+        """
+        Check quoted query match exact phrase.
 
-        Making a query with quoted text like ``"foo bar"`` should match
-        exactly ``foo bar`` phrase.
+        Making a query with quoted text like ``"foo bar"`` should match exactly
+        ``foo bar`` phrase.
         """
 
         # `Github` word is present both in `kuma` and `pipeline` files
@@ -128,7 +129,7 @@ def test_file_search_exact_match(self, client, project):
         assert len(result) == 1
 
     def test_page_search_not_return_removed_page(self, client, project):
-        """Check removed page are not in the search index"""
+        """Check removed page are not in the search index."""
         query = get_search_query_from_project_file(project_slug=project.slug)
         # Make a query to check it returns result
         result, _ = self._get_search_result(url=self.url, client=client,
@@ -143,7 +144,8 @@ def test_page_search_not_return_removed_page(self, client, project):
         assert len(result) == 0
 
     def test_file_search_show_projects(self, client, all_projects):
-        """Test that search result page shows list of projects while searching for files"""
+        """Test that search result page shows list of projects while searching
+        for files."""
 
         # `Github` word is present both in `kuma` and `pipeline` files
         # so search with this phrase

readthedocs/search/tests/test_views.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from readthedocs.projects.models import HTMLFile
 
 

readthedocs/search/tests/utils.py

@@ -9,12 +9,12 @@
 import os
 import re
 
-from builtins import next, range
 from django.shortcuts import get_object_or_404
 from pyquery import PyQuery
 
 from readthedocs.projects.models import Project
 
+
 log = logging.getLogger(__name__)
 
 
@@ -338,7 +338,7 @@ def get_project_list_or_404(project_slug, user):
 
 
 def get_chunk(total, chunk_size):
-    """Yield successive `chunk_size` chunks"""
+    """Yield successive `chunk_size` chunks."""
     # Based on https://stackoverflow.com/a/312464
     # licensed under cc by-sa 3.0
     for i in range(0, total, chunk_size):