Resolve linting messages in readthedocs.restapi.*

Author: gregmuellegger

readthedocs/restapi/permissions.py

@@ -43,6 +43,3 @@ def has_object_permission(self, request, view, obj):
         has_perm = super(APIPermission, self).has_object_permission(
             request, view, obj)
         return has_perm or (request.user and request.user.is_staff)
-
-
-

readthedocs/restapi/urls.py

@@ -19,8 +19,14 @@
     url(r'docurl/', 'readthedocs.restapi.views.core_views.docurl', name='docurl'),
     url(r'cname/', 'readthedocs.restapi.views.core_views.cname', name='cname'),
     url(r'footer_html/', 'readthedocs.restapi.views.footer_views.footer_html', name='footer_html'),
-    url(r'index_search/', 'readthedocs.restapi.views.search_views.index_search', name='index_search'),
+    url(r'index_search/',
+        'readthedocs.restapi.views.search_views.index_search',
+        name='index_search'),
     url(r'search/$', 'readthedocs.restapi.views.search_views.search', name='api_search'),
-    url(r'search/project/$', 'readthedocs.restapi.views.search_views.project_search', name='api_project_search'),
-    url(r'search/section/$', 'readthedocs.restapi.views.search_views.section_search', name='api_section_search'),
+    url(r'search/project/$',
+        'readthedocs.restapi.views.search_views.project_search',
+        name='api_project_search'),
+    url(r'search/section/$',
+        'readthedocs.restapi.views.search_views.section_search',
+        name='api_section_search'),
 )

readthedocs/restapi/utils.py

@@ -41,7 +41,8 @@ def sync_versions(project, versions, type):
                     type=type,
                     machine=False,
                 )
-                log.info("(Sync Versions) Updated Version: [%s=%s] " % (version['verbose_name'], version['identifier']))
+                log.info("(Sync Versions) Updated Version: [%s=%s] " % (
+                    version['verbose_name'], version['identifier']))
         else:
             # New Version
             created_version = Version.objects.create(
@@ -82,15 +83,16 @@ def delete_versions(project, version_data):
         return set()
 
 
-def index_search_request(version, page_list, commit, project_scale, page_scale, section=True, delete=True):
+def index_search_request(version, page_list, commit, project_scale, page_scale,
+                         section=True, delete=True):
     log_msg = ' '.join([page['path'] for page in page_list])
     log.info("(Server Search) Indexing Pages: %s [%s]" % (
         version.project.slug, log_msg))
     project = version.project
     page_obj = PageIndex()
     section_obj = SectionIndex()
 
-    #tags = [tag.name for tag in project.tags.all()]
+    # tags = [tag.name for tag in project.tags.all()]
 
     project_obj = ProjectIndex()
     project_obj.index_document(data={
@@ -125,7 +127,10 @@ def index_search_request(version, page_list, commit, project_scale, page_scale,
         if section:
             for section in page['sections']:
                 section_index_list.append({
-                    'id': hashlib.md5('%s-%s-%s-%s' % (project.slug, version.slug, page['path'], section['id'])).hexdigest(),
+                    'id': hashlib.md5(
+                        '%s-%s-%s-%s' % (project.slug, version.slug,
+                                         page['path'], section['id'])
+                    ).hexdigest(),
                     'project': project.slug,
                     'version': version.slug,
                     'path': page['path'],

readthedocs/restapi/views/core_views.py

@@ -59,7 +59,9 @@ def docurl(request):
     doc = request.GET.get('doc', 'index')
 
     project = get_object_or_404(Project, slug=project)
-    version = get_object_or_404(Version.objects.public(request.user, project=project, only_active=False), slug=version)
+    version = get_object_or_404(
+        Version.objects.public(request.user, project=project, only_active=False),
+        slug=version)
     return Response({
         'url': make_document_url(project=project, version=version.slug, page=doc)
     })

readthedocs/restapi/views/footer_views.py

@@ -27,11 +27,15 @@ def footer_html(request):
     new_theme = (theme == "sphinx_rtd_theme")
     using_theme = (theme == "default")
     project = get_object_or_404(Project, slug=project_slug)
-    version = get_object_or_404(Version.objects.public(request.user, project=project, only_active=False), slug=version_slug)
+    version = get_object_or_404(
+        Version.objects.public(request.user, project=project, only_active=False),
+        slug=version_slug)
     main_project = project.main_language_project or project
 
     if page_slug and page_slug != "index":
-        if main_project.documentation_type == "sphinx_htmldir" or main_project.documentation_type == "mkdocs":
+        if (
+                main_project.documentation_type == "sphinx_htmldir" or
+                main_project.documentation_type == "mkdocs"):
             path = page_slug + "/"
         elif main_project.documentation_type == "sphinx_singlehtml":
             path = "index.html#document-" + page_slug
@@ -41,10 +45,11 @@ def footer_html(request):
         path = ""
 
     if version.type == 'tag' and version.project.has_pdf(version.slug):
-        print_url = 'https://keminglabs.com/print-the-docs/quote?project={project}&version={version}'.format(
-            project=project.slug,
-            version=version.slug,
-        )
+        print_url = (
+            'https://keminglabs.com/print-the-docs/quote?project={project}&version={version}'
+            .format(
+                project=project.slug,
+                version=version.slug))
     else:
         print_url = None
 

readthedocs/restapi/views/model_views.py

@@ -43,7 +43,9 @@ def valid_versions(self, request, **kwargs):
         project = get_object_or_404(
             Project.objects.api(self.request.user), pk=kwargs['pk'])
         if not project.num_major or not project.num_minor or not project.num_point:
-            return Response({'error': 'Project does not support point version control'}, status=status.HTTP_400_BAD_REQUEST)
+            return Response(
+                {'error': 'Project does not support point version control'},
+                status=status.HTTP_400_BAD_REQUEST)
         version_strings = project.supported_versions()
         # Disable making old versions inactive for now.
         # project.versions.exclude(verbose_name__in=version_strings).update(active=False)

readthedocs/restapi/views/search_views.py

@@ -32,7 +32,9 @@ def index_search(request):
     project_scale = 1
     page_scale = 1
 
-    utils.index_search_request(version=version, page_list=data['page_list'], commit=commit, project_scale=project_scale, page_scale=page_scale)
+    utils.index_search_request(
+        version=version, page_list=data['page_list'], commit=commit,
+        project_scale=project_scale, page_scale=page_scale)
 
     return Response({'indexed': True})
 
@@ -133,8 +135,9 @@ def section_search(request):
     Facets
     ------
 
-    When you search, you will have a ``project`` facet, which includes the number of matching sections per project.
-    When you search inside a project, the ``path`` facet will show the number of matching sections per page.
+    When you search, you will have a ``project`` facet, which includes the
+    number of matching sections per project. When you search inside a project,
+    the ``path`` facet will show the number of matching sections per page.
 
     Possible GET args
     -----------------
@@ -155,7 +158,9 @@ def section_search(request):
     """
     query = request.GET.get('q', None)
     if not query:
-        return Response({'error': 'Search term required. Use the "q" GET arg to search. '}, status=status.HTTP_400_BAD_REQUEST)
+        return Response(
+            {'error': 'Search term required. Use the "q" GET arg to search. '},
+            status=status.HTTP_400_BAD_REQUEST)
 
     project_slug = request.GET.get('project', None)
     version_slug = request.GET.get('version', LATEST)