Linting fixes for rtd_test module. (readthedocs#2889)

Author: cmc333333

prospector-more.yml

@@ -13,7 +13,6 @@ ignore-paths:
   - projects/
   - redirects/
   - restapi/
-  - rtd_tests/
   - search/
 
 pylint:

readthedocs/rtd_tests/base.py

@@ -1,3 +1,4 @@
+"""Base classes and mixins for unit tests."""
 import os
 import shutil
 import logging
@@ -18,7 +19,7 @@ def setUp(self):
         self.original_DOCROOT = settings.DOCROOT
         self.cwd = os.path.dirname(__file__)
         self.build_dir = os.path.join(self.cwd, 'builds')
-        log.info("build dir: %s" % self.build_dir)
+        log.info("build dir: %s", self.build_dir)
         if not os.path.exists(self.build_dir):
             os.makedirs(self.build_dir)
         settings.DOCROOT = self.build_dir

readthedocs/rtd_tests/mocks/environment.py

@@ -1,7 +1,6 @@
+# pylint: disable=missing-docstring
 import mock
 
-from readthedocs.doc_builder.environments import BuildEnvironment
-
 
 class EnvironmentMockGroup(object):
 

readthedocs/rtd_tests/mocks/mock_api.py

@@ -1,3 +1,4 @@
+"""Mock versions of many API-related classes."""
 from contextlib import contextmanager
 import json
 import mock
@@ -14,6 +15,7 @@ def put(self, x=None):
 
 
 def mock_version(repo):
+    """Construct and return a class implementing the Version interface."""
     class MockVersion(object):
         def __init__(self, x=None):
             pass
@@ -22,6 +24,7 @@ def put(self, x=None):
             return x
 
         def get(self, **kwargs):
+            """Returns mock data to emulate real Version objects."""
             # SCIENTIST DOG
             version = json.loads("""
                 {
@@ -76,13 +79,13 @@ class MockApi(object):
     def __init__(self, repo):
         self.version = mock_version(repo)
 
-    def project(self, x):
+    def project(self, _):
         return ProjectData()
 
-    def build(self, x):
+    def build(self, _):
         return mock.Mock(**{'get.return_value': {'id': 123, 'state': 'triggered'}})
 
-    def command(self, x):
+    def command(self, _):
         return mock.Mock(**{'get.return_value': {}})
 
 

readthedocs/rtd_tests/mocks/paths.py

@@ -1,3 +1,4 @@
+"""Context managers to patch os.path.exists calls."""
 import os
 import re
 import mock

readthedocs/rtd_tests/utils.py

@@ -1,3 +1,4 @@
+"""Utility functions for use in tests."""
 import logging
 from os import chdir, environ, getcwd
 from os.path import abspath, join as pjoin