linting for comments app (readthedocs#2886)

Author: smcoll

prospector-more.yml

@@ -4,7 +4,6 @@ strictness: medium
 
 ignore-paths:
   - cdn/
-  - comments/
   - core/
   - doc_builder/
   - donate/

readthedocs/comments/admin.py

@@ -1,3 +1,5 @@
+"""ModelAdmin configurations for comments app."""
+
 from django.contrib import admin
 from .models import DocumentNode, DocumentComment, NodeSnapshot
 

readthedocs/comments/backend.py

@@ -1,10 +1,11 @@
+"""Storage backends for the comments app."""
+
 import json
 
 from django.core import serializers
 from sphinx.websupport.storage import StorageBackend
 
 from .models import DocumentNode
-from readthedocs.comments.models import NodeSnapshot
 
 
 class DjangoStorage(StorageBackend):

readthedocs/comments/models.py

@@ -1,9 +1,10 @@
+"""Models for the comments app."""
+
 from django.contrib.auth.models import User
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
 from rest_framework import serializers
 
-from readthedocs.privacy.backend import AdminPermission, AdminNotAuthorized
 from readthedocs.restapi.serializers import VersionSerializer
 
 
@@ -23,6 +24,7 @@ def create(self, *args, **kwargs):
         return node
 
     def from_hash(self, version_slug, page, node_hash, project_slug=None):
+        """Return a node matching a given hash."""
         snapshots = NodeSnapshot.objects.filter(hash=node_hash,
                                                 node__version__slug=version_slug,
                                                 node__page=page)
@@ -58,6 +60,8 @@ def from_hash(self, version_slug, page, node_hash, project_slug=None):
 
 class DocumentNode(models.Model):
 
+    """Document node."""
+
     objects = DocumentNodeManager()
 
     project = models.ForeignKey('projects.Project', verbose_name=_('Project'),
@@ -71,10 +75,6 @@ class DocumentNode(models.Model):
     def __unicode__(self):
         return "node %s on %s for %s" % (self.id, self.page, self.project)
 
-    def save(self, *args, **kwargs):
-        pass
-        super(DocumentNode, self).save(*args, **kwargs)
-
     def latest_hash(self):
         return self.snapshots.latest().hash
 
@@ -127,6 +127,9 @@ class Meta:
         # in a later commit.
         unique_together = ("hash", "node", "commit")
 
+    def __unicode__(self):
+        return self.hash
+
 
 # class DocumentCommentManager(models.Manager):
 #
@@ -149,6 +152,9 @@ class Meta:
 
 
 class DocumentComment(models.Model):
+
+    """Comment on a ``DocumentNode`` by a user."""
+
     date = models.DateTimeField(_('Date'), auto_now_add=True)
     rating = models.IntegerField(_('Rating'), default=0)
     text = models.TextField(_('Text'))
@@ -197,8 +203,12 @@ def perform_create(self):
 
 class ModerationActionManager(models.Model):
 
+    def __unicode__(self):
+        return str(self.id)
+
     def current_approvals(self):
-        most_recent_change = self.comment.node.snapshots.latest().date
+        # pylint: disable=unused-variable
+        most_recent_change = self.comment.node.snapshots.latest().date  # noqa
 
 
 class ModerationAction(models.Model):
@@ -211,6 +221,9 @@ class ModerationAction(models.Model):
     ))
     date = models.DateTimeField(_('Date'), auto_now_add=True)
 
+    def __unicode__(self):
+        return "%s - %s" % (self.user_id, self.get_decision_display())
+
     class Meta:
         get_latest_by = 'date'
 

readthedocs/comments/session.py

@@ -1,10 +1,12 @@
+"""Authentication backends for DRF."""
+
 from rest_framework.authentication import SessionAuthentication
 
 
 class UnsafeSessionAuthentication(SessionAuthentication):
 
     def authenticate(self, request):
-        http_request = request._request
+        http_request = request._request  # pylint: disable=protected-access
         user = getattr(http_request, 'user', None)
 
         if not user or not user.is_active:

readthedocs/comments/urls.py

@@ -1,4 +1,6 @@
-from django.conf.urls import url, include
+"""URL configuration for comments app."""
+
+from django.conf.urls import url
 
 from readthedocs.comments import views
 

readthedocs/comments/views.py

@@ -1,7 +1,6 @@
-import json
+"""Views for comments app."""
 
 from django.contrib.auth.decorators import login_required
-from django.http.response import HttpResponseRedirect
 from django.shortcuts import render_to_response
 from django.template import RequestContext
 from django.utils.decorators import method_decorator
@@ -14,19 +13,16 @@
     detail_route
 )
 from rest_framework.exceptions import ParseError
-from rest_framework.permissions import IsAuthenticated
 from rest_framework.renderers import JSONRenderer
 from rest_framework.response import Response
-from rest_framework.serializers import ModelSerializer, Serializer
 from rest_framework.viewsets import ModelViewSet
 from sphinx.websupport import WebSupport
 
 from readthedocs.comments.models import (
     DocumentComment, DocumentNode, NodeSnapshot, DocumentCommentSerializer,
     DocumentNodeSerializer, ModerationActionSerializer)
-from readthedocs.privacy.backend import AdminNotAuthorized
 from readthedocs.projects.models import Project
-from readthedocs.restapi.permissions import IsOwner, CommentModeratorOrReadOnly
+from readthedocs.restapi.permissions import CommentModeratorOrReadOnly
 
 from .backend import DjangoStorage
 from .session import UnsafeSessionAuthentication
@@ -48,7 +44,7 @@
 @api_view(['GET'])
 @permission_classes([permissions.IsAuthenticatedOrReadOnly])
 @renderer_classes((JSONRenderer,))
-def get_options(request):
+def get_options(request):  # pylint: disable=unused-argument
     base_opts = support.base_comment_opts
     base_opts['addCommentURL'] = '/api/v2/comments/'
     base_opts['getCommentsURL'] = '/api/v2/comments/'
@@ -88,11 +84,11 @@ def attach_comment(request):
 # Normal Views
 #######
 
-def build(request):
+def build(request):  # pylint: disable=unused-argument
     support.build()
 
 
-def serve_file(request, file):
+def serve_file(request, file):  # pylint: disable=redefined-builtin
     document = support.get_document(file)
 
     return render_to_response('doc.html',
@@ -158,6 +154,9 @@ def update_node(request):
 
 
 class CommentViewSet(ModelViewSet):
+
+    """Viewset for Comment model."""
+
     serializer_class = DocumentCommentSerializer
     permission_classes = [CommentModeratorOrReadOnly, permissions.IsAuthenticatedOrReadOnly]
 
@@ -199,7 +198,7 @@ def create(self, request):
         return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
 
     @detail_route(methods=['put'])
-    def moderate(self, request, pk):
+    def moderate(self, request, pk):  # pylint: disable=unused-argument
         comment = self.get_object()
         decision = request.data['decision']
         moderation_action = comment.moderate(request.user, decision)