Resolve linting issues in the vcs_support app. (readthedocs#2868)

Author: cmc333333

prospector-more.yml

@@ -23,7 +23,6 @@ ignore-paths:
   - rtd_tests/
   - search/
   - settings/
-  - vcs_support/
 
 pylint:
   options:

readthedocs/vcs_support/backends/__init__.py

@@ -1,3 +1,4 @@
+"""Listing of all the VCS backends."""
 from . import bzr, hg, git, svn
 
 backend_cls = {

readthedocs/vcs_support/backends/bzr.py

@@ -1,3 +1,4 @@
+"""Bazaar-related utilities."""
 import csv
 import re
 import sys
@@ -12,6 +13,9 @@
 
 
 class Backend(BaseVCS):
+
+    """Bazaar VCS backend."""
+
     supports_tags = True
     fallback_branch = ''
 
@@ -83,7 +87,7 @@ def parse_tags(self, data):
 
     @property
     def commit(self):
-        retcode, stdout = self.run('bzr', 'revno')[:2]
+        _, stdout = self.run('bzr', 'revno')[:2]
         return stdout.strip()
 
     def checkout(self, identifier=None):

readthedocs/vcs_support/backends/git.py

@@ -1,3 +1,4 @@
+"""Git-related utilities."""
 import re
 import logging
 import csv
@@ -17,6 +18,9 @@
 
 
 class Backend(BaseVCS):
+
+    """Git VCS backend."""
+
     supports_tags = True
     supports_branches = True
     fallback_branch = 'master'  # default branch
@@ -48,11 +52,11 @@ def update(self):
         self.checkout()
 
     def repo_exists(self):
-        code, out, err = self.run('git', 'status')
+        code, _, _ = self.run('git', 'status')
         return code == 0
 
     def fetch(self):
-        code, out, err = self.run('git', 'fetch', '--tags', '--prune')
+        code, _, err = self.run('git', 'fetch', '--tags', '--prune')
         if code != 0:
             raise ProjectImportError(
                 "Failed to get code from '%s' (git fetch): %s\n\nStderr:\n\n%s\n\n" % (
@@ -67,13 +71,13 @@ def checkout_revision(self, revision=None):
         code, out, err = self.run('git', 'checkout',
                                   '--force', '--quiet', revision)
         if code != 0:
-            log.warning("Failed to checkout revision '%s': %s" % (
-                revision, code))
+            log.warning("Failed to checkout revision '%s': %s",
+                        revision, code)
         return [code, out, err]
 
     def clone(self):
-        code, out, err = self.run('git', 'clone', '--recursive', '--quiet',
-                                  self.repo_url, '.')
+        code, _, err = self.run('git', 'clone', '--recursive', '--quiet',
+                                self.repo_url, '.')
         if code != 0:
             raise ProjectImportError(
                 (
@@ -88,7 +92,7 @@ def clone(self):
 
     @property
     def tags(self):
-        retcode, stdout, err = self.run('git', 'show-ref', '--tags')
+        retcode, stdout, _ = self.run('git', 'show-ref', '--tags')
         # error (or no tags found)
         if retcode != 0:
             return []
@@ -123,7 +127,7 @@ def parse_tags(self, data):
     @property
     def branches(self):
         # Only show remote branches
-        retcode, stdout, err = self.run('git', 'branch', '-r')
+        retcode, stdout, _ = self.run('git', 'branch', '-r')
         # error (or no tags found)
         if retcode != 0:
             return []
@@ -163,7 +167,7 @@ def parse_branches(self, data):
 
     @property
     def commit(self):
-        retcode, stdout, err = self.run('git', 'rev-parse', 'HEAD')
+        _, stdout, _ = self.run('git', 'rev-parse', 'HEAD')
         return stdout.strip()
 
     def checkout(self, identifier=None):
@@ -210,7 +214,7 @@ def find_ref(self, ref):
         return ref
 
     def ref_exists(self, ref):
-        code, out, err = self.run('git', 'show-ref', ref)
+        code, _, _ = self.run('git', 'show-ref', ref)
         return code == 0
 
     @property

readthedocs/vcs_support/backends/hg.py

@@ -1,8 +1,12 @@
+"""Mercurial-related utilities."""
 from readthedocs.projects.exceptions import ProjectImportError
 from readthedocs.vcs_support.base import BaseVCS, VCSVersion
 
 
 class Backend(BaseVCS):
+
+    """Mercurial VCS backend."""
+
     supports_tags = True
     supports_branches = True
     fallback_branch = 'default'
@@ -85,13 +89,13 @@ def parse_tags(self, data):
             name, commit = row
             if name == 'tip':
                 continue
-            revision, commit_hash = commit.split(':')
+            _, commit_hash = commit.split(':')
             vcs_tags.append(VCSVersion(self, commit_hash, name))
         return vcs_tags
 
     @property
     def commit(self):
-        retcode, stdout = self.run('hg', 'id', '-i')[:2]
+        _, stdout = self.run('hg', 'id', '-i')[:2]
         return stdout.strip()
 
     def checkout(self, identifier=None):

readthedocs/vcs_support/backends/svn.py

@@ -1,3 +1,4 @@
+"""Subversion-related utilities."""
 import csv
 import sys
 
@@ -11,6 +12,9 @@
 
 
 class Backend(BaseVCS):
+
+    """Subversion VCS backend."""
+
     supports_tags = False
     fallback_branch = '/trunk/'
 
@@ -96,7 +100,7 @@ def parse_tags(self, data):
 
     @property
     def commit(self):
-        retcode, stdout = self.run('svnversion')[:2]
+        _, stdout = self.run('svnversion')[:2]
         return stdout.strip()
 
     def checkout(self, identifier=None):

readthedocs/vcs_support/base.py

@@ -1,3 +1,4 @@
+"""Base classes for VCS backends."""
 import logging
 import os
 import shutil
@@ -90,6 +91,8 @@ class BaseVCS(BaseCLI):
     # General methods
     # =========================================================================
 
+    # Defining a base API, so we'll have unused args
+    # pylint: disable=unused-argument
     def __init__(self, project, version, **kwargs):
         self.default_branch = project.default_branch
         self.name = project.name

readthedocs/vcs_support/utils.py

@@ -1,3 +1,4 @@
+"""Locking utilities."""
 import logging
 import os
 import time
@@ -32,29 +33,29 @@ def __enter__(self):
         while os.path.exists(self.fpath):
             lock_age = time.time() - os.stat(self.fpath)[stat.ST_MTIME]
             if lock_age > self.timeout:
-                log.info("Lock (%s): Force unlock, old lockfile" %
+                log.info("Lock (%s): Force unlock, old lockfile",
                          self.name)
                 os.remove(self.fpath)
                 break
-            log.info("Lock (%s): Locked, waiting.." % self.name)
+            log.info("Lock (%s): Locked, waiting..", self.name)
             time.sleep(self.polling_interval)
             timesince = time.time() - start
             if timesince > self.timeout:
-                log.info("Lock (%s): Force unlock, timeout reached" %
+                log.info("Lock (%s): Force unlock, timeout reached",
                          self.name)
                 os.remove(self.fpath)
                 break
-            log.info(("%s still locked after %.2f seconds; retry for %.2f"
-                      " seconds") % (self.name, timesince, self.timeout))
+            log.info("%s still locked after %.2f seconds; retry for %.2f"
+                     " seconds", self.name, timesince, self.timeout)
         open(self.fpath, 'w').close()
-        log.info("Lock (%s): Lock acquired" % self.name)
+        log.info("Lock (%s): Lock acquired", self.name)
 
     def __exit__(self, exc, value, tb):
         try:
-            log.info("Lock (%s): Releasing" % self.name)
+            log.info("Lock (%s): Releasing", self.name)
             os.remove(self.fpath)
-        except:
-            log.error("Lock (%s): Failed to release, ignoring..." % self.name,
+        except OSError:
+            log.error("Lock (%s): Failed to release, ignoring...", self.name,
                       exc_info=True)
 
 
@@ -82,20 +83,20 @@ def __enter__(self):
         if path_exists and self.max_lock_age is not None:
             lock_age = time.time() - os.stat(self.fpath)[stat.ST_MTIME]
             if lock_age > self.max_lock_age:
-                log.info("Lock (%s): Force unlock, old lockfile" %
+                log.info("Lock (%s): Force unlock, old lockfile",
                          self.name)
                 os.remove(self.fpath)
             else:
-                raise LockTimeout("Lock (%s): Lock still active" % self.name)
+                raise LockTimeout("Lock (%s): Lock still active", self.name)
         elif path_exists:
-            raise LockTimeout("Lock (%s): Lock still active" % self.name)
+            raise LockTimeout("Lock (%s): Lock still active", self.name)
         open(self.fpath, 'w').close()
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         try:
-            log.info("Lock (%s): Releasing" % self.name)
+            log.info("Lock (%s): Releasing", self.name)
             os.remove(self.fpath)
         except (IOError, OSError):
-            log.error("Lock (%s): Failed to release, ignoring..." % self.name,
+            log.error("Lock (%s): Failed to release, ignoring...", self.name,
                       exc_info=True)