Adopt Django's isort configuration and run it.

Author: aaugustin

Makefile

@@ -3,6 +3,12 @@
 flake8:
 	flake8 debug_toolbar example tests
 
+isort:
+	isort -rc debug_toolbar example tests
+
+isort_check_only:
+	isort -rc -c debug_toolbar example tests
+
 example:
 	DJANGO_SETTINGS_MODULE=example.settings \
 		django-admin.py runserver

debug_toolbar/__init__.py

@@ -1,6 +1,5 @@
 from __future__ import absolute_import, unicode_literals
 
-
 __all__ = ['VERSION']
 
 

debug_toolbar/management/commands/debugsqlshell.py

@@ -2,10 +2,9 @@
 
 from time import time
 
-# 'debugsqlshell' is the same as the 'shell'.
-from django.core.management.commands.shell import Command               # noqa
-
 import sqlparse
+# 'debugsqlshell' is the same as the 'shell'.
+from django.core.management.commands.shell import Command  # noqa
 
 from debug_toolbar.compat import db_backends_util
 

debug_toolbar/middleware.py

@@ -8,12 +8,12 @@
 import threading
 
 from django.conf import settings
-from django.utils.encoding import force_text
 from django.utils import six
+from django.utils.encoding import force_text
 
-from debug_toolbar.toolbar import DebugToolbar
 from debug_toolbar import settings as dt_settings
 from debug_toolbar.compat import import_module
+from debug_toolbar.toolbar import DebugToolbar
 
 _HTML_TYPES = ('text/html', 'application/xhtml+xml')
 # Handles python threading module bug - http://bugs.python.org/issue14308

debug_toolbar/models.py

@@ -4,6 +4,5 @@
 
 from debug_toolbar import settings as dt_settings
 
-
 if dt_settings.PATCH_SETTINGS and django.VERSION[:2] < (1, 7):
     dt_settings.patch_all()

debug_toolbar/panels/cache.py

@@ -7,21 +7,21 @@
 from django.conf import settings
 from django.core import cache
 from django.core.cache import (
-    cache as original_cache,
-    get_cache as original_get_cache)
+    cache as original_cache, get_cache as original_get_cache,
+)
 from django.core.cache.backends.base import BaseCache
 from django.dispatch import Signal
 from django.middleware import cache as middleware_cache
 from django.utils.translation import ugettext_lazy as _, ungettext
 
-
 from debug_toolbar import settings as dt_settings
 from debug_toolbar.compat import (
-    OrderedDict, CacheHandler, caches as original_caches)
+    CacheHandler, OrderedDict, caches as original_caches,
+)
 from debug_toolbar.panels import Panel
-from debug_toolbar.utils import (tidy_stacktrace, render_stacktrace,
-                                 get_template_info, get_stack)
-
+from debug_toolbar.utils import (
+    get_stack, get_template_info, render_stacktrace, tidy_stacktrace,
+)
 
 cache_called = Signal(providing_args=[
     "time_taken", "name", "return_value", "args", "kwargs", "trace"])

debug_toolbar/panels/logging.py

@@ -2,13 +2,16 @@
 
 import datetime
 import logging
+
+from django.utils.translation import ugettext_lazy as _, ungettext
+
+from debug_toolbar.panels import Panel
+from debug_toolbar.utils import ThreadCollector
+
 try:
     import threading
 except ImportError:
     threading = None
-from django.utils.translation import ungettext, ugettext_lazy as _
-from debug_toolbar.panels import Panel
-from debug_toolbar.utils import ThreadCollector
 
 MESSAGE_IF_STRING_REPRESENTATION_INVALID = '[Could not get log message]'
 

debug_toolbar/panels/profiling.py

@@ -1,15 +1,16 @@
 from __future__ import absolute_import, division, unicode_literals
 
+import cProfile
+import os
+from colorsys import hsv_to_rgb
+from pstats import Stats
+
 from django.utils import six
-from django.utils.translation import ugettext_lazy as _
 from django.utils.safestring import mark_safe
-from debug_toolbar.panels import Panel
-from debug_toolbar import settings as dt_settings
+from django.utils.translation import ugettext_lazy as _
 
-import cProfile
-from pstats import Stats
-from colorsys import hsv_to_rgb
-import os
+from debug_toolbar import settings as dt_settings
+from debug_toolbar.panels import Panel
 
 # Occasionally the disable method on the profiler is listed before
 # the actual view functions. This function call should be ignored as

