Add isort to CI process (#360)

* Sort rest_framework_json_api package imports.

* Sort example package imports.

* Add isort to Travis.

* Don't depend on a Zsh feature.

* Show the failing lines.

* Handle the example project with extra package information.

* Use the thirdparty flag as it is intended.

Author: mblayman

.travis.yml

@@ -40,12 +40,16 @@ before_install:
   # Force an upgrade of py & pytest to avoid VersionConflict
   - pip install --upgrade py
   - pip install "pytest>=2.8,<3"
-  - pip install codecov flake8
+  - pip install codecov flake8 isort
 install:
   - pip install Django${DJANGO} djangorestframework${DRF}
   - python setup.py install
 script:
   - flake8
+  - isort --check-only --verbose --recursive --diff rest_framework_json_api
+  # example has extra dependencies that are installed in a dev environment
+  # but are not installed in CI. Explicitly set those packages.
+  - isort --check-only --verbose --recursive --diff --thirdparty pytest --thirdparty polymorphic --thirdparty pytest_factoryboy example
   - coverage run setup.py -v test
 after_success:
   - codecov

example/api/resources/identity.py

@@ -1,10 +1,11 @@
 from django.contrib.auth import models as auth_models
 from django.utils import encoding
-
-from rest_framework import viewsets, generics, renderers, parsers, serializers
-from rest_framework.decorators import list_route, detail_route
+from rest_framework import generics, parsers, renderers, serializers, viewsets
+from rest_framework.decorators import detail_route, list_route
 from rest_framework.response import Response
+
 from rest_framework_json_api import mixins, utils
+
 from ..serializers.identity import IdentitySerializer
 from ..serializers.post import PostSerializer
 

example/models.py

@@ -1,9 +1,8 @@
 # -*- encoding: utf-8 -*-
 from __future__ import unicode_literals
 
+from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation
 from django.contrib.contenttypes.models import ContentType
-from django.contrib.contenttypes.fields import GenericForeignKey
-from django.contrib.contenttypes.fields import GenericRelation
 from django.db import models
 from django.utils.encoding import python_2_unicode_compatible
 from polymorphic.models import PolymorphicModel

example/serializers.py

@@ -1,11 +1,21 @@
 from datetime import datetime
 
 import rest_framework
-from rest_framework_json_api import serializers, relations
+
 from packaging import version
+from rest_framework_json_api import relations, serializers
+
 from example.models import (
-    Blog, Entry, Author, AuthorBio, Comment, TaggedItem, Project, ArtProject, ResearchProject,
+    ArtProject,
+    Author,
+    AuthorBio,
+    Blog,
+    Comment,
     Company,
+    Entry,
+    Project,
+    ResearchProject,
+    TaggedItem
 )
 
 

example/tests/conftest.py

@@ -2,8 +2,15 @@
 from pytest_factoryboy import register
 
 from example.factories import (
-    BlogFactory, AuthorFactory, AuthorBioFactory, EntryFactory, CommentFactory,
-    TaggedItemFactory, ArtProjectFactory, ResearchProjectFactory, CompanyFactory,
+    ArtProjectFactory,
+    AuthorBioFactory,
+    AuthorFactory,
+    BlogFactory,
+    CommentFactory,
+    CompanyFactory,
+    EntryFactory,
+    ResearchProjectFactory,
+    TaggedItemFactory
 )
 
 register(BlogFactory)

example/tests/integration/test_meta.py

@@ -1,7 +1,8 @@
 from datetime import datetime
-from django.core.urlresolvers import reverse
 
 import pytest
+from django.core.urlresolvers import reverse
+
 from example.tests.utils import load_json
 
 pytestmark = pytest.mark.django_db

example/tests/integration/test_model_resource_name.py

@@ -1,10 +1,11 @@
-import pytest
 from copy import deepcopy
-from example import models, serializers, views
-from example.tests.utils import dump_json, load_json
-from rest_framework import status
 
+import pytest
 from django.core.urlresolvers import reverse
+from rest_framework import status
+
+from example import models, serializers, views
+from example.tests.utils import dump_json, load_json
 
 pytestmark = pytest.mark.django_db
 

example/tests/integration/test_non_paginated_responses.py

@@ -1,17 +1,16 @@
+import pytest
 from django.core.urlresolvers import reverse
 
+from rest_framework_json_api.pagination import PageNumberPagination
+
+from example.tests.utils import load_json
+from example.views import EntryViewSet
+
 try:
     from unittest import mock
 except ImportError:
     import mock
 
-import pytest
-
-from example.views import EntryViewSet
-from rest_framework_json_api.pagination import PageNumberPagination
-
-from example.tests.utils import load_json
-
 pytestmark = pytest.mark.django_db
 
 

example/tests/integration/test_pagination.py

@@ -1,12 +1,13 @@
+import pytest
 from django.core.urlresolvers import reverse
 
+from example.tests.utils import load_json
+
 try:
     from unittest import mock
 except ImportError:
     import mock
 
-import pytest
-from example.tests.utils import load_json
 
 pytestmark = pytest.mark.django_db
 

example/tests/integration/test_polymorphism.py

@@ -1,6 +1,7 @@
-import pytest
-import random
 import json
+import random
+
+import pytest
 from django.core.urlresolvers import reverse
 
 from example.tests.utils import load_json