Merge branch 'master' of https://github.com/rtfd/readthedocs.org

Author: fmoor

docs/conda.rst

@@ -25,9 +25,8 @@ You can enable it by creating a `readthedocs.yml` file in the root of your repos
 This Conda environment will also have Sphinx and other build time dependencies installed.
 It will use the same order of operations that we support currently:
 
-* Environment Creation (``conda create``)
+* Environment Creation (``conda env create``)
 * Dependency Installation (Sphinx)
-* User Package Installation (``conda env update``)
 
 Custom Installs
 ---------------

prospector-more.yml

@@ -3,25 +3,13 @@ inherits: prospector
 strictness: medium
 
 ignore-paths:
-  - api/
-  - bookmarks/
-  - builds/
-  - cdn/
-  - comments/
   - core/
   - doc_builder/
   - donate/
-  - gold/
-  - notifications/
-  - payments/
-  - privacy/
-  - profiles/
   - projects/
   - redirects/
   - restapi/
-  - rtd_tests/
   - search/
-  - settings/
 
 pylint:
   options:

readthedocs/api/base.py

@@ -1,9 +1,9 @@
+"""API resources"""
 import logging
 import json
 import redis
 
 from django.contrib.auth.models import User
-from django.conf import settings
 from django.conf.urls import url
 from django.shortcuts import get_object_or_404
 from django.core.cache import cache
@@ -16,7 +16,7 @@
 from tastypie.utils import dict_strip_unicode_keys, trailing_slash
 
 from readthedocs.builds.constants import LATEST
-from readthedocs.builds.models import Build, Version
+from readthedocs.builds.models import Version
 from readthedocs.core.utils import trigger_build
 from readthedocs.projects.models import Project, ImportedFile
 from readthedocs.restapi.views.footer_views import get_version_compare_data
@@ -27,6 +27,9 @@
 
 
 class ProjectResource(ModelResource, SearchMixin):
+
+    """API resource for Project model."""
+
     users = fields.ToManyField('readthedocs.api.base.UserResource', 'users')
 
     class Meta(object):
@@ -115,6 +118,9 @@ def override_urls(self):
 
 
 class VersionResource(ModelResource):
+
+    """API resource for Version model."""
+
     project = fields.ForeignKey(ProjectResource, 'project', full=True)
 
     class Meta(object):
@@ -133,7 +139,7 @@ def get_object_list(self, request):
         self._meta.queryset = Version.objects.api(user=request.user)
         return super(VersionResource, self).get_object_list(request)
 
-    def version_compare(self, request, project_slug, base=None, **kwargs):
+    def version_compare(self, request, project_slug, base=None, **__):
         project = get_object_or_404(Project, slug=project_slug)
         if base and base != LATEST:
             try:
@@ -180,6 +186,9 @@ def override_urls(self):
 
 
 class FileResource(ModelResource, SearchMixin):
+
+    """API resource for ImportedFile model."""
+
     project = fields.ForeignKey(ProjectResource, 'project', full=True)
 
     class Meta(object):
@@ -207,7 +216,7 @@ def override_urls(self):
                 name="api_get_anchor"),
         ]
 
-    def get_anchor(self, request, **kwargs):
+    def get_anchor(self, request, **__):
         self.method_check(request, allowed=['get'])
         self.is_authenticated(request)
         self.throttle_check(request)
@@ -229,6 +238,8 @@ def get_anchor(self, request, **kwargs):
 
 class UserResource(ModelResource):
 
+    """Read-only API resource for User model."""
+
     class Meta(object):
         allowed_methods = ['get']
         queryset = User.objects.all()

readthedocs/api/client.py

@@ -1,6 +1,7 @@
+"""Slumber API client"""
 import logging
 
-from slumber import API, serialize
+from slumber import API
 from requests import Session
 from django.conf import settings
 
@@ -21,7 +22,7 @@ def setup_api():
         'session': session,
     }
     if USER and PASS:
-        log.debug("Using slumber with user %s, pointed at %s" % (USER, API_HOST))
+        log.debug("Using slumber with user %s, pointed at %s", USER, API_HOST)
         session.auth = (USER, PASS)
     else:
         log.warning("SLUMBER_USERNAME/PASSWORD settings are not set")

readthedocs/api/utils.py

@@ -1,3 +1,4 @@
+"""Utility classes for api module"""
 import logging
 
 from django.core.paginator import Paginator, InvalidPage
