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

Author: fmoor

docs/ethical-advertising.rst

@@ -9,8 +9,8 @@ However,
 instead of using Google,
 we are building the advertising model that we want to exist.
 We only work with companies we like and respect,
-and offer products that are relevent to developers
-We hope that you'll discover new products and services that are relvent,
+and offer products that are relevant to developers.
+We hope that you'll discover new products and services that are relevant,
 and also new companies that care about supporting the open source community.
 
 **We're building an advertising model that respects users while providing value to advertisers.**

prospector-more.yml

@@ -6,8 +6,6 @@ ignore-paths:
   - core/
   - doc_builder/
   - donate/
-  - projects/
-  - redirects/
   - restapi/
   - search/
 

readthedocs/projects/forms.py

@@ -515,6 +515,9 @@ def save(self, **_):
 
 
 class DomainForm(forms.ModelForm):
+
+    """Form to configure a custom domain name for a project."""
+
     project = forms.CharField(widget=forms.HiddenInput(), required=False)
 
     class Meta:

readthedocs/projects/models.py

@@ -7,7 +7,6 @@
 
 from django.conf import settings
 from django.contrib.auth.models import User
-from django.core.exceptions import MultipleObjectsReturned
 from django.core.urlresolvers import reverse, NoReverseMatch
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
@@ -877,6 +876,9 @@ def __unicode__(self):
 
 
 class Domain(models.Model):
+
+    """A custom domain name for a project."""
+
     project = models.ForeignKey(Project, related_name='domains')
     domain = models.CharField(_('Domain'), unique=True, max_length=255,
                               validators=[validate_domain_name])

readthedocs/projects/tasks.py

@@ -107,8 +107,8 @@ def _log(self, msg):
                          version=self.version.slug,
                          msg=msg))
 
-    def run(self, pk, version_pk=None, build_pk=None, record=True, docker=False,
-            search=True, force=False, localmedia=True, **kwargs):
+    def run(self, pk, version_pk=None, build_pk=None, record=True,
+            docker=False, search=True, force=False, localmedia=True, **__):
 
         self.project = self.get_project(pk)
         self.version = self.get_version(self.project, version_pk)
@@ -118,9 +118,22 @@ def run(self, pk, version_pk=None, build_pk=None, record=True, docker=False,
         self.build_force = force
         self.config = None
 
-        env_cls = LocalEnvironment
-        self.setup_env = env_cls(project=self.project, version=self.version,
-                                 build=self.build, record=record)
+        setup_successful = self.run_setup(record=record)
+        if setup_successful:
+            self.run_build(record=record, docker=docker)
+
+    def run_setup(self, record=True):
+        """Run setup in the local environment.
+
+        Return True if successful.
+
+        """
+        self.setup_env = LocalEnvironment(
+            project=self.project,
+            version=self.version,
+            build=self.build,
+            record=record
+        )
 
         # Environment used for code checkout & initial configuration reading
         with self.setup_env:
@@ -145,16 +158,34 @@ def run(self, pk, version_pk=None, build_pk=None, record=True, docker=False,
 
         if self.setup_env.failure or self.config is None:
             self._log('Failing build because of setup failure: %s' % self.setup_env.failure)
-            self.send_notifications()
+
+            # Send notification to users only if the build didn't fail because of
+            # LockTimeout: this exception occurs when a build is triggered before the previous
+            # one has finished (e.g. two webhooks, one after the other)
+            if not isinstance(self.setup_env.failure, vcs_support_utils.LockTimeout):
+                self.send_notifications()
+
             self.setup_env.update_build(state=BUILD_STATE_FINISHED)
-            return None
+            return False
 
         if self.setup_env.successful and not self.project.has_valid_clone:
             self.set_valid_clone()
 
+        return True
+
+    def run_build(self, docker=False, record=True):
+        """Build the docs in an environment.
+
+        If `docker` is True, or Docker is enabled by the settings.DOCKER_ENABLE
+        setting, then build in a Docker environment. Otherwise build locally.
+
+        """
         env_vars = self.get_env_vars()
+
         if docker or settings.DOCKER_ENABLE:
             env_cls = DockerEnvironment
+        else:
+            env_cls = LocalEnvironment
         self.build_env = env_cls(project=self.project, version=self.version,
                                  build=self.build, record=record, environment=env_vars)
 
@@ -502,7 +533,7 @@ def update_imported_docs(version_pk):
         try:
             api_v2.project(project.pk).sync_versions.post(version_post_data)
         except HttpClientError as e:
-            log.error("Sync Versions Exception: %s" % e.content)
+            log.error("Sync Versions Exception: %s", e.content)
         except Exception as e:
             log.error("Unknown Sync Versions Exception", exc_info=True)
     return ret_dict
@@ -740,8 +771,8 @@ def _manage_imported_files(version, path, commit):
                                 ).exclude(commit=commit).delete()
     # Purge Cache
     changed_files = [resolve_path(
-        version.project, filename=file, version_slug=version.slug,
-    ) for file in changed_files]
+        version.project, filename=fname, version_slug=version.slug,
+    ) for fname in changed_files]
     cdn_ids = getattr(settings, 'CDN_IDS', None)
     if cdn_ids:
         if version.project.slug in cdn_ids:

