Rename all panels consistently.

Enforce absolute imports to avoid clashing with built-in package names.

Thanks Jannis for his feedback.

Author: aaugustin

debug_toolbar/__init__.py

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

debug_toolbar/management/commands/debugsqlshell.py

@@ -1,4 +1,4 @@
-from __future__ import print_function, unicode_literals
+from __future__ import absolute_import, print_function, unicode_literals
 
 from time import time
 

debug_toolbar/middleware.py

@@ -2,7 +2,7 @@
 Debug Toolbar middleware
 """
 
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
 
 import threading
 

debug_toolbar/models.py

@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
 
 from django.conf import settings
 from django.conf.urls import include, patterns, url

debug_toolbar/panels/__init__.py

@@ -1,12 +1,14 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
+
+import warnings
 
 from django.template.defaultfilters import slugify
 from django.template.loader import render_to_string
 
 
-class DebugPanel(object):
+class Panel(object):
     """
-    Base class for debug panels.
+    Base class for panels.
     """
     # name = 'Base'
     # template = 'debug_toolbar/panels/base.html'
@@ -89,3 +91,11 @@ def process_view(self, request, view_func, view_args, view_kwargs):
 
     def process_response(self, request, response):
         pass
+
+
+# Backward-compatibility for 1.0, remove in 2.0.
+class DebugPanel(Panel):
+
+    def __init__(self, *args, **kwargs):
+        warnings.warn("DebugPanel was renamed to Panel.", DeprecationWarning)
+        super(DebugPanel, self).__init__(*args, **kwargs)

debug_toolbar/panels/cache.py

@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
 
 import inspect
 import sys
@@ -13,7 +13,7 @@
 from django.utils.datastructures import SortedDict
 from django.utils.translation import ugettext_lazy as _, ungettext
 
-from debug_toolbar.panels import DebugPanel
+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
@@ -127,7 +127,7 @@ def get_cache(*args, **kwargs):
     return CacheStatTracker(original_get_cache(*args, **kwargs))
 
 
-class CacheDebugPanel(DebugPanel):
+class CachePanel(Panel):
     """
     Panel that displays the cache statistics.
     """
@@ -136,7 +136,7 @@ class CacheDebugPanel(DebugPanel):
     has_content = True
 
     def __init__(self, *args, **kwargs):
-        super(CacheDebugPanel, self).__init__(*args, **kwargs)
+        super(CachePanel, self).__init__(*args, **kwargs)
         self.total_time = 0
         self.hits = 0
         self.misses = 0

debug_toolbar/panels/headers.py

@@ -1,18 +1,18 @@
-from __future__ import unicode_literals
+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.panels import DebugPanel
+from debug_toolbar.panels import Panel
 
 
-class HeaderDebugPanel(DebugPanel):
+class HeadersPanel(Panel):
     """
     A panel to display HTTP headers.
     """
-    name = 'Header'
+    name = 'Headers'
     template = 'debug_toolbar/panels/headers.html'
     has_content = True
     # List of environment variables we want to display
@@ -46,7 +46,7 @@ def process_request(self, request):
         self.request_headers = OrderedDict(
             (unmangle(k), v) for (k, v) in wsgi_env if k.startswith('HTTP_'))
         if 'Cookie' in self.request_headers:
-            self.request_headers['Cookie'] = '=> see Request Vars panel'
+            self.request_headers['Cookie'] = '=> see Request panel'
         self.environ = OrderedDict(
             (k, v) for (k, v) in wsgi_env if k in self.environ_filter)
         self.record_stats({

debug_toolbar/panels/logger.py renamed to debug_toolbar/panels/logging.py

@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
 
 import datetime
 import logging
@@ -7,7 +7,7 @@
 except ImportError:
     threading = None
 from django.utils.translation import ungettext, ugettext_lazy as _
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
 
 MESSAGE_IF_STRING_REPRESENTATION_INVALID = '[Could not get log message]'
 
@@ -104,9 +104,9 @@ def emit(self, record):
     logbook_handler.push_application()  # register with logbook
 
 
-class LoggingPanel(DebugPanel):
+class LoggingPanel(Panel):
     name = 'Logging'
-    template = 'debug_toolbar/panels/logger.html'
+    template = 'debug_toolbar/panels/logging.html'
     has_content = True
 
     def __init__(self, *args, **kwargs):

debug_toolbar/panels/profiling.py

@@ -1,9 +1,9 @@
-from __future__ import division, unicode_literals
+from __future__ import absolute_import, division, unicode_literals
 
 from django.utils.translation import ugettext_lazy as _
 from django.utils.safestring import mark_safe
 from django.utils.six.moves import cStringIO
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
 
 try:
     from line_profiler import LineProfiler, show_func
@@ -140,7 +140,7 @@ def line_stats_text(self):
         return self._line_stats_text
 
 
-class ProfilingDebugPanel(DebugPanel):
+class ProfilingPanel(Panel):
     """
     Panel that displays profiling information.
     """

debug_toolbar/panels/redirects.py

@@ -1,13 +1,13 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
 
 from django.core.handlers.wsgi import STATUS_CODE_TEXT
 from django.shortcuts import render
 from django.utils.translation import ugettext as _
 
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
 
 
-class InterceptRedirectsPanel(DebugPanel):
+class RedirectsPanel(Panel):
     """
     Panel that intercepts redirects and displays a page with debug info.
     """