Merge pull request readthedocs#2911 from rtfd/lint-core

Finish core app linting

Author: ericholscher

prospector-more.yml

@@ -3,7 +3,6 @@ inherits: prospector
 strictness: medium
 
 ignore-paths:
-  - core/
   - donate/
   - restapi/
 

readthedocs/core/__init__.py

@@ -1 +1,3 @@
+"""App initialization."""
+
 default_app_config = 'readthedocs.core.apps.CoreAppConfig'

readthedocs/core/adapters.py

@@ -35,7 +35,7 @@ def send_mail(self, template_prefix, email, context):
         removed_keys = []
         for key in context.keys():
             try:
-                _ = pickle.dumps(context[key])
+                _ = pickle.dumps(context[key])  # noqa for F841
             except (pickle.PickleError, TypeError):
                 removed_keys.append(key)
                 del context[key]

readthedocs/core/admin.py

@@ -53,6 +53,9 @@ def queryset(self, request, queryset):
 
 
 class UserAdminExtra(UserAdmin):
+
+    """Admin configuration for User."""
+
     list_display = ('username', 'email', 'first_name',
                     'last_name', 'is_staff', 'is_banned')
     list_filter = (UserProjectFilter,) + UserAdmin.list_filter

readthedocs/core/apps.py

@@ -1,3 +1,5 @@
+"""App configurations for core app."""
+
 from django.apps import AppConfig
 
 

readthedocs/core/backends.py

@@ -1,3 +1,5 @@
+"""Email backends for core app."""
+
 import smtplib
 
 from django.core.mail.utils import DNS_NAME
@@ -15,6 +17,6 @@ def open(self):
             if self.username and self.password:
                 self.connection.login(self.username, self.password)
             return True
-        except:
+        except Exception:
             if not self.fail_silently:
                 raise

readthedocs/core/context_processors.py

@@ -1,8 +1,10 @@
+"""Template context processors for core app."""
+
 from django.conf import settings
 
 
 def readthedocs_processor(request):