readthedocs/projects/views/base.py

@@ -1,3 +1,4 @@
+"""Mix-in classes for project views."""
 import logging
 from datetime import datetime, timedelta
 

readthedocs/projects/views/private.py

@@ -5,7 +5,6 @@
 from django.contrib.auth.decorators import login_required
 from django.contrib.auth.models import User
 from django.contrib import messages
-from django.contrib.contenttypes.models import ContentType
 from django.core.urlresolvers import reverse
 from django.http import (HttpResponseRedirect, HttpResponseNotAllowed,
                          Http404, HttpResponseBadRequest)
@@ -172,7 +171,7 @@ def project_version_detail(request, project_slug, version_slug):
         version = form.save()
         if form.has_changed():
             if 'active' in form.changed_data and version.active is False:
-                log.info('Removing files for version %s' % version.slug)
+                log.info('Removing files for version %s', version.slug)
                 broadcast(type='app', task=tasks.clear_artifacts, args=[version.pk])
                 version.built = False
                 version.save()

readthedocs/projects/views/public.py

@@ -17,7 +17,6 @@
 from django.template import RequestContext
 from django.views.decorators.cache import cache_control
 from django.views.generic import ListView, DetailView
-from django.views.decorators.cache import cache_page
 
 from taggit.models import Tag
 import requests

readthedocs/redirects/admin.py

@@ -1,3 +1,5 @@
+"""Django admin configuration for the redirects app."""
+
 from __future__ import absolute_import
 
 from django.contrib import admin

readthedocs/redirects/managers.py

@@ -1,3 +1,5 @@
+"""Manager and queryset for the redirects app."""
+
 from django.db.models import Manager
 from django.db.models.query import QuerySet
 

readthedocs/redirects/models.py

@@ -1,3 +1,5 @@
+"""Django models for the redirects app."""
+
 from django.db import models
 from django.utils.translation import ugettext
 from django.utils.translation import ugettext_lazy as _
@@ -41,6 +43,9 @@
 
 
 class Redirect(models.Model):
+
+    """A HTTP redirect associated with a Project."""
+
     project = models.ForeignKey(Project, verbose_name=_('Project'),
                                 related_name='redirects')
 
@@ -101,7 +106,7 @@ def get_redirect_path(self, path, language=None, version_slug=None):
 
     def redirect_prefix(self, path, language=None, version_slug=None):
         if path.startswith(self.from_url):
-            log.debug('Redirecting %s' % self)
+            log.debug('Redirecting %s', self)
             cut_path = re.sub('^%s' % self.from_url, '', path)
             to = self.get_full_path(
                 filename=cut_path,
@@ -111,16 +116,16 @@ def redirect_prefix(self, path, language=None, version_slug=None):
 
     def redirect_page(self, path, language=None, version_slug=None):
         if path == self.from_url:
-            log.debug('Redirecting %s' % self)
+            log.debug('Redirecting %s', self)
             to = self.get_full_path(
                 filename=self.to_url.lstrip('/'),
                 language=language,
                 version_slug=version_slug)
             return to
 
-    def redirect_exact(self, path, language=None, version_slug=None):
+    def redirect_exact(self, path, **__):
         if path == self.from_url:
-            log.debug('Redirecting %s' % self)
+            log.debug('Redirecting %s', self)
             return self.to_url
         # Handle full sub-level redirects
         if '$rest' in self.from_url:
@@ -132,7 +137,7 @@ def redirect_exact(self, path, language=None, version_slug=None):
     def redirect_sphinx_html(self, path, language=None, version_slug=None):
         for ending in ['/', '/index.html']:
             if path.endswith(ending):
-                log.debug('Redirecting %s' % self)
+                log.debug('Redirecting %s', self)
                 path = path[1:]  # Strip leading slash.
                 to = re.sub(ending + '$', '.html', path)
                 return self.get_full_path(
@@ -142,7 +147,7 @@ def redirect_sphinx_html(self, path, language=None, version_slug=None):
 
     def redirect_sphinx_htmldir(self, path, language=None, version_slug=None):
         if path.endswith('.html'):
-            log.debug('Redirecting %s' % self)
+            log.debug('Redirecting %s', self)
             path = path[1:]  # Strip leading slash.
             to = re.sub('.html$', '/', path)
             return self.get_full_path(

readthedocs/redirects/utils.py

@@ -1,3 +1,12 @@
+"""Redirection view support.
+
+This module allows for parsing a URL path, looking up redirects associated
+with it in the database, and generating a redirect response.
+
+These are not used directly as views; they are instead included into 404
+handlers, so that redirects only take effect if no other view matches.
+
+"""
 from django.http import HttpResponseRedirect
 import logging
 import re
@@ -10,6 +19,16 @@
 
 
 def project_and_path_from_request(request, path):
+    """Parse the project from a request path.
+
+    Return a tuple (project, path) where `project` is a projects.Project if
+    a matching project exists, and `path` is the unmatched remainder of the
+    path.
+
+    If the path does not match, or no matching project is found, then `project`
+    will be ``None``.
+
+    """
     if hasattr(request, 'slug'):
         project_slug = request.slug
     elif path.startswith('/docs/'):