Linting issues: arguments-differ, len-as-condition, redefined variables

Author: agjohnson

readthedocs/api/utils.py

@@ -160,7 +160,7 @@ def is_authenticated(self, request, **kwargs):
 
 
 class EnhancedModelResource(ModelResource):
-    def obj_get_list(self, request=None, *_, **kwargs):
+    def obj_get_list(self, request=None, *_, **kwargs):  # pylint: disable=arguments-differ
         """
         A ORM-specific implementation of ``obj_get_list``.
 

readthedocs/bookmarks/views.py

@@ -24,8 +24,8 @@
 class BookmarkExistsView(View):
 
     @method_decorator(csrf_exempt)
-    def dispatch(self, *args, **kwargs):
-        return super(BookmarkExistsView, self).dispatch(*args, **kwargs)
+    def dispatch(self, request, *args, **kwargs):
+        return super(BookmarkExistsView, self).dispatch(request, *args, **kwargs)
 
     def get(self, request):
         return HttpResponse(
@@ -80,8 +80,8 @@ class BookmarkListView(ListView):
     model = Bookmark
 
     @method_decorator(login_required)
-    def dispatch(self, *args, **kwargs):
-        return super(BookmarkListView, self).dispatch(*args, **kwargs)
+    def dispatch(self, request, *args, **kwargs):
+        return super(BookmarkListView, self).dispatch(request, *args, **kwargs)
 
     def get_queryset(self):
         return Bookmark.objects.filter(user=self.request.user)
@@ -93,8 +93,8 @@ class BookmarkAddView(View):
 
     @method_decorator(login_required)
     @method_decorator(csrf_exempt)
-    def dispatch(self, *args, **kwargs):
-        return super(BookmarkAddView, self).dispatch(*args, **kwargs)
+    def dispatch(self, request, *args, **kwargs):
+        return super(BookmarkAddView, self).dispatch(request, *args, **kwargs)
 
     def get(self, request):
         return HttpResponse(
@@ -156,8 +156,8 @@ class BookmarkRemoveView(View):
 
     @method_decorator(login_required)
     @method_decorator(csrf_exempt)
-    def dispatch(self, *args, **kwargs):
-        return super(BookmarkRemoveView, self).dispatch(*args, **kwargs)
+    def dispatch(self, request, *args, **kwargs):
+        return super(BookmarkRemoveView, self).dispatch(request, *args, **kwargs)
 
     def get(self, request, *args, **kwargs):
         return render_to_response(

readthedocs/builds/forms.py

@@ -31,8 +31,8 @@ class Meta:
         model = Version
         fields = ['active', 'privacy_level', 'tags']
 
-    def save(self, *args, **kwargs):
-        obj = super(VersionForm, self).save(*args, **kwargs)
+    def save(self, commit=True):
+        obj = super(VersionForm, self).save(commit=commit)
         if obj.active and not obj.built and not obj.uploaded:
             trigger_build(project=obj.project, version=obj)
         return obj

readthedocs/builds/models.py

@@ -144,7 +144,7 @@ def get_absolute_url(self):
         private = self.privacy_level == PRIVATE
         return self.project.get_docs_url(version_slug=self.slug, private=private)
 
-    def save(self, *args, **kwargs):
+    def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
         """Add permissions to the Version for all owners on save."""
         from readthedocs.projects import tasks
         obj = super(Version, self).save(*args, **kwargs)
@@ -157,7 +157,7 @@ def save(self, *args, **kwargs):
         broadcast(type='app', task=tasks.symlink_project, args=[self.project.pk])
         return obj
 
-    def delete(self, *args, **kwargs):
+    def delete(self, *args, **kwargs):  # pylint: disable=arguments-differ
         from readthedocs.projects import tasks
         log.info('Removing files for version %s', self.slug)
         tasks.clear_artifacts.delay(version_pk=self.pk)

readthedocs/comments/models.py

@@ -32,12 +32,12 @@ def from_hash(self, version_slug, page, node_hash, project_slug=None):
         if project_slug:
             snapshots = snapshots.filter(node__project__slug=project_slug)
 
-        if len(snapshots) == 0:
+        if not snapshots.exists():
             raise DocumentNode.DoesNotExist(
                 "No node exists on %s with a current hash of %s" % (
                     page, node_hash))
 
-        if len(snapshots) == 1:
+        if snapshots.count() == 1:
             # If we have found only one snapshot, we know we have the correct node.
             node = snapshots[0].node
         else:

readthedocs/comments/views.py

@@ -184,7 +184,7 @@ def get_queryset(self):
         return queryset
 
     @method_decorator(login_required)
-    def create(self, request):
+    def create(self, request, *args, **kwargs):
         project = Project.objects.get(slug=request.data['project'])
         comment = project.add_comment(version_slug=request.data['version'],
                                       page=request.data['document_page'],

readthedocs/core/forms.py

@@ -30,11 +30,11 @@ def __init__(self, *args, **kwargs):
         except AttributeError:
             pass
 
-    def save(self, *args, **kwargs):
+    def save(self, commit=True):
         first_name = self.cleaned_data.pop('first_name', None)
         last_name = self.cleaned_data.pop('last_name', None)
-        profile = super(UserProfileForm, self).save(*args, **kwargs)
-        if kwargs.get('commit', True):
+        profile = super(UserProfileForm, self).save(commit=commit)
+        if commit:
             user = profile.user
             user.first_name = first_name
             user.last_name = last_name

readthedocs/core/management/commands/import_github.py

@@ -11,7 +11,7 @@ class Command(BaseCommand):
     help = __doc__
 
     def handle(self, *args, **options):
-        if len(args):
+        if args:
             for slug in args:
                 for service in GitHubService.for_user(
                     User.objects.get(username=slug)

readthedocs/core/management/commands/pull.py

@@ -16,7 +16,7 @@ class Command(BaseCommand):
     help = __doc__
 
     def handle(self, *args, **options):
-        if len(args):
+        if args:
             for slug in args:
                 tasks.update_imported_docs(
                     utils.version_from_slug(slug, LATEST).pk

readthedocs/core/management/commands/update_repos.py

@@ -42,7 +42,7 @@ def handle(self, *args, **options):
         record = options['record']
         force = options['force']
         version = options['version']
-        if len(args):
+        if args:
             for slug in args:
                 if version and version != "all":
                     log.info("Updating version %s for %s", version, slug)

readthedocs/core/resolver.py

@@ -103,10 +103,7 @@ def resolve_path(self, project, filename='', version_slug=None,
             project_slug = project.slug
             subproject_slug = None
 
-        if project.single_version or single_version:
-            single_version = True
-        else:
-            single_version = False
+        single_version = bool(project.single_version or single_version)
 
         return self.base_resolve_path(
             project_slug=project_slug,

readthedocs/core/symlink.py

@@ -150,15 +150,15 @@ def symlink_cnames(self, domain=None):
             domains = [domain]
         else:
             domains = Domain.objects.filter(project=self.project)
-        for domain in domains:
-            self._log(u"Symlinking CNAME: {0} -> {1}".format(domain.domain, self.project.slug))
+        for dom in domains:
+            self._log(u"Symlinking CNAME: {0} -> {1}".format(dom.domain, self.project.slug))
 
             # CNAME to doc root
-            symlink = os.path.join(self.CNAME_ROOT, domain.domain)
+            symlink = os.path.join(self.CNAME_ROOT, dom.domain)
             run('ln -nsf {0} {1}'.format(self.project_root, symlink))
 
             # Project symlink
-            project_cname_symlink = os.path.join(self.PROJECT_CNAME_ROOT, domain.domain)
+            project_cname_symlink = os.path.join(self.PROJECT_CNAME_ROOT, dom.domain)
             run('ln -nsf %s %s' % (self.project.doc_path, project_cname_symlink))
 
     def remove_symlink_cname(self, domain):

readthedocs/doc_builder/backends/mkdocs.py

@@ -149,7 +149,7 @@ def generate_dynamic_include(self):
         tmpl = template_loader.get_template('doc_builder/include.js.tmpl')
         return tmpl.render(include_ctx)
 
-    def build(self, **__):
+    def build(self):
         checkout_path = self.project.checkout_path(self.version.slug)
         build_command = [
             'python',
@@ -180,7 +180,7 @@ class MkdocsJSON(BaseMkdocs):
     build_dir = '_build/json'
     use_theme = False
 
-    def build(self, **kwargs):
+    def build(self):
         user_config = yaml.safe_load(
             open(os.path.join(self.root_path, 'mkdocs.yml'), 'r')
         )
@@ -190,4 +190,4 @@ def build(self, **kwargs):
             user_config,
             open(os.path.join(self.root_path, 'mkdocs.yml'), 'w')
         )
-        super(MkdocsJSON, self).build(**kwargs)
+        super(MkdocsJSON, self).build()

readthedocs/doc_builder/backends/sphinx.py

@@ -137,7 +137,7 @@ def append_conf(self, **__):
             cwd=self.project.checkout_path(self.version.slug),
         )
 
-    def build(self, **__):
+    def build(self):
         self.clean()
         project = self.project
         build_command = [
@@ -275,7 +275,7 @@ class PdfBuilder(BaseSphinx):
     sphinx_build_dir = '_build/latex'
     pdf_file_name = None
 
-    def build(self, **__):
+    def build(self):
         self.clean()
         cwd = self.project.conf_dir(self.version.slug)
 

readthedocs/doc_builder/base.py

@@ -48,7 +48,7 @@ def force(self, **__):
         log.info("Forcing a build")
         self._force = True
 
-    def build(self, id=None, **__):  # pylint: disable=redefined-builtin
+    def build(self):
         """Do the actual building of the documentation."""
         raise NotImplementedError
 

readthedocs/doc_builder/environments.py

@@ -396,7 +396,7 @@ def update_build(self, state=None):
             if self.failure and isinstance(self.failure,
                                            BuildEnvironmentException):
                 self.build['exit_code'] = self.failure.status_code
-            elif len(self.commands) > 0:
+            elif self.commands:
                 self.build['exit_code'] = max([cmd.exit_code
                                                for cmd in self.commands])
 

readthedocs/integrations/models.py

@@ -199,7 +199,7 @@ def get(self, *args, **kwargs):
     def subclass(self, instance):
         return self._get_subclass_replacement(instance)
 
-    def create(self, **kwargs):  # pylint: disable=unused-argument
+    def create(self, **kwargs):
         """Override of create method to use subclass instance instead
 
         Instead of using the underlying Integration model to create this
