Create a compat module that will handle django and python version issues.

Moved all simple try/except ImportError cases into the compat module

Author: tim-schilling

debug_toolbar/compat.py

@@ -0,0 +1,40 @@
+"""
+This file exists to contain all Django and Python compatibility issues.
+
+In order to avoid circular references, nothing should be imported from
+debug_toolbar.
+"""
+
+try:
+    from django.template.engine import Engine
+except ImportError:  # < Django 1.8
+    Engine = None
+    from django.template.context import get_standard_processors  #NOQA
+    from django.template.loader import find_template_loader  # NOQA
+
+try:
+    from importlib import import_module
+except ImportError:  # = python 2.6
+    from django.utils.importlib import import_module  # NOQA
+
+try:
+    from collections import OrderedDict
+except ImportError:  # < python 2.7
+    from django.utils.datastructures import SortedDict as OrderedDict  # NOQA
+
+try:
+    from django.contrib.staticfiles.testing import (
+        StaticLiveServerTestCase as LiveServerTestCase)
+except ImportError:  # < Django 1.7
+    from django.test import LiveServerTestCase  # NOQA
+
+try:
+    from django.db.backends import utils
+except ImportError:  # >= Django 1.7
+    from django.db.backends import util as utils  # NOQA
+
+try:
+    from django.dispatch.dispatcher import WEAKREF_TYPES
+except ImportError:  # >= Django 1.7
+    import weakref
+    WEAKREF_TYPES = weakref.ReferenceType,

debug_toolbar/management/commands/debugsqlshell.py

@@ -4,13 +4,11 @@
 
 # 'debugsqlshell' is the same as the 'shell'.
 from django.core.management.commands.shell import Command               # noqa
-try:
-    from django.db.backends import utils
-except ImportError:
-    from django.db.backends import util as utils
 
 import sqlparse
 
+from debug_toolbar.compat import utils
+
 
 class PrintQueryWrapper(utils.CursorDebugWrapper):
     def execute(self, sql, params=()):

debug_toolbar/middleware.py

@@ -4,10 +4,6 @@
 
 from __future__ import absolute_import, unicode_literals
 
-try:
-    from importlib import import_module
-except ImportError:  # python 2.6
-    from django.utils.importlib import import_module
 import re
 import threading
 
@@ -17,6 +13,7 @@
 
 from debug_toolbar.toolbar import DebugToolbar
 from debug_toolbar import settings as dt_settings
+from debug_toolbar.compat import import_module
 
 _HTML_TYPES = ('text/html', 'application/xhtml+xml')
 # Handles python threading module bug - http://bugs.python.org/issue14308

debug_toolbar/panels/cache.py

@@ -18,15 +18,12 @@
 except ImportError:  # Django < 1.7
     CacheHandler = None
     original_caches = None
-try:
-    from collections import OrderedDict
-except ImportError:
-    from django.utils.datastructures import SortedDict as OrderedDict
 
+from debug_toolbar import settings as dt_settings
+from debug_toolbar.compat import OrderedDict
 from debug_toolbar.panels import Panel
 from debug_toolbar.utils import (tidy_stacktrace, render_stacktrace,
                                  get_template_info, get_stack)
-from debug_toolbar import settings as dt_settings
 
 
 cache_called = Signal(providing_args=[

debug_toolbar/panels/headers.py

@@ -1,10 +1,8 @@
 from __future__ import absolute_import, unicode_literals
 
-try:
-    from collections import OrderedDict
-except ImportError:
-    from django.utils.datastructures import SortedDict as OrderedDict
 from django.utils.translation import ugettext_lazy as _
+
+from debug_toolbar.compat import OrderedDict
 from debug_toolbar.panels import Panel
 
 

debug_toolbar/panels/settings.py

@@ -3,11 +3,8 @@
 from django.conf import settings
 from django.views.debug import get_safe_settings
 from django.utils.translation import ugettext_lazy as _
-try:
-    from collections import OrderedDict
-except ImportError:
-    from django.utils.datastructures import SortedDict as OrderedDict
 
+from debug_toolbar.compat import OrderedDict
 from debug_toolbar.panels import Panel
 
 

debug_toolbar/panels/signals.py

@@ -1,24 +1,17 @@
 from __future__ import absolute_import, unicode_literals
 
-try:
-    from importlib import import_module
-except ImportError:  # python 2.6
-    from django.utils.importlib import import_module
 
 from django.core.signals import (
     request_started, request_finished, got_request_exception)
 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)
-try:
-    from django.dispatch.dispatcher import WEAKREF_TYPES
-except ImportError:
-    import weakref
-    WEAKREF_TYPES = weakref.ReferenceType,
+
 from django.utils.translation import ugettext_lazy as _, ungettext
 
 from debug_toolbar.panels import Panel
+from debug_toolbar.compat import import_module, WEAKREF_TYPES
 
 
 class SignalsPanel(Panel):

debug_toolbar/panels/staticfiles.py

@@ -13,12 +13,9 @@
 from django.utils.encoding import python_2_unicode_compatible
 from django.utils.functional import LazyObject
 from django.utils.translation import ungettext, ugettext_lazy as _
-try:
-    from collections import OrderedDict
-except ImportError:
-    from django.utils.datastructures import SortedDict as OrderedDict
 
 from debug_toolbar import panels
+from debug_toolbar.compat import OrderedDict
 from debug_toolbar.utils import ThreadCollector
 
 

debug_toolbar/panels/templates/panel.py

@@ -1,9 +1,5 @@
 from __future__ import absolute_import, unicode_literals
 
-try:
-    from collections import OrderedDict
-except ImportError:
-    from django.utils.datastructures import SortedDict as OrderedDict
 from os.path import normpath
 from pprint import pformat
 
@@ -19,15 +15,11 @@
 from django.utils import six
 from django.utils.translation import ugettext_lazy as _
 
+from debug_toolbar.compat import OrderedDict, Engine, get_standard_processors
 from debug_toolbar.panels import Panel
 from debug_toolbar.panels.sql.tracking import recording, SQLQueryTriggered
 from debug_toolbar.panels.templates import views
 
-try:
-    from django.template.engine import Engine
-except ImportError:
-    Engine = None
-    from django.template.context import get_standard_processors
 
 # 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/templates/views.py

@@ -6,11 +6,8 @@
 from django.template import TemplateDoesNotExist
 from django.utils.safestring import mark_safe
 
-try:
-    from django.template.engine import Engine
-except ImportError:
-    Engine = None
-    from django.template.loader import find_template_loader
+from debug_toolbar.compat import Engine, find_template_loader
+
 
 def template_source(request):
     """

debug_toolbar/panels/versions.py

@@ -1,19 +1,12 @@
 from __future__ import absolute_import, unicode_literals
 
-try:
-    from importlib import import_module
-except ImportError:  # python 2.6
-    from django.utils.importlib import import_module
 import sys
 
 import django
 from django.conf import settings
 from django.utils.translation import ugettext_lazy as _
-try:
-    from collections import OrderedDict
-except ImportError:
-    from django.utils.datastructures import SortedDict as OrderedDict
 
+from debug_toolbar.compat import import_module, OrderedDict
 from debug_toolbar.panels import Panel
 
 

debug_toolbar/settings.py

@@ -1,14 +1,12 @@
 from __future__ import absolute_import, unicode_literals
 
-try:
-    from importlib import import_module
-except ImportError:  # python 2.6
-    from django.utils.importlib import import_module
 import warnings
 
 from django.conf import settings
 from django.utils import six
 
+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

@@ -4,10 +4,6 @@
 
 from __future__ import absolute_import, unicode_literals
 
-try:
-    from importlib import import_module
-except ImportError:  # python 2.6
-    from django.utils.importlib import import_module
 import uuid
 
 import django
@@ -16,12 +12,9 @@
 from django.core.exceptions import ImproperlyConfigured
 from django.template import TemplateSyntaxError
 from django.template.loader import render_to_string
-try:
-    from collections import OrderedDict
-except ImportError:
-    from django.utils.datastructures import SortedDict as OrderedDict
 
 from debug_toolbar import settings as dt_settings
+from debug_toolbar.compat import import_module, OrderedDict
 
 
 class DebugToolbar(object):

debug_toolbar/utils.py

@@ -1,9 +1,5 @@
 from __future__ import absolute_import, unicode_literals
 
-try:
-    from importlib import import_module
-except ImportError:  # python 2.6
-    from django.utils.importlib import import_module
 import inspect
 import os.path
 import re
@@ -23,6 +19,7 @@
 from django.views.debug import linebreak_iter
 
 from .settings import CONFIG
+from debug_toolbar.compat import import_module
 
 # Figure out some paths
 django_path = os.path.realpath(os.path.dirname(django.__file__))

tests/commands/test_debugsqlshell.py

@@ -4,14 +4,12 @@
 
 from django.contrib.auth.models import User
 from django.core import management
-try:
-    from django.db.backends import utils
-except ImportError:
-    from django.db.backends import util as utils
 from django.test import TestCase
 from django.test.utils import override_settings
 from django.utils import six
 
+from debug_toolbar.compat import utils
+
 
 @override_settings(DEBUG=True)
 class DebugSQLShellTestCase(TestCase):

tests/test_integration.py

@@ -12,16 +12,11 @@
 except ImportError:
     webdriver = None
 
-try:
-    from django.contrib.staticfiles.testing import StaticLiveServerTestCase \
-        as LiveServerTestCase
-except ImportError:
-    # When we're using < Django 1.7
-    from django.test import LiveServerTestCase
 from django.test import RequestFactory, TestCase
 from django.test.utils import override_settings
 from django.utils.unittest import skipIf, skipUnless
 
+from debug_toolbar.compat import LiveServerTestCase
 from debug_toolbar.middleware import DebugToolbarMiddleware, show_toolbar
 
 from .base import BaseTestCase