Assorted docstring/PEP 257 fixes

deploy/flask-redirects.py

@@ -1,6 +1,4 @@
-"""
-A flask app for redirecting documentation from the root / URL.
-"""
+"""A Flask app for redirecting documentation from the root / URL."""
 
 import json
 

readthedocs/bookmarks/admin.py

@@ -1,5 +1,4 @@
-"""Django admin interface for `~bookmarks.models.Bookmark`.
-"""
+"""Django admin interface for `~bookmarks.models.Bookmark`."""
 
 from django.contrib import admin
 from readthedocs.bookmarks.models import Bookmark

readthedocs/bookmarks/views.py

@@ -141,6 +141,7 @@ def post(self, request, *args, **kwargs):
 class BookmarkRemoveView(View):
     """
     Deletes a user's bookmark in response to a POST request.
+
     Renders a delete? confirmation page in response to a GET request.
     """
 

readthedocs/oauth/services/base.py

@@ -103,7 +103,6 @@ def token_updater(self, token):
                 u'expires_at': 1449218652.558185
             }
         """
-
         def _updater(data):
             token.token = data['access_token']
             token.expires_at = datetime.fromtimestamp(data['expires_at'])

readthedocs/privacy/backend.py

@@ -15,9 +15,7 @@
 
 class ProjectManager(models.Manager):
 
-    """
-    Projects take into account their own privacy_level setting.
-    """
+    """Projects take into account their own privacy_level setting."""
 
     use_for_related_fields = True
 
@@ -30,9 +28,7 @@ def _add_user_repos(self, queryset, user):
         return queryset.distinct()
 
     def for_user_and_viewer(self, user, viewer):
-        """
-        Show projects that a user owns, that another user can see.
-        """
+        """Show projects that a user owns, that another user can see."""
         queryset = self.filter(privacy_level=constants.PUBLIC)
         queryset = self._add_user_repos(queryset, viewer)
         queryset = queryset.filter(users__in=[user])
@@ -120,9 +116,7 @@ def create_latest(self, **kwargs):
 
 class VersionQuerySetBase(models.QuerySet):
 
-    """
-    Versions take into account their own privacy_level setting.
-    """
+    """Versions take into account their own privacy_level setting."""
 
     use_for_related_fields = True
 
@@ -183,7 +177,8 @@ class VersionQuerySet(SettingsOverrideObject):
 class BuildManager(models.Manager):
 
     """
-    Build objects take into account the privacy of the Version they relate to.
+    Build objects that take into account the privacy of the Version
+    that they relate to.
     """
 
     use_for_related_fields = True
@@ -216,6 +211,7 @@ class RelatedProjectManager(models.Manager):
 
     This shouldn't be used as a subclass.
     """
+
     use_for_related_fields = True
     project_field = 'project'
 
@@ -278,7 +274,7 @@ class ChildRelatedProjectManager(RelatedProjectManager):
 
 class RelatedBuildManager(models.Manager):
 
-    '''For models with association to a project through :py:class:`Build`'''
+    """For models with association to a project through :py:class:`Build`"""
 
     use_for_related_fields = True
 

readthedocs/redirects/models.py

@@ -80,10 +80,11 @@ def __unicode__(self):
 
     def get_full_path(self, filename, language=None, version_slug=None):
         """
-        Return a full path for a given filename. This will include version and
-        language information. No protocol/domain is returned.
-        """
+        Return a full path for a given filename.
 
+        This will include version and language information. No protocol/domain
+        is returned.
+        """
         # Handle explicit http redirects
         if re.match('^https?://', filename):
             return filename

readthedocs/rtd_tests/base.py

@@ -31,7 +31,9 @@ def tearDown(self):
 @patch('readthedocs.projects.views.private.trigger_build', lambda x, basic: None)
 @patch('readthedocs.projects.views.private.trigger_build', lambda x, basic: None)
 class MockBuildTestCase(TestCase):
-    '''Mock build triggers for test cases'''
+
+    """Mock build triggers for test cases"""
+
     pass
 
 

readthedocs/rtd_tests/mocks/environment.py

@@ -4,7 +4,8 @@
 
 
 class EnvironmentMockGroup(object):
-    '''Mock out necessary environment pieces'''
+
+    """Mock out necessary environment pieces"""
 
     def __init__(self):
         self.patches = {
@@ -43,7 +44,7 @@ def __init__(self):
         self.mocks = {}
 
     def start(self):
-        '''Create a patch object for class patches'''
+        """Create a patch object for class patches"""
         for patch in self.patches:
             self.mocks[patch] = self.patches[patch].start()
         self.mocks['process'].communicate.return_value = ('', '')
@@ -61,7 +62,7 @@ def stop(self):
                 pass
 
     def configure_mock(self, mock, kwargs):
-        '''Configure object mocks'''
+        """Configure object mocks"""
         self.mocks[mock].configure_mock(**kwargs)
 
     def __getattr__(self, name):

readthedocs/rtd_tests/mocks/paths.py

@@ -5,14 +5,15 @@
 
 def fake_paths(check):
     """
+    Usage:
+
     >>> with fake_paths(lambda path: True if path.endswith('.pdf') else None):
     ...     assert os.path.exists('my.pdf')
     ...     assert os.path.exists('Nopdf.txt')
 
     The first assertion will be ok, the second assertion is not faked as the
     ``check`` returned ``None`` for this path.
     """
-
     original_exists = os.path.exists
 
     def patched_exists(path):
@@ -26,6 +27,8 @@ def patched_exists(path):
 
 def fake_paths_lookup(path_dict):
     """
+    Usage:
+
     >>> paths = {'my.txt': True, 'no.txt': False}
     >>> with fake_paths_lookup(paths):
     ...     assert os.path.exists('my.txt') == True
@@ -37,7 +40,9 @@ def check(path):
 
 
 def fake_paths_by_regex(pattern, exists=True):
-    """
+    r"""
+    Usage:
+
     >>> with fake_paths_by_regex('\.pdf$'):
     ...     assert os.path.exists('my.pdf') == True
     >>> with fake_paths_by_regex('\.pdf$', exists=False):

readthedocs/search/views.py

@@ -16,7 +16,6 @@
 
 def elastic_search(request):
     """Use Elasticsearch for global search"""
-
     query = request.GET.get('q')
     type = request.GET.get('type', 'project')
     # File Facets

readthedocs/vcs_support/utils.py

@@ -61,6 +61,8 @@ def __exit__(self, exc, value, tb):
 class NonBlockingLock(object):
 
     """
+    Acquire a lock in a non-blocking manner.
+
     Instead of waiting for a lock, depending on the lock file age, either
     acquire it immediately or throw LockTimeout