@@ -40,7 +41,7 @@ class Meta:
             search_highlight = True
     """
 
-    def get_search(self, request, **kwargs):
+    def get_search(self, request):
         self.method_check(request, allowed=['get'])
         self.is_authenticated(request)
         self.throttle_check(request)
@@ -72,12 +73,14 @@ def _url_template(self, query, selected_facets):
 
     def _search(self, request, model, facets=None, page_size=20,
                 highlight=True):
+        # pylint: disable=too-many-locals
         """
-        `facets`
+        Return a paginated list of objects for a request.
 
+        `model`
+            Limit the search to a particular model
+        `facets`
             A list of facets to include with the results
-        `models`
-            Limit the search to one or more models
         """
         form = FacetedSearchForm(request.GET, facets=facets or [],
                                  models=(model,), load_all=True)
@@ -145,6 +148,9 @@ def error_response(self, errors, request):
 
 
 class PostAuthentication(BasicAuthentication):
+
+    """Require HTTP Basic authentication for any method other than GET."""
+
     def is_authenticated(self, request, **kwargs):
         val = super(PostAuthentication, self).is_authenticated(request,
                                                                **kwargs)
@@ -154,7 +160,7 @@ def is_authenticated(self, request, **kwargs):
 
 
 class EnhancedModelResource(ModelResource):
-    def obj_get_list(self, request=None, *args, **kwargs):
+    def obj_get_list(self, request=None, *_, **kwargs):
         """
         A ORM-specific implementation of ``obj_get_list``.
 

readthedocs/bookmarks/models.py

@@ -1,3 +1,5 @@
+"""Models for the bookmarks app."""
+
 from django.db import models
 from django.contrib.auth.models import User
 from django.utils.translation import ugettext_lazy as _, ugettext
@@ -7,6 +9,9 @@
 
 
 class Bookmark(models.Model):