@@ -295,7 +295,7 @@ class GenericAPIWebhook(Integration):
     class Meta:
         proxy = True
 
-    def save(self, **kwargs):
+    def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
         """Ensure model has token data before saving"""
         try:
             token = self.provider_data.get('token')
@@ -305,7 +305,7 @@ def save(self, **kwargs):
             if token is None:
                 token = default_token()
                 self.provider_data = {'token': token}
-        super(GenericAPIWebhook, self).save(**kwargs)
+        super(GenericAPIWebhook, self).save(*args, **kwargs)
 
     @property
     def token(self):

readthedocs/profiles/views.py

@@ -95,7 +95,7 @@ def create_profile(request, form_class, success_url=None,
         extra_context = {}
     context = RequestContext(request)
     for key, value in extra_context.items():
-        context[key] = callable(value) and value() or value
+        context[key] = (value() if callable(value) else value)
 
     return render_to_response(template_name,
                               {'form': form},
@@ -172,7 +172,7 @@ def edit_profile(request, form_class, success_url=None,
         extra_context = {}
     context = RequestContext(request)
     for key, value in extra_context.items():
-        context[key] = callable(value) and value() or value
+        context[key] = (value() if callable(value) else value)
 
     return render_to_response(template_name, {
         'form': form,
@@ -244,7 +244,7 @@ def profile_detail(request, username, public_profile_field=None,
         extra_context = {}
     context = RequestContext(request)
     for key, value in extra_context.items():
-        context[key] = callable(value) and value() or value
+        context[key] = (value() if callable(value) else value)
 
     return render_to_response(template_name,
                               {'profile': profile_obj},

readthedocs/projects/forms.py

@@ -504,7 +504,10 @@ def __init__(self, *args, **kwargs):
         self.project = kwargs.pop('project', None)
         super(RedirectForm, self).__init__(*args, **kwargs)
 
-    def save(self, **_):
+    def save(self, **_):  # pylint: disable=arguments-differ
+        # TODO this should respect the unused argument `commit`. It's not clear
+        # why this needs to be a call to `create`, instead of relying on the
+        # super `save()` call.
         redirect = Redirect.objects.create(
             project=self.project,
             redirect_type=self.cleaned_data['redirect_type'],

readthedocs/projects/models.py

@@ -61,7 +61,7 @@ class ProjectRelationship(models.Model):
     def __unicode__(self):
         return "%s -> %s" % (self.parent, self.child)
 
-    def save(self, *args, **kwargs):
+    def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
         if not self.alias:
             self.alias = self.child.slug
         super(ProjectRelationship, self).save(*args, **kwargs)
@@ -298,7 +298,7 @@ def sync_supported_versions(self):
                 verbose_name__in=supported).update(supported=False)
             self.versions.filter(verbose_name=LATEST_VERBOSE_NAME).update(supported=True)
 
-    def save(self, *args, **kwargs):
+    def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
         from readthedocs.projects import tasks
         first_save = self.pk is None
         if not self.slug:
@@ -612,8 +612,8 @@ def find(self, filename, version):
         """
         matches = []
         for root, __, filenames in os.walk(self.full_doc_path(version)):
-            for filename in fnmatch.filter(filenames, filename):
-                matches.append(os.path.join(root, filename))
+            for match in fnmatch.filter(filenames, filename):
+                matches.append(os.path.join(root, match))
         return matches
 
     def full_find(self, filename, version):
@@ -624,8 +624,8 @@ def full_find(self, filename, version):
         """
         matches = []
         for root, __, filenames in os.walk(self.checkout_path(version)):
-            for filename in fnmatch.filter(filenames, filename):
-                matches.append(os.path.join(root, filename))
+            for match in fnmatch.filter(filenames, filename):
+                matches.append(os.path.join(root, match))
         return matches
 
     def get_latest_build(self, finished=True):
@@ -907,7 +907,7 @@ class Meta:
     def __unicode__(self):
         return "{domain} pointed at {project}".format(domain=self.domain, project=self.project.name)
 
-    def save(self, *args, **kwargs):
+    def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
         from readthedocs.projects import tasks
         parsed = urlparse(self.domain)
         if parsed.scheme or parsed.netloc:
@@ -917,7 +917,7 @@ def save(self, *args, **kwargs):
         super(Domain, self).save(*args, **kwargs)
         broadcast(type='app', task=tasks.symlink_domain, args=[self.project.pk, self.pk])
 
-    def delete(self, *args, **kwargs):
+    def delete(self, *args, **kwargs):  # pylint: disable=arguments-differ
         from readthedocs.projects import tasks
         broadcast(type='app', task=tasks.symlink_domain, args=[self.project.pk, self.pk, True])
         super(Domain, self).delete(*args, **kwargs)

readthedocs/projects/tasks.py

@@ -109,7 +109,7 @@ def _log(self, msg):
 
     def run(self, pk, version_pk=None, build_pk=None, record=True,
             docker=False, search=True, force=False, localmedia=True, **__):
-
+        # pylint: disable=arguments-differ
         self.project = self.get_project(pk)
         self.version = self.get_version(self.project, version_pk)
         self.build = self.get_build(build_pk)

readthedocs/projects/utils.py

@@ -41,8 +41,8 @@ def find_file(filename):
     """
     matches = []
     for root, __, filenames in os.walk('.'):
-        for filename in fnmatch.filter(filenames, filename):
-            matches.append(os.path.join(root, filename))
+        for match in fnmatch.filter(filenames, filename):
+            matches.append(os.path.join(root, match))
     return matches