-
+    # pylint: disable=unused-argument
     exports = {
         'PUBLIC_DOMAIN': getattr(settings, 'PUBLIC_DOMAIN', None),
         'PRODUCTION_DOMAIN': getattr(settings, 'PRODUCTION_DOMAIN', None),

readthedocs/core/forms.py

@@ -1,3 +1,5 @@
+"""Forms for core app."""
+
 import logging
 
 from haystack.forms import SearchForm
@@ -25,7 +27,7 @@ def __init__(self, *args, **kwargs):
         try:
             self.fields['first_name'].initial = self.instance.user.first_name
             self.fields['last_name'].initial = self.instance.user.last_name
-        except:
+        except AttributeError:
             pass
 
     def save(self, *args, **kwargs):

readthedocs/core/management/commands/archive.py

@@ -1,3 +1,5 @@
+"""Rebuild documentation for all projects"""
+
 from glob import glob
 import os
 import logging
@@ -11,11 +13,7 @@
 
 class Command(BaseCommand):
 
-    """
-    Custom management command to rebuild documentation for all projects.
-
-    Invoked via ``./manage.py update_repos``.
-    """
+    help = __doc__
 
     def handle(self, *args, **options):
         doc_index = {}

readthedocs/core/management/commands/clean_builds.py

@@ -1,3 +1,5 @@
+"""Clean up stable build paths per project version"""
+
 from datetime import datetime, timedelta
 import logging
 from optparse import make_option
@@ -12,7 +14,7 @@
 
 class Command(BaseCommand):
 
-    help = ('Clean up stale build paths per project version')
+    help = __doc__
 
     option_list = BaseCommand.option_list + (
         make_option('--days',

readthedocs/core/management/commands/import_github.py

@@ -1,3 +1,5 @@
+"""Resync GitHub project for user"""
+
 from django.core.management.base import BaseCommand
 from django.contrib.auth.models import User
 
@@ -6,6 +8,8 @@
 
 class Command(BaseCommand):
 
+    help = __doc__
+
     def handle(self, *args, **options):
         if len(args):
             for slug in args:

readthedocs/core/management/commands/import_github_language.py

@@ -1,3 +1,13 @@
+"""
+Import a project's programming language from GitHub
+
+This builds a basic management command that will set
+a projects language to the most used one in GitHub.
+
+Requires a ``GITHUB_AUTH_TOKEN`` to be set in the environment,
+which should contain a proper GitHub Oauth Token for rate limiting.
+"""
+
 import os
 import requests
 
@@ -15,17 +25,10 @@
 
 class Command(BaseCommand):
 
-    """
-    Import a project's programming language from GitHub.
-
-    This builds a basic management command that will set
-    a projects language to the most used one in GitHub.
-
-    Requires a ``GITHUB_AUTH_TOKEN`` to be set in the environment,
-    which should contain a proper GitHub Oauth Token for rate limiting.
-    """
+    help = __doc__
 
     def handle(self, *args, **options):
+        # pylint: disable=too-many-locals
         token = os.environ.get('GITHUB_AUTH_TOKEN')
         if not token:
             print 'Invalid GitHub token, exiting'

readthedocs/core/management/commands/pull.py

@@ -1,7 +1,8 @@
+"""Trigger build for project slug"""
+
 import logging
 
 from django.core.management.base import BaseCommand
-from django.conf import settings
 
 from readthedocs.builds.constants import LATEST
 from readthedocs.projects import tasks, utils
@@ -11,6 +12,9 @@
 
 
 class Command(BaseCommand):
+
+    help = __doc__
+
     def handle(self, *args, **options):
         if len(args):
             for slug in args:

readthedocs/core/management/commands/reindex_elasticsearch.py

@@ -1,3 +1,5 @@
+"""Reindex Elastic Search indexes"""
+
 import logging
 from optparse import make_option
 
@@ -14,6 +16,7 @@
 
 class Command(BaseCommand):
 
+    help = __doc__
     option_list = BaseCommand.option_list + (
         make_option('-p',
                     dest='project',
@@ -32,20 +35,21 @@ def handle(self, *args, **options):
             if not queryset.exists():
                 raise CommandError(
                     'No project with slug: {slug}'.format(slug=project))
-            log.info("Building all versions for %s" % project)
+            log.info("Building all versions for %s", project)
         elif getattr(settings, 'INDEX_ONLY_LATEST', True):
             queryset = queryset.filter(slug=LATEST)
 
         for version in queryset:
-            log.info("Reindexing %s" % version)
+            log.info("Reindexing %s", version)
             try:
                 commit = version.project.vcs_repo(version.slug).commit
-            except:
-                # This will happen on prod
+            except:  # pylint: disable=bare-except
+                # An exception can be thrown here in production, but it's not
+                # documented what the exception here is
                 commit = None
 
             try:
                 update_search(version.pk, commit,
                               delete_non_commit_files=False)
             except Exception:
-                log.error('Reindex failed for %s' % version, exc_info=True)
+                log.error('Reindex failed for %s', version, exc_info=True)

readthedocs/core/management/commands/set_metadata.py

@@ -1,8 +1,8 @@
+"""Generate metadata for all projects"""
+
 import logging
-from optparse import make_option
 
 from django.core.management.base import BaseCommand
-from django.conf import settings
 
 from readthedocs.projects import tasks
 from readthedocs.projects.models import Project
@@ -11,11 +11,14 @@
 
 
 class Command(BaseCommand):
+
+    help = __doc__
+
     def handle(self, *args, **options):
         queryset = Project.objects.all()
         for p in queryset:
-            log.info("Generating metadata for %s" % p)
+            log.info("Generating metadata for %s", p)
             try:
                 tasks.update_static_metadata(p.pk)
             except Exception:
-                log.error('Build failed for %s' % p, exc_info=True)
+                log.error('Build failed for %s', p, exc_info=True)

readthedocs/core/management/commands/symlink.py

@@ -1,3 +1,5 @@
+"""Update symlinks for projects"""
+
 import logging
 
 from django.core.management.base import BaseCommand
@@ -11,6 +13,8 @@
 
 class Command(BaseCommand):
 
+    help = __doc__
+
     def add_arguments(self, parser):
         parser.add_argument('projects', nargs='+', type=str)
 

readthedocs/core/management/commands/update_api.py

@@ -1,3 +1,11 @@
+"""
+Build documentation using the API and not hitting a database.
+
+Usage::
+
+    ./manage.py update_api <slug>
+"""
+
 import logging
 
 from django.core.management.base import BaseCommand
@@ -10,13 +18,7 @@
 
 class Command(BaseCommand):
 
-    """
-    Build documentation using the API and not hitting a database.
-
-    Usage::
-
-        ./manage.py update_api <slug>
-    """
+    help = __doc__
 
     def add_arguments(self, parser):
         parser.add_argument('--docker', action='store_true', default=False)
@@ -27,5 +29,5 @@ def handle(self, *args, **options):
         for slug in options['projects']:
             project_data = api.project(slug).get()
             p = tasks.make_api_project(project_data)
-            log.info("Building %s" % p)
+            log.info("Building %s", p)
             tasks.update_docs.run(pk=p.pk, docker=docker)

readthedocs/core/management/commands/update_repos.py

@@ -1,3 +1,9 @@
+"""
+Custom management command to rebuild documentation for all projects.
+
+Invoked via ``./manage.py update_repos``.
+"""
+
 import logging
 from optparse import make_option
 
@@ -12,12 +18,9 @@
 
 class Command(BaseCommand):
 
-    """
-    Custom management command to rebuild documentation for all projects.
-
-    Invoked via ``./manage.py update_repos``.
-    """
+    """Management command for rebuilding documentation on projects"""
 
+    help = __doc__
     option_list = BaseCommand.option_list + (
         make_option('-r',
                     action='store_true',
@@ -42,11 +45,11 @@ def handle(self, *args, **options):
         if len(args):
             for slug in args:
                 if version and version != "all":
-                    log.info("Updating version %s for %s" % (version, slug))
+                    log.info("Updating version %s for %s", version, slug)
                     for version in Version.objects.filter(project__slug=slug, slug=version):
                         trigger_build(project=version.project, version=version)
                 elif version == "all":
-                    log.info("Updating all versions for %s" % slug)
+                    log.info("Updating all versions for %s", slug)
                     for version in Version.objects.filter(project__slug=slug,
                                                           active=True,
                                                           uploaded=False):
@@ -55,7 +58,7 @@ def handle(self, *args, **options):
                                               version_pk=version.pk)
                 else:
                     p = Project.all_objects.get(slug=slug)
-                    log.info("Building %s" % p)
+                    log.info("Building %s", p)
                     trigger_build(project=p, force=force, record=record)
         else:
             if version == "all":
@@ -71,7 +74,3 @@ def handle(self, *args, **options):
                 for project in Project.objects.all():
                     tasks.update_docs.run(pk=project.pk, record=record,
                                           force=force)
-
-    @property
-    def help(self):
-        return Command.__doc__

readthedocs/core/management/commands/update_versions.py

@@ -1,3 +1,5 @@
+"""Rebuild documentation for all projects"""
+
 from django.core.management.base import BaseCommand
 
 from readthedocs.builds.models import Version
@@ -6,11 +8,7 @@
 
 class Command(BaseCommand):
 
-    """
-    Custom management command to rebuild documentation for all projects.
-
-    Invoked via ``./manage.py update_repos``.
-    """
+    help = __doc__
 
     def handle(self, *args, **options):
         for version in Version.objects.filter(active=True, built=False):

readthedocs/core/middleware.py

@@ -1,3 +1,5 @@
+"""Middleware for core app."""
+
 import logging
 
 from django.utils.translation import ugettext_lazy as _
@@ -27,7 +29,15 @@
 
 class SubdomainMiddleware(object):
 
+    """Middleware to display docs for non-dashboard domains"""
+
     def process_request(self, request):
+        """Process requests for unhandled domains
+
+        If the request is not for our ``PUBLIC_DOMAIN``, or if ``PUBLIC_DOMAIN``
+        is not set and the request is for a subdomain on ``PRODUCTION_DOMAIN``,
+        process the request as a request a documentation project.
+        """
         if not getattr(settings, 'USE_SUBDOMAIN', False):
             return None