+
+    """A user's bookmark of a ``Project``, ``Version``, and page."""
+
     user = models.ForeignKey(User, verbose_name=_('User'),
                              related_name='bookmarks')
     project = models.ForeignKey(Project, verbose_name=_('Project'),

readthedocs/bookmarks/urls.py

@@ -1,3 +1,5 @@
+"""URL config for the bookmarks app."""
+
 from django.conf.urls import url
 from readthedocs.bookmarks.views import BookmarkListView
 from readthedocs.bookmarks.views import BookmarkAddView, BookmarkRemoveView

readthedocs/bookmarks/views.py

@@ -1,3 +1,5 @@
+"""Views for the bookmarks app."""
+
 from django.contrib.auth.decorators import login_required
 from django.http import HttpResponse, HttpResponseRedirect
 from django.http import HttpResponseBadRequest

readthedocs/builds/constants.py

@@ -1,3 +1,5 @@
+"""Constants for the builds app."""
+
 from django.utils.translation import ugettext_lazy as _
 
 BUILD_STATE_TRIGGERED = 'triggered'

readthedocs/builds/filters.py

@@ -1,3 +1,5 @@
+"""FilterSets for the builds app."""
+
 from django.utils.translation import ugettext_lazy as _
 
 import django_filters

readthedocs/builds/forms.py

@@ -1,3 +1,5 @@
+"""Django forms for the builds app."""
+
 from django import forms
 
 from readthedocs.builds.models import VersionAlias, Version

readthedocs/builds/models.py

@@ -1,3 +1,5 @@
+"""Models for the builds app."""
+
 import logging
 import re
 import os.path
@@ -32,6 +34,9 @@
 
 
 class Version(models.Model):
+
+    """Version of a ``Project``."""
+
     project = models.ForeignKey(Project, verbose_name=_('Project'),
                                 related_name='versions')
     type = models.CharField(
@@ -154,7 +159,7 @@ def save(self, *args, **kwargs):
 
     def delete(self, *args, **kwargs):
         from readthedocs.projects import tasks
-        log.info('Removing files for version %s' % self.slug)
+        log.info('Removing files for version %s', self.slug)
         tasks.clear_artifacts.delay(version_pk=self.pk)
         broadcast(type='app', task=tasks.symlink_project, args=[self.project.pk])
         super(Version, self).delete(*args, **kwargs)
@@ -220,6 +225,18 @@ def clean_build_path(self):
             log.error('Build path cleanup failed', exc_info=True)
 
     def get_github_url(self, docroot, filename, source_suffix='.rst', action='view'):
+        """
+        Return a GitHub URL for a given filename.
+
+        `docroot`
+            Location of documentation in repository
+        `filename`
+            Name of file
+        `source_suffix`
+            File suffix of documentation format
+        `action`
+            `view` (default) or `edit`
+        """
         repo_url = self.project.repo
         if 'github' not in repo_url:
             return ''
@@ -283,6 +300,9 @@ def get_bitbucket_url(self, docroot, filename, source_suffix='.rst'):
 
 
 class VersionAlias(models.Model):
+
+    """Alias for a ``Version``."""
+
     project = models.ForeignKey(Project, verbose_name=_('Project'),
                                 related_name='aliases')
     from_slug = models.CharField(_('From slug'), max_length=255, default='')
@@ -299,6 +319,9 @@ def __unicode__(self):
 
 
 class Build(models.Model):
+
+    """Build data."""
+
     project = models.ForeignKey(Project, verbose_name=_('Project'),
                                 related_name='builds')
     version = models.ForeignKey(Version, verbose_name=_('Version'), null=True,
@@ -373,6 +396,9 @@ def failed(self):
 
 
 class BuildCommandResult(BuildCommandResultMixin, models.Model):
+
+    """Build command for a ``Build``."""
+
     build = models.ForeignKey(Build, verbose_name=_('Build'),
                               related_name='commands')
 

readthedocs/builds/urls.py

@@ -1,8 +1,8 @@
+"""URL configuration for builds app."""
+
 from django.conf.urls import url
 
-from .views import (
-    BuildList, BuildDetail, builds_redirect_detail, builds_redirect_list,
-)
+from .views import builds_redirect_detail, builds_redirect_list
 
 
 urlpatterns = [

readthedocs/builds/utils.py

@@ -1,3 +1,5 @@
+"""Utilities for the builds app."""
+
 import re
 
 

readthedocs/builds/version_slug.py

@@ -54,6 +54,7 @@ def __init__(self, *args, **kwargs):
         super(VersionSlugField, self).__init__(*args, **kwargs)
 
     def get_queryset(self, model_cls, slug_field):
+        # pylint: disable=protected-access
         for field, model in model_cls._meta.get_fields_with_model():
             if model and field == slug_field:
                 return model._default_manager.all()
@@ -103,11 +104,14 @@ def uniquifying_suffix(self, iteration):
         return '_{suffix}'.format(suffix=suffix)
 
     def create_slug(self, model_instance):
+        """Generate a unique slug for a model instance."""
+        # pylint: disable=protected-access
+
         # get fields to populate from and slug field to set
         slug_field = model_instance._meta.get_field(self.attname)
 
         slug = self.slugify(getattr(model_instance, self._populate_from))
-        next = 0
+        count = 0
 
         # strip slug depending on max_length attribute of the slug field
         # and clean-up
@@ -134,13 +138,13 @@ def create_slug(self, model_instance):
         # depending on the given slug, clean-up
         while not slug or queryset.filter(**kwargs):
             slug = original_slug
-            end = self.uniquifying_suffix(next)
+            end = self.uniquifying_suffix(count)
             end_len = len(end)
             if slug_len and len(slug) + end_len > slug_len:
                 slug = slug[:slug_len - end_len]
             slug = slug + end
             kwargs[self.attname] = slug
-            next += 1
+            count += 1
 
         assert self.test_pattern.match(slug), (
             'Invalid generated slug: {slug}'.format(slug=slug))

readthedocs/builds/views.py

@@ -1,3 +1,5 @@
+"""Views for builds app."""
+
 import logging
 
 from django.shortcuts import get_object_or_404
@@ -35,14 +37,14 @@ class BuildList(BuildBase, ListView):
     def get_context_data(self, **kwargs):
         context = super(BuildList, self).get_context_data(**kwargs)
 
-        filter = BuildFilter(self.request.GET, queryset=self.get_queryset())
+        filterset = BuildFilter(self.request.GET, queryset=self.get_queryset())
         active_builds = self.get_queryset().exclude(state="finished").values('id')
 
         context['project'] = self.project
-        context['filter'] = filter
+        context['filter'] = filterset
         context['active_builds'] = active_builds
         context['versions'] = Version.objects.public(user=self.request.user, project=self.project)
-        context['build_qs'] = filter.qs
+        context['build_qs'] = filterset.qs
 
         try:
             redis = Redis.from_url(settings.BROKER_URL)
@@ -64,9 +66,9 @@ def get_context_data(self, **kwargs):
 
 # Old build view redirects
 
-def builds_redirect_list(request, project_slug):
+def builds_redirect_list(request, project_slug):  # pylint: disable=unused-argument
     return HttpResponsePermanentRedirect(reverse('builds_project_list', args=[project_slug]))
 
 
-def builds_redirect_detail(request, project_slug, pk):
+def builds_redirect_detail(request, project_slug, pk):  # pylint: disable=unused-argument
     return HttpResponsePermanentRedirect(reverse('builds_detail', args=[project_slug, pk]))