debug_toolbar/panels/settings.py

@@ -1,8 +1,8 @@
 from __future__ import absolute_import, unicode_literals
 
 from django.conf import settings
-from django.views.debug import get_safe_settings
 from django.utils.translation import ugettext_lazy as _
+from django.views.debug import get_safe_settings
 
 from debug_toolbar.compat import OrderedDict
 from debug_toolbar.panels import Panel

debug_toolbar/panels/signals.py

@@ -1,17 +1,17 @@
 from __future__ import absolute_import, unicode_literals
 
-
 from django.core.signals import (
-    request_started, request_finished, got_request_exception)
+    got_request_exception, request_finished, request_started,
+)
 from django.db.backends.signals import connection_created
 from django.db.models.signals import (
-    class_prepared, pre_init, post_init, pre_save, post_save,
-    pre_delete, post_delete, post_syncdb)
-
+    class_prepared, post_delete, post_init, post_save, post_syncdb, pre_delete,
+    pre_init, pre_save,
+)
 from django.utils.translation import ugettext_lazy as _, ungettext
 
+from debug_toolbar.compat import WEAKREF_TYPES, import_module
 from debug_toolbar.panels import Panel
-from debug_toolbar.compat import import_module, WEAKREF_TYPES
 
 
 class SignalsPanel(Panel):

debug_toolbar/panels/sql/__init__.py

@@ -1 +1 @@
-from debug_toolbar.panels.sql.panel import SQLPanel                     # noqa
+from debug_toolbar.panels.sql.panel import SQLPanel  # noqa

debug_toolbar/panels/sql/forms.py

@@ -1,14 +1,14 @@
 from __future__ import absolute_import, unicode_literals
 
-import json
 import hashlib
+import json
 
 from django import forms
 from django.conf import settings
+from django.core.exceptions import ValidationError
 from django.db import connections
 from django.utils.encoding import force_text
 from django.utils.functional import cached_property
-from django.core.exceptions import ValidationError
 
 from debug_toolbar.panels.sql.utils import reformat_sql
 

debug_toolbar/panels/sql/panel.py

@@ -1,19 +1,21 @@
 from __future__ import absolute_import, unicode_literals
 
 import uuid
-from copy import copy
 from collections import defaultdict
+from copy import copy
 
 from django.conf.urls import url
 from django.db import connections
 from django.utils.translation import ugettext_lazy as _, ungettext_lazy as __
 
 from debug_toolbar.panels import Panel
+from debug_toolbar.panels.sql import views
 from debug_toolbar.panels.sql.forms import SQLSelectForm
+from debug_toolbar.panels.sql.tracking import unwrap_cursor, wrap_cursor
+from debug_toolbar.panels.sql.utils import (
+    contrasting_color_generator, reformat_sql,
+)
 from debug_toolbar.utils import render_stacktrace
-from debug_toolbar.panels.sql.utils import reformat_sql, contrasting_color_generator
-from debug_toolbar.panels.sql.tracking import wrap_cursor, unwrap_cursor
-from debug_toolbar.panels.sql import views
 
 
 def get_isolation_level_display(vendor, level):

debug_toolbar/panels/sql/tracking.py

@@ -4,11 +4,11 @@
 from threading import local
 from time import time
 
-from django.utils.encoding import force_text
 from django.utils import six
+from django.utils.encoding import force_text
 
-from debug_toolbar.utils import tidy_stacktrace, get_template_info, get_stack
 from debug_toolbar import settings as dt_settings
+from debug_toolbar.utils import get_stack, get_template_info, tidy_stacktrace
 
 
 class SQLQueryTriggered(Exception):

debug_toolbar/panels/sql/utils.py

@@ -2,9 +2,8 @@
 
 import re
 
-from django.utils.html import escape
-
 import sqlparse
+from django.utils.html import escape
 from sqlparse import tokens as T
 
 

debug_toolbar/panels/staticfiles.py

@@ -1,23 +1,27 @@
 from __future__ import absolute_import, unicode_literals
-from os.path import normpath, join
-try:
-    import threading
-except ImportError:
-    threading = None
+
+from os.path import join, normpath
 
 from django.conf import settings
-from django.core.files.storage import get_storage_class
 from django.contrib.staticfiles import finders, storage
 from django.contrib.staticfiles.templatetags import staticfiles
