Fix quality.

notesapi/management/commands/create_index.py

@@ -6,14 +6,18 @@ from notesapi.v1.models import NoteMappingType
 
 
 class Command(BaseCommand):
+    """
+    Indexing and mapping commands.
+    """
     help = 'Creates index and the mapping.'
     option_list = BaseCommand.option_list + (
-        make_option('--drop',
+        make_option(
+            '--drop',
             action='store_true',
             dest='drop',
             default=False,
             help='Recreate index'),
-        )
+    )
 
     def handle(self, *args, **options):
         if options['drop']:

notesapi/v1/models.py

@@ -6,7 +6,11 @@ from django.db.models import signals
 from django.dispatch import receiver
 from elasticutils.contrib.django import Indexable, MappingType, get_es
 
+
 class Note(models.Model):
+    """
+    Annotation model.
+    """
     user_id = models.CharField(max_length=255)
     course_id = models.CharField(max_length=255)
     usage_id = models.CharField(max_length=255)
@@ -16,7 +20,6 @@ class Note(models.Model):
     created = models.DateTimeField(auto_now_add=True)
     updated = models.DateTimeField(auto_now=True)
 
-
     def clean(self, note):
         """
         Clean the note object or raises a ValidationError.
@@ -64,16 +67,15 @@ class Note(models.Model):
         }
 
 
-
 @receiver(signals.post_save, sender=Note)
-def update_in_index(sender, instance, **kw):
+def update_in_index(sender, instance, **kwargs):
     if settings.ES_DISABLED:
         return
     NoteMappingType.index(instance.as_dict(), id_=instance.id, overwrite_existing=True)
 
 
 @receiver(signals.post_delete, sender=Note)
-def delete_in_index(sender, instance, **kw):
+def delete_in_index(sender, instance, **kwargs):
     if settings.ES_DISABLED:
         return
     NoteMappingType.unindex(id_=instance.id)

notesapi/v1/permissions.py

@@ -57,4 +57,4 @@ class HasAccessToken(BasePermission):
             logger.debug("Could not decode token {}".format(token))
         except TokenWrongIssuer:
             logger.debug("Token has wrong issuer {}".format(token))
-        return False
+        return False
\ No newline at end of file

notesapi/v1/tests/test_models.py

-import json
 from unittest import TestCase
 from notesapi.v1.models import Note, NoteMappingType
 from django.core.exceptions import ValidationError

notesapi/v1/tests/test_views.py

@@ -3,7 +3,6 @@ import jwt
 from calendar import timegm
 from datetime import datetime, timedelta
 from mock import patch
-import unittest
 
 from django.core.urlresolvers import reverse
 from django.conf import settings
@@ -143,7 +142,6 @@ class AnnotationViewTests(BaseAnnotationViewTests):
         annotation = self._get_annotation(response.data['id'])
         self.assertNotEqual(annotation['created'], 'abc', "annotation 'created' field should not be used by API")
 
-
     def test_create_ignore_updated(self):
         """
         Test if annotation 'updated' field is not used by API.
@@ -193,18 +191,21 @@ class AnnotationViewTests(BaseAnnotationViewTests):
         Create a note that has several ranges and read it
         """
         note = self.payload.copy()
-        ranges = [{
-                    "start": "/p[1]",
-                    "end": "/p[1]",
-                    "startOffset": 0,
-                    "endOffset": 10,
-                }, {
-                    "start": "/p[2]",
-                    "end": "/p[2]",
-                    "startOffset": 20,
-                    "endOffset": 22,
-                }
-            ]
+        ranges = [
+            {
+                "start": "/p[1]",
+                "end": "/p[1]",
+                "startOffset": 0,
+                "endOffset": 10,
+            },
+            {
+                "start": "/p[2]",
+                "end": "/p[2]",
+                "startOffset": 20,
+                "endOffset": 22,
+            }
+        ]
+
         note['ranges'] = ranges
         note_id = self._create_annotation(**note)['id']
 
@@ -226,7 +227,6 @@ class AnnotationViewTests(BaseAnnotationViewTests):
         response = self.client.get(url, self.headers)
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND, "response should be 404 NOT FOUND")
 
-
     def test_update(self):
         """
         Ensure we can update an existing annotation.
@@ -315,9 +315,9 @@ class AnnotationViewTests(BaseAnnotationViewTests):
         """
         Tests for search method.
         """
-        note_1 = self._create_annotation(text=u'First one')
-        note_2 = self._create_annotation(text=u'Second note')
-        note_3 = self._create_annotation(text=u'Third note')
+        self._create_annotation(text=u'First one')
+        self._create_annotation(text=u'Second note')
+        self._create_annotation(text=u'Third note')
 
         results = self._get_search_results()
         self.assertEqual(results['total'], 3)

notesapi/v1/urls.py

 from django.conf.urls import patterns, url
-from django.views.generic import RedirectView
-from django.core.urlresolvers import reverse_lazy
 from notesapi.v1.views import AnnotationListView, AnnotationDetailView, AnnotationSearchView
 
 urlpatterns = patterns(
     '',
     url(r'^annotations/$', AnnotationListView.as_view(), name='annotations'),
-    url(r'^annotations/(?P<annotation_id>[a-zA-Z0-9_-]+)/?$', AnnotationDetailView.as_view(), name='annotations_detail'),
+    url(
+        r'^annotations/(?P<annotation_id>[a-zA-Z0-9_-]+)/?$',
+        AnnotationDetailView.as_view(),
+        name='annotations_detail'
+    ),
     url(r'^search/$', AnnotationSearchView.as_view(), name='annotations_search'),
 )

notesapi/v1/views.py

 import logging
 
-from django.conf import settings
 from django.core.urlresolvers import reverse
 from django.core.exceptions import ValidationError
 
@@ -27,6 +26,7 @@ class AnnotationSearchView(APIView):
             if field in params:
                 params[field + "__match"] = params[field]
                 del params[field]
+
         if params.get('highlight'):
 
             # Currently we do not use highlight_class and highlight_tag in service.
@@ -35,14 +35,15 @@ class AnnotationSearchView(APIView):
 
             results = NoteMappingType.process_result(
                 list(
-                    note_searcher.query(**params).order_by("-created").values_dict("_source") \
-                        .highlight("text", pre_tags=['<span>'], post_tags=['</span>'])
+                    note_searcher.query(**params).order_by("-created").values_dict("_source")
+                    .highlight("text", pre_tags=['<span>'], post_tags=['</span>'])
                 )
             )
         else:
             results = NoteMappingType.process_result(
                 list(note_searcher.query(**params).order_by("-created").values_dict("_source"))
             )
+
         return Response({'total': len(results), 'rows': results})
 
 

notesserver/test_views.py

@@ -5,6 +5,7 @@ from django.core.urlresolvers import reverse
 from rest_framework.test import APITestCase
 from elasticsearch.exceptions import TransportError
 
+
 class OperationalEndpointsTest(APITestCase):
     """
     Tests for operational endpoints.
@@ -41,6 +42,7 @@ class OperationalEndpointsTest(APITestCase):
             }
         )
 
+
 class OperationalAuthEndpointsTest(APITestCase):
     """
     Tests for operational authenticated endpoints.

notesserver/views.py

@@ -3,8 +3,7 @@ import datetime
 from rest_framework import status
 from rest_framework.permissions import AllowAny
 from rest_framework.response import Response
-from rest_framework.views import APIView
-from rest_framework.decorators import api_view, permission_classes, authentication_classes
+from rest_framework.decorators import api_view, permission_classes
 
 from elasticsearch.exceptions import TransportError
 from elasticutils import get_es