Fix lint issues for privacy app

prospector-more.yml

@@ -10,7 +10,6 @@ ignore-paths:
   - donate/
   - notifications/
   - payments/
-  - privacy/
   - profiles/
   - projects/
   - redirects/

readthedocs/privacy/backend.py

@@ -1,3 +1,4 @@
+"""Django Managers and Querysets to apply project privacy restrictions."""
 from django.db import models
 
 from guardian.shortcuts import get_objects_for_user
@@ -85,7 +86,7 @@ def from_queryset(cls, queryset_class, class_name=None):
         # no direct members.
         queryset_class = get_override_class(
             VersionQuerySet,
-            VersionQuerySet._default_class
+            VersionQuerySet._default_class  # pylint: disable=protected-access
         )
         return super(VersionManager, cls).from_queryset(queryset_class, class_name)
 

readthedocs/privacy/backends/syncers.py

@@ -1,3 +1,9 @@
+"""Classes allowing copying files around.
+
+"Syncers" copy files from the local machine, while "Pullers" copy files to
+the local machine.
+
+"""
 import getpass
 import logging
 import os
@@ -8,12 +14,17 @@
 log = logging.getLogger(__name__)
 
 
+# The file builting was removed in Python 3, so we should not use it
+# Setting to None here to silence pylint for this builtin only
+file = None  # pylint: disable=redefined-builtin
+
+
 class LocalSyncer(object):
 
     @classmethod
-    def copy(cls, path, target, file=False, **kwargs):
+    def copy(cls, path, target, file=False, **__):
         """A copy command that works with files or directories."""
-        log.info("Local Copy %s to %s" % (path, target))
+        log.info("Local Copy %s to %s", path, target)
         if file:
             if path == target:
                 # Don't copy the same file over itself
@@ -30,7 +41,7 @@ def copy(cls, path, target, file=False, **kwargs):
 class RemoteSyncer(object):
 
     @classmethod
-    def copy(cls, path, target, file=False, **kwargs):
+    def copy(cls, path, target, file=False, **__):
         """
         A better copy command that works with files or directories.
 
@@ -39,7 +50,7 @@ def copy(cls, path, target, file=False, **kwargs):
         sync_user = getattr(settings, 'SYNC_USER', getpass.getuser())
         app_servers = getattr(settings, 'MULTIPLE_APP_SERVERS', [])
         if app_servers:
-            log.info("Remote Copy %s to %s" % (path, target))
+            log.info("Remote Copy %s to %s on %s", path, target, app_servers)
             for server in app_servers:
                 mkdir_cmd = ("ssh %s@%s mkdir -p %s" % (sync_user, server, target))
                 ret = os.system(mkdir_cmd)
@@ -68,7 +79,7 @@ def copy(cls, path, target, file=False, **kwargs):
 class DoubleRemotePuller(object):
 
     @classmethod
-    def copy(cls, path, target, host, file=False, **kwargs):
+    def copy(cls, path, target, host, file=False, **__):
         """
         A better copy command that works from the webs.
 
@@ -78,7 +89,7 @@ def copy(cls, path, target, host, file=False, **kwargs):
         app_servers = getattr(settings, 'MULTIPLE_APP_SERVERS', [])
         if not file:
             path += "/"
-        log.info("Remote Copy %s to %s" % (path, target))
+        log.info("Remote Copy %s to %s", path, target)
         for server in app_servers:
             if not file:
                 mkdir_cmd = "ssh {user}@{server} mkdir -p {target}".format(
@@ -106,7 +117,7 @@ def copy(cls, path, target, host, file=False, **kwargs):
 class RemotePuller(object):
 
     @classmethod
-    def copy(cls, path, target, host, file=False, **kwargs):
+    def copy(cls, path, target, host, file=False, **__):
         """
         A better copy command that works from the webs.
 
@@ -115,7 +126,7 @@ def copy(cls, path, target, host, file=False, **kwargs):
         sync_user = getattr(settings, 'SYNC_USER', getpass.getuser())
         if not file:
             path += "/"
-        log.info("Local Copy %s to %s" % (path, target))
+        log.info("Local Copy %s to %s", path, target)
         os.makedirs(target)
         # Add a slash when copying directories
         sync_cmd = "rsync -e 'ssh -T' -av --delete {user}@{host}:{path} {target}".format(

readthedocs/privacy/loader.py

@@ -1,3 +1,10 @@
+"""A namespace of privacy classes configured by settings.
+
+Importing classes from this module allows the classes used to be overridden
+using Django settings.
+
+"""
+
 from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.privacy import backend
 

readthedocs/privacy/templatetags/privacy_tags.py

@@ -1,3 +1,5 @@
+"""Template tags to query projects by privacy."""
+
 from django import template
 
 from ..loader import AdminPermission