-
+from django.core.files.storage import get_storage_class
 from django.utils.encoding import python_2_unicode_compatible
 from django.utils.functional import LazyObject
-from django.utils.translation import ungettext, ugettext_lazy as _
+from django.utils.translation import ugettext_lazy as _, ungettext
 
 from debug_toolbar import panels
 from debug_toolbar.compat import OrderedDict
 from debug_toolbar.utils import ThreadCollector
 
+try:
+    import threading
+except ImportError:
+    threading = None
+
+
+
+
 
 @python_2_unicode_compatible
 class StaticFile(object):

debug_toolbar/panels/templates/__init__.py

@@ -1 +1 @@
-from debug_toolbar.panels.templates.panel import TemplatesPanel         # noqa
+from debug_toolbar.panels.templates.panel import TemplatesPanel  # noqa

debug_toolbar/panels/templates/panel.py

@@ -11,17 +11,17 @@
 from django.template import Context, RequestContext, Template
 from django.test.signals import template_rendered
 from django.test.utils import instrumented_test_render
-from django.utils.encoding import force_text
 from django.utils import six
+from django.utils.encoding import force_text
 from django.utils.translation import ugettext_lazy as _
 
 from debug_toolbar.compat import (
-    OrderedDict, get_template_dirs, get_template_context_processors)
+    OrderedDict, get_template_context_processors, get_template_dirs,
+)
 from debug_toolbar.panels import Panel
-from debug_toolbar.panels.sql.tracking import recording, SQLQueryTriggered
+from debug_toolbar.panels.sql.tracking import SQLQueryTriggered, recording
 from debug_toolbar.panels.templates import views
 
-
 # Monkey-patch to enable the template_rendered signal. The receiver returns
 # immediately when the panel is disabled to keep the overhead small.
 

debug_toolbar/panels/timer.py

@@ -1,14 +1,17 @@
 from __future__ import absolute_import, unicode_literals
 
-try:
-    import resource     # Not available on Win32 systems
-except ImportError:
-    resource = None
 import time
+
 from django.template.loader import render_to_string
 from django.utils.translation import ugettext_lazy as _
+
 from debug_toolbar.panels import Panel
 
+try:
+    import resource     # Not available on Win32 systems
+except ImportError:
+    resource = None
+
 
 class TimerPanel(Panel):
     """

debug_toolbar/panels/versions.py

@@ -6,7 +6,7 @@
 from django.conf import settings
 from django.utils.translation import ugettext_lazy as _
 
-from debug_toolbar.compat import import_module, OrderedDict
+from debug_toolbar.compat import OrderedDict, import_module
 from debug_toolbar.panels import Panel
 
 

debug_toolbar/settings.py

@@ -7,7 +7,6 @@
 
 from debug_toolbar.compat import import_module
 
-
 # Always import this module as follows:
 # from debug_toolbar import settings [as dt_settings]
 

debug_toolbar/toolbar.py

@@ -14,7 +14,7 @@
 from django.template.loader import render_to_string
 
 from debug_toolbar import settings as dt_settings
-from debug_toolbar.compat import import_module, OrderedDict
+from debug_toolbar.compat import OrderedDict, import_module
 
 
 class DebugToolbar(object):

debug_toolbar/utils.py

@@ -4,23 +4,27 @@
 import os.path
 import re
 import sys
-try:
-    import threading
-except ImportError:
-    threading = None
 
 import django
 from django.core.exceptions import ImproperlyConfigured
 from django.template import Node
+from django.utils import six
 from django.utils.encoding import force_text
 from django.utils.html import escape
 from django.utils.safestring import mark_safe
-from django.utils import six
 from django.views.debug import linebreak_iter
 
-from .settings import CONFIG
 from debug_toolbar.compat import import_module
 
+from .settings import CONFIG
+
+try:
+    import threading
+except ImportError:
+    threading = None
+
+
+
 # Figure out some paths
 django_path = os.path.realpath(os.path.dirname(django.__file__))
 

docs/contributing.rst

@@ -76,6 +76,10 @@ to 100 characters. You can check for style violations with::
 
     $ make flake8
 
+Import style is enforce by isort. You can sort import automatically with::
+
+    $ make isort
+
 Patches
 -------
 

example/settings.py

@@ -1,6 +1,7 @@
 """Django settings for example project."""
 
 import os
+
 BASE_DIR = os.path.dirname(os.path.dirname(__file__))