Merge pull request #74 from CatalystCode/feature/flake8

Feature/Add flake8 linter

.dockerignore

@@ -5,4 +5,5 @@ app/db.sqlite3
 !data/
 !tests/
 !tools/
+!.flake8
 !requirements.txt

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+filename = app/*
+max-line-length = 120

app/app/settings.py

@@ -159,7 +159,7 @@ DATABASES['default'].update(dj_database_url.config(conn_max_age=500, ssl_require
 SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
 
 # Allow all host headers
-#ALLOWED_HOSTS = ['*']
+# ALLOWED_HOSTS = ['*']
 
 # Size of the batch for creating documents
 # on the import phase

app/server/tests/test_annotation_api.py

@@ -2,7 +2,7 @@ from django.urls import reverse
 from rest_framework import status
 from rest_framework.test import APITestCase
 from mixer.backend.django import mixer
-from ..models import *
+from ..models import User, Project
 
 
 class TestAnnotationAPI(APITestCase):

app/server/tests/test_doc_api.py

@@ -2,7 +2,7 @@ from django.urls import reverse
 from rest_framework import status
 from rest_framework.test import APITestCase
 from mixer.backend.django import mixer
-from ..models import *
+from ..models import User
 
 
 class TestDocAPI(APITestCase):
@@ -53,7 +53,7 @@ class TestDocAPI(APITestCase):
         """
         Ensure we cannot get label objects by other.
         """
-        user = self.create_user()
+        user = self.create_user()  # noqa: F841
         project = self.create_project()
         doc = self.create_doc()
         project.documents.add(doc)

app/server/tests/test_label_api.py

@@ -2,7 +2,7 @@ from django.urls import reverse
 from rest_framework import status
 from rest_framework.test import APITestCase
 from mixer.backend.django import mixer
-from ..models import *
+from ..models import User, Label
 
 
 class TestLabelAPI(APITestCase):
@@ -56,7 +56,7 @@ class TestLabelAPI(APITestCase):
         """
         Ensure we cannot get label objects by other.
         """
-        user = self.create_user()
+        user = self.create_user()  # noqa: F841
         project = self.create_project()
         label = self.create_label()
         project.labels.add(label)

app/server/tests/test_models.py

@@ -2,7 +2,7 @@ from django.test import TestCase
 from django.core.exceptions import ValidationError
 from django.db.utils import IntegrityError
 from mixer.backend.django import mixer
-from server.models import Label, DocumentAnnotation, SequenceAnnotation, Seq2seqAnnotation
+from ..models import Label, DocumentAnnotation, SequenceAnnotation, Seq2seqAnnotation
 
 
 class TestProject(TestCase):

app/server/tests/test_projects_api.py

@@ -2,7 +2,7 @@ from django.urls import reverse
 from rest_framework import status
 from rest_framework.test import APITestCase
 from mixer.backend.django import mixer
-from ..models import *
+from ..models import User, Project
 
 
 class TestProjects(APITestCase):
@@ -14,7 +14,7 @@ class TestProjects(APITestCase):
         cls.super_username = 'super'
         cls.normal_user = User.objects.create_user(username=cls.username, password=cls.password)
         cls.super_user = User.objects.create_superuser(username=cls.super_username,
-                                                  password=cls.password, email='fizz@buzz.com')
+                                                       password=cls.password, email='fizz@buzz.com')
         cls.project1 = mixer.blend('server.Project', project_type=Project.DOCUMENT_CLASSIFICATION,
                                    users=[cls.normal_user, cls.super_user])
         cls.project2 = mixer.blend('server.Project', project_type=Project.DOCUMENT_CLASSIFICATION,

app/server/tests/test_views.py

@@ -3,7 +3,7 @@ from django.urls import reverse
 from django.test import TestCase, Client
 from rest_framework import status
 from mixer.backend.django import mixer
-from ..models import *
+from ..models import User, Document
 
 
 class TestUpload(TestCase):

app/server/views.py

@@ -20,6 +20,7 @@ from app import settings
 
 logger = logging.getLogger(__name__)
 
+
 class IndexView(TemplateView):
     template_name = 'index.html'
 
@@ -65,13 +66,13 @@ class DataUpload(SuperUserMixin, LoginRequiredMixin, TemplateView):
             self.message = message
 
     def extract_metadata_csv(self, row, text_col, header_without_text):
-        vals_without_text = [val for i,val in enumerate(row) if i != text_col]
+        vals_without_text = [val for i, val in enumerate(row) if i != text_col]
         return json.dumps(dict(zip(header_without_text, vals_without_text)))
 
     def csv_to_documents(self, project, file, text_key='text'):
         form_data = TextIOWrapper(file, encoding='utf-8')
         reader = csv.reader(form_data)
-        
+
         maybe_header = next(reader)
         if maybe_header:
             if text_key in maybe_header:
@@ -82,12 +83,12 @@ class DataUpload(SuperUserMixin, LoginRequiredMixin, TemplateView):
             else:
                 raise DataUpload.ImportFileError("CSV file must have either a title with \"text\" column or have only one column ")
 
-            header_without_text = [title for i,title in enumerate(maybe_header) 
+            header_without_text = [title for i, title in enumerate(maybe_header)
                                    if i != text_col]
 
             return (
                 Document(
-                    text=row[text_col], 
+                    text=row[text_col],
                     metadata=self.extract_metadata_csv(row, text_col, header_without_text),
                     project=project
                 )
@@ -101,15 +102,14 @@ class DataUpload(SuperUserMixin, LoginRequiredMixin, TemplateView):
         del copy[text_key]
         return json.dumps(copy)
 
-    def json_to_documents(self, project, file, text_key='text'):            
+    def json_to_documents(self, project, file, text_key='text'):
         parsed_entries = (json.loads(line) for line in file)
-        
+
         return (
             Document(text=entry[text_key], metadata=self.extract_metadata_json(entry, text_key), project=project)
             for entry in parsed_entries
         )
 
-
     def post(self, request, *args, **kwargs):
         project = get_object_or_404(Project, pk=kwargs.get('project_id'))
         import_format = request.POST['format']
@@ -118,7 +118,7 @@ class DataUpload(SuperUserMixin, LoginRequiredMixin, TemplateView):
             documents = []
             if import_format == 'csv':
                 documents = self.csv_to_documents(project, file)
-                
+
             elif import_format == 'json':
                 documents = self.json_to_documents(project, file)
 
@@ -175,7 +175,7 @@ class DataDownloadFile(SuperUserMixin, LoginRequiredMixin, View):
         response['Content-Disposition'] = 'attachment; filename="{}.json"'.format(filename)
         for d in docs:
             dump = json.dumps(d.to_json(), ensure_ascii=False)
-            response.write(dump + '\n') # write each json object end with a newline
+            response.write(dump + '\n')  # write each json object end with a newline
         return response
 
 

requirements.txt

@@ -6,6 +6,7 @@ django-widget-tweaks==1.4.2
 djangorestframework==3.8.2
 djangorestframework-filters==0.10.2
 Faker==0.8.8
+flake8==3.6.0
 gunicorn==19.9.0
 mixer==6.1.3
 psycopg2==2.7.5

tools/ci.sh

@@ -2,6 +2,7 @@
 
 set -o errexit
 
+flake8
 python app/manage.py migrate
 python app/manage.py collectstatic
 python app/manage.py test server.tests