linting core app

prospector-more.yml

@@ -6,7 +6,6 @@ ignore-paths:
   - api/
   - cdn/
   - comments/
-  - core/
   - doc_builder/
   - donate/
   - notifications/

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 as e:
             if not self.fail_silently:
-                raise
+                raise e

readthedocs/core/context_processors.py

@@ -1,3 +1,5 @@
+"""Template context processors for core app."""
+
 from django.conf import settings
 
 

readthedocs/core/forms.py

@@ -1,3 +1,5 @@
+"""Forms for core app."""
+
 import logging
 
 from haystack.forms import SearchForm

readthedocs/core/management/commands/clean_builds.py

@@ -1,3 +1,4 @@
+
 from datetime import datetime, timedelta
 import logging
 from optparse import make_option

readthedocs/core/management/commands/import_github_language.py

@@ -26,6 +26,7 @@ class Command(BaseCommand):
     """
 
     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,6 @@
 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

readthedocs/core/management/commands/reindex_elasticsearch.py

@@ -32,12 +32,12 @@ 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:
@@ -48,4 +48,4 @@ def handle(self, *args, **options):
                 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,6 @@
 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
@@ -14,8 +12,8 @@ class Command(BaseCommand):
     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/update_api.py

@@ -27,5 +27,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

@@ -42,11 +42,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 +55,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":

readthedocs/core/middleware.py

@@ -1,3 +1,5 @@
+"""Middleware for core app."""
+
 import logging
 
 from django.utils.translation import ugettext_lazy as _

readthedocs/core/models.py

@@ -1,3 +1,5 @@
+"""Models for the core app."""
+
 import logging
 
 from django.db import models

readthedocs/core/signals.py

@@ -1,3 +1,5 @@
+"""Signal handling for core app."""
+
 import logging
 from urlparse import urlparse
 
@@ -16,7 +18,7 @@
 webhook_bitbucket = Signal(providing_args=['project', 'data', 'event'])
 
 
-def decide_if_cors(sender, request, **kwargs):
+def decide_if_cors(sender, request, **kwargs):  # pylint: disable=unused-argument
     """
     Decide whether a request should be given CORS access.
 

readthedocs/core/templatetags/core_tags.py

@@ -1,3 +1,5 @@
+"""Template tags for core app."""
+
 import urllib
 import hashlib
 
@@ -68,15 +70,15 @@ def restructuredtext(value, short=False):
 def get_project(slug):
     try:
         return Project.objects.get(slug=slug)
-    except:
+    except Project.DoesNotExist:
         return None
 
 
 @register.filter
 def get_version(slug):
     try:
         return Project.objects.get(slug=slug)
-    except:
+    except Project.DoesNotExist:
         return None
 
 

readthedocs/core/urls/__init__.py

@@ -1,3 +1,5 @@
+"""URL configuration for core app."""
+
 from django.conf.urls import url
 
 from django_filters import views as django_filters_views

readthedocs/core/urls/single_version.py

@@ -1,3 +1,5 @@
+"""URL configuration for a single version."""
+
 from operator import add
 
 from django.conf.urls import url

readthedocs/core/urls/subdomain.py

@@ -1,3 +1,5 @@
+"""URL configurations for subdomains."""
+
 from operator import add
 
 from django.conf.urls import url, patterns

readthedocs/core/utils/__init__.py

@@ -23,7 +23,7 @@
 
 def run_on_app_servers(command):
     """A helper to copy a single file across app servers"""
-    log.info("Running %s on app servers" % command)
+    log.info("Running %s on app servers", command)
     ret_val = 0
     if getattr(settings, "MULTIPLE_APP_SERVERS", None):
         for server in settings.MULTIPLE_APP_SERVERS:
@@ -36,7 +36,7 @@ def run_on_app_servers(command):
         return ret
 
 
-def broadcast(type, task, args):
+def broadcast(type, task, args):  # pylint: disable=redefined-builtin
     assert type in ['web', 'app', 'build']
     default_queue = getattr(settings, 'CELERY_DEFAULT_QUEUE', 'celery')
     if type in ['web', 'app']:
@@ -53,11 +53,11 @@ def broadcast(type, task, args):
 def clean_url(url):
     parsed = urlparse(url)
     if parsed.scheme:
-        scheme, netloc = parsed.scheme, parsed.netloc
+        _, netloc = parsed.scheme, parsed.netloc  # noqa for F841
     elif parsed.netloc:
-        scheme, netloc = "http", parsed.netloc
+        _, netloc = "http", parsed.netloc  # noqa for F841
     else:
-        scheme, netloc = "http", parsed.path
+        _, netloc = "http", parsed.path  # noqa for F841
     return netloc
 
 
@@ -126,7 +126,7 @@ def trigger_build(project, version=None, record=True, force=False, basic=False):
 
 
 def send_email(recipient, subject, template, template_html, context=None,
-               request=None):
+               request=None):  # pylint: disable=unused-argument
     """Alter context passed in and call email send task
 
     .. seealso::

readthedocs/core/utils/extend.py

@@ -21,6 +21,7 @@ def get_override_class(proxy_class, default_class=None):
         proxy_class.__name__
     ])
     class_path = getattr(settings, 'CLASS_OVERRIDES', {}).get(class_id)
+    # pylint: disable=protected-access
     if class_path is None and proxy_class._override_setting is not None:
         class_path = getattr(settings, proxy_class._override_setting, None)
     if class_path is not None:

readthedocs/core/utils/tasks/__init__.py

@@ -1,7 +1,7 @@
-from .permission_checks import user_id_matches
-from .public import PublicTask
-from .public import TaskNoPermission
-from .public import permission_check
-from .public import get_public_task_data
-from .retrieve import TaskNotFound
-from .retrieve import get_task_data
+from .permission_checks import user_id_matches  # noqa
+from .public import PublicTask  # noqa
+from .public import TaskNoPermission  # noqa
+from .public import permission_check  # noqa
+from .public import get_public_task_data  # noqa
+from .retrieve import TaskNotFound  # noqa
+from .retrieve import get_task_data  # noqa

readthedocs/core/utils/tasks/permission_checks.py

@@ -1,7 +1,7 @@
 __all__ = ('user_id_matches',)
 
 
-def user_id_matches(request, state, context):
+def user_id_matches(request, state, context):  # pylint: disable=unused-argument
     user_id = context.get('user_id', None)
     if user_id is not None and request.user.is_authenticated():
         if request.user.id == user_id:

readthedocs/core/utils/tasks/public.py

@@ -67,7 +67,7 @@ def run(self, *args, **kwargs):
         result = self.run_public(*args, **kwargs)
         if result is not None:
             self.set_public_data(result)
-        state, info = self.get_task_data()
+        _, info = self.get_task_data()
         return info
 
     def after_return(self, status, retval, task_id, args, kwargs, einfo):

readthedocs/core/utils/tasks/retrieve.py

@@ -1,3 +1,5 @@
+"""Utilities for retrieving task data."""
+
 from djcelery import celery as celery_app
 from celery.result import AsyncResult
 

readthedocs/core/validators.py

@@ -1,3 +1,5 @@
+"""Validators for core app."""
+
 # From https://github.com/django/django/pull/3477/files
 import re
 

readthedocs/core/views/__init__.py

@@ -68,7 +68,7 @@ def get_context_data(self, **kwargs):
         return context
 
 
-def random_page(request, project_slug=None):
+def random_page(request, project_slug=None):  # pylint: disable=unused-argument
     imported_file = ImportedFile.objects.order_by('?')
     if project_slug:
         imported_file = imported_file.filter(project__slug=project_slug)
@@ -100,19 +100,19 @@ def wipe_version(request, project_slug, version_slug):
                                   context_instance=RequestContext(request))
 
 
-def divide_by_zero(request):
+def divide_by_zero(request):  # pylint: disable=unused-argument
     return 1 / 0
 
 
-def server_error_500(request, exception, template_name='500.html'):
+def server_error_500(request, exception, template_name='500.html'):  # pylint: disable=unused-argument  # noqa
     """A simple 500 handler so we get media"""
     r = render_to_response(template_name,
                            context_instance=RequestContext(request))
     r.status_code = 500
     return r
 
 
-def server_error_404(request, exception, template_name='404.html'):
+def server_error_404(request, exception, template_name='404.html'):  # pylint: disable=unused-argument  # noqa
     """A simple 404 handler so we get media"""
     response = get_redirect_response(request, path=request.get_full_path())
     if response: