aboutsummaryrefslogtreecommitdiffstats
path: root/debug_toolbar/panels
diff options
context:
space:
mode:
authorAymeric Augustin2013-11-24 10:42:43 +0100
committerAymeric Augustin2013-11-24 11:01:44 +0100
commitfe3df822111d3b56000deca354b0bceed7bde9cc (patch)
tree8fe21689037cd975f83e7f70480b96e0ba2e3b6a /debug_toolbar/panels
parent7d24008ac3d70796c1502215c665311d2f21d6fd (diff)
downloaddjango-debug-toolbar-fe3df822111d3b56000deca354b0bceed7bde9cc.tar.bz2
Rename all panels consistently.
Enforce absolute imports to avoid clashing with built-in package names. Thanks Jannis for his feedback.
Diffstat (limited to 'debug_toolbar/panels')
-rw-r--r--debug_toolbar/panels/__init__.py16
-rw-r--r--debug_toolbar/panels/cache.py8
-rw-r--r--debug_toolbar/panels/headers.py10
-rw-r--r--debug_toolbar/panels/logging.py (renamed from debug_toolbar/panels/logger.py)8
-rw-r--r--debug_toolbar/panels/profiling.py6
-rw-r--r--debug_toolbar/panels/redirects.py6
-rw-r--r--debug_toolbar/panels/request.py (renamed from debug_toolbar/panels/request_vars.py)14
-rw-r--r--debug_toolbar/panels/settings.py (renamed from debug_toolbar/panels/settings_vars.py)10
-rw-r--r--debug_toolbar/panels/signals.py6
-rw-r--r--debug_toolbar/panels/sql/__init__.py2
-rw-r--r--debug_toolbar/panels/sql/forms.py2
-rw-r--r--debug_toolbar/panels/sql/panel.py8
-rw-r--r--debug_toolbar/panels/sql/tracking.py2
-rw-r--r--debug_toolbar/panels/sql/utils.py2
-rw-r--r--debug_toolbar/panels/sql/views.py2
-rw-r--r--debug_toolbar/panels/template/__init__.py1
-rw-r--r--debug_toolbar/panels/templates/__init__.py1
-rw-r--r--debug_toolbar/panels/templates/panel.py (renamed from debug_toolbar/panels/template/panel.py)14
-rw-r--r--debug_toolbar/panels/templates/views.py (renamed from debug_toolbar/panels/template/views.py)2
-rw-r--r--debug_toolbar/panels/timer.py8
-rw-r--r--debug_toolbar/panels/versions.py (renamed from debug_toolbar/panels/version.py)10
21 files changed, 74 insertions, 64 deletions
diff --git a/debug_toolbar/panels/__init__.py b/debug_toolbar/panels/__init__.py
index 37d7eb7..1ab500b 100644
--- a/debug_toolbar/panels/__init__.py
+++ b/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 @@ class DebugPanel(object):
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)
diff --git a/debug_toolbar/panels/cache.py b/debug_toolbar/panels/cache.py
index 42e512f..c2808a1 100644
--- a/debug_toolbar/panels/cache.py
+++ b/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.template import Node
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
diff --git a/debug_toolbar/panels/headers.py b/debug_toolbar/panels/headers.py
index 2a41081..3ee499d 100644
--- a/debug_toolbar/panels/headers.py
+++ b/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 @@ class HeaderDebugPanel(DebugPanel):
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({
diff --git a/debug_toolbar/panels/logger.py b/debug_toolbar/panels/logging.py
index 45c995a..a37e000 100644
--- a/debug_toolbar/panels/logger.py
+++ b/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 @@ try:
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 @@ if logbook_supported:
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):
diff --git a/debug_toolbar/panels/profiling.py b/debug_toolbar/panels/profiling.py
index 6192ef9..9443e34 100644
--- a/debug_toolbar/panels/profiling.py
+++ b/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 @@ class FunctionCall(object):
return self._line_stats_text
-class ProfilingDebugPanel(DebugPanel):
+class ProfilingPanel(Panel):
"""
Panel that displays profiling information.
"""
diff --git a/debug_toolbar/panels/redirects.py b/debug_toolbar/panels/redirects.py
index 605dde3..9deeb69 100644
--- a/debug_toolbar/panels/redirects.py
+++ b/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.
"""
diff --git a/debug_toolbar/panels/request_vars.py b/debug_toolbar/panels/request.py
index b5e7070..934946a 100644
--- a/debug_toolbar/panels/request_vars.py
+++ b/debug_toolbar/panels/request.py
@@ -1,27 +1,27 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
from django.core.urlresolvers import resolve
from django.http import Http404
from django.utils.encoding import force_text
from django.utils.translation import ugettext_lazy as _
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
from debug_toolbar.utils import get_name_from_obj
-class RequestVarsDebugPanel(DebugPanel):
+class RequestPanel(Panel):
"""
A panel to display request variables (POST/GET, session, cookies).
"""
- name = 'RequestVars'
- template = 'debug_toolbar/panels/request_vars.html'
+ name = 'Request'
+ template = 'debug_toolbar/panels/request.html'
has_content = True
def nav_title(self):
- return _('Request Vars')
+ return _('Request')
def title(self):
- return _('Request Vars')
+ return _('Request')
def process_response(self, request, response):
self.record_stats({
diff --git a/debug_toolbar/panels/settings_vars.py b/debug_toolbar/panels/settings.py
index 8692394..b7af57d 100644
--- a/debug_toolbar/panels/settings_vars.py
+++ b/debug_toolbar/panels/settings.py
@@ -1,19 +1,19 @@
-from __future__ import unicode_literals
+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.utils.datastructures import SortedDict
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
-class SettingsVarsDebugPanel(DebugPanel):
+class SettingsPanel(Panel):
"""
A panel to display all variables in django.conf.settings
"""
- name = 'SettingsVars'
- template = 'debug_toolbar/panels/settings_vars.html'
+ name = 'Settings'
+ template = 'debug_toolbar/panels/settings.html'
has_content = True
def nav_title(self):
diff --git a/debug_toolbar/panels/signals.py b/debug_toolbar/panels/signals.py
index e9f4f00..74d1faa 100644
--- a/debug_toolbar/panels/signals.py
+++ b/debug_toolbar/panels/signals.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
from django.core.signals import (
request_started, request_finished, got_request_exception)
@@ -10,10 +10,10 @@ from django.dispatch.dispatcher import WEAKREF_TYPES
from django.utils.translation import ugettext_lazy as _, ungettext
from django.utils.importlib import import_module
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
-class SignalDebugPanel(DebugPanel):
+class SignalsPanel(Panel):
name = "Signals"
template = 'debug_toolbar/panels/signals.html'
has_content = True
diff --git a/debug_toolbar/panels/sql/__init__.py b/debug_toolbar/panels/sql/__init__.py
index 90e05cb..88a916e 100644
--- a/debug_toolbar/panels/sql/__init__.py
+++ b/debug_toolbar/panels/sql/__init__.py
@@ -1 +1 @@
-from debug_toolbar.panels.sql.panel import SQLDebugPanel # noqa
+from debug_toolbar.panels.sql.panel import SQLPanel # noqa
diff --git a/debug_toolbar/panels/sql/forms.py b/debug_toolbar/panels/sql/forms.py
index c18be0c..3fdbc25 100644
--- a/debug_toolbar/panels/sql/forms.py
+++ b/debug_toolbar/panels/sql/forms.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
import json
import hashlib
diff --git a/debug_toolbar/panels/sql/panel.py b/debug_toolbar/panels/sql/panel.py
index 84ac992..3bfbe60 100644
--- a/debug_toolbar/panels/sql/panel.py
+++ b/debug_toolbar/panels/sql/panel.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
import uuid
from copy import copy
@@ -7,7 +7,7 @@ from django.conf.urls import patterns, url
from django.db import connections
from django.utils.translation import ugettext_lazy as _, ungettext_lazy as __
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
from debug_toolbar.panels.sql.forms import SQLSelectForm
from debug_toolbar.utils import render_stacktrace
from debug_toolbar.panels.sql.utils import reformat_sql
@@ -44,7 +44,7 @@ def get_transaction_status_display(engine, level):
return choices.get(level)
-class SQLDebugPanel(DebugPanel):
+class SQLPanel(Panel):
"""
Panel that displays information about the SQL queries run while processing
the request.
@@ -54,7 +54,7 @@ class SQLDebugPanel(DebugPanel):
has_content = True
def __init__(self, *args, **kwargs):
- super(SQLDebugPanel, self).__init__(*args, **kwargs)
+ super(SQLPanel, self).__init__(*args, **kwargs)
self._offset = dict((k, len(connections[k].queries)) for k in connections)
self._sql_time = 0
self._num_queries = 0
diff --git a/debug_toolbar/panels/sql/tracking.py b/debug_toolbar/panels/sql/tracking.py
index 989ce3d..d412872 100644
--- a/debug_toolbar/panels/sql/tracking.py
+++ b/debug_toolbar/panels/sql/tracking.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
import sys
diff --git a/debug_toolbar/panels/sql/utils.py b/debug_toolbar/panels/sql/utils.py
index 00728a3..3943168 100644
--- a/debug_toolbar/panels/sql/utils.py
+++ b/debug_toolbar/panels/sql/utils.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
import re
diff --git a/debug_toolbar/panels/sql/views.py b/debug_toolbar/panels/sql/views.py
index 346cf6e..05ad74f 100644
--- a/debug_toolbar/panels/sql/views.py
+++ b/debug_toolbar/panels/sql/views.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
from django.http import HttpResponseBadRequest
from django.shortcuts import render
diff --git a/debug_toolbar/panels/template/__init__.py b/debug_toolbar/panels/template/__init__.py
deleted file mode 100644
index d2f595d..0000000
--- a/debug_toolbar/panels/template/__init__.py
+++ /dev/null
@@ -1 +0,0 @@
-from debug_toolbar.panels.template.panel import TemplateDebugPanel # noqa
diff --git a/debug_toolbar/panels/templates/__init__.py b/debug_toolbar/panels/templates/__init__.py
new file mode 100644
index 0000000..96908e2
--- /dev/null
+++ b/debug_toolbar/panels/templates/__init__.py
@@ -0,0 +1 @@
+from debug_toolbar.panels.templates.panel import TemplatesPanel # noqa
diff --git a/debug_toolbar/panels/template/panel.py b/debug_toolbar/panels/templates/panel.py
index b877a53..c745b83 100644
--- a/debug_toolbar/panels/template/panel.py
+++ b/debug_toolbar/panels/templates/panel.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
from os.path import normpath
from pprint import pformat
@@ -14,7 +14,7 @@ from django.utils.encoding import force_text
from django.utils import six
from django.utils.translation import ugettext_lazy as _
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
from debug_toolbar.panels.sql.tracking import recording, SQLQueryTriggered
# Code taken and adapted from Simon Willison and Django Snippets:
@@ -44,16 +44,16 @@ if django.VERSION[:2] < (1, 7):
Template.__init__ = new_template_init
-class TemplateDebugPanel(DebugPanel):
+class TemplatesPanel(Panel):
"""
A panel that lists all templates used during processing of a response.
"""
- name = 'Template'
+ name = 'Templates'
template = 'debug_toolbar/panels/templates.html'
has_content = True
def __init__(self, *args, **kwargs):
- super(TemplateDebugPanel, self).__init__(*args, **kwargs)
+ super(TemplatesPanel, self).__init__(*args, **kwargs)
self.templates = []
template_rendered.connect(self._store_template_info)
@@ -75,7 +75,7 @@ class TemplateDebugPanel(DebugPanel):
for key, value in context_layer.items():
# Replace any request elements - they have a large
# unicode representation and the request data is
- # already made available from the Request Vars panel.
+ # already made available from the Request panel.
if isinstance(value, http.HttpRequest):
temp_layer[key] = '<<request>>'
# Replace the debugging sql_queries element. The SQL
@@ -115,7 +115,7 @@ class TemplateDebugPanel(DebugPanel):
@classmethod
def get_urls(cls):
- return patterns('debug_toolbar.panels.template.views', # noqa
+ return patterns('debug_toolbar.panels.templates.views', # noqa
url(r'^template_source/$', 'template_source', name='template_source'),
)
diff --git a/debug_toolbar/panels/template/views.py b/debug_toolbar/panels/templates/views.py
index 30bd167..79479d9 100644
--- a/debug_toolbar/panels/template/views.py
+++ b/debug_toolbar/panels/templates/views.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
from django.http import HttpResponseBadRequest
from django.conf import settings
diff --git a/debug_toolbar/panels/timer.py b/debug_toolbar/panels/timer.py
index 9a0fef3..900b624 100644
--- a/debug_toolbar/panels/timer.py
+++ b/debug_toolbar/panels/timer.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
try:
import resource
@@ -7,10 +7,10 @@ except ImportError:
import time
from django.template.loader import render_to_string
from django.utils.translation import ugettext as _
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
-class TimerDebugPanel(DebugPanel):
+class TimerPanel(Panel):
"""
Panel that displays the time a response took in milliseconds.
"""
@@ -59,7 +59,7 @@ class TimerDebugPanel(DebugPanel):
self.record_stats(stats)
def nav_title(self):
- return _('Time')
+ return _('Timer')
def nav_subtitle(self):
stats = self.get_stats()
diff --git a/debug_toolbar/panels/version.py b/debug_toolbar/panels/versions.py
index 87823f3..6028115 100644
--- a/debug_toolbar/panels/version.py
+++ b/debug_toolbar/panels/versions.py
@@ -1,4 +1,4 @@
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
import sys
@@ -8,14 +8,14 @@ from django.utils.translation import ugettext_lazy as _
from django.utils.datastructures import SortedDict
from django.utils.importlib import import_module
-from debug_toolbar.panels import DebugPanel
+from debug_toolbar.panels import Panel
-class VersionDebugPanel(DebugPanel):
+class VersionsPanel(Panel):
"""
- Panel that displays the Django version.
+ Shows versions of Python, Django, and installed apps if possible.
"""
- name = 'Version'
+ name = 'Versions'
template = 'debug_toolbar/panels/versions.html'
has_content = True