Update all panels to follow the public API.

Author: aaugustin

debug_toolbar/panels/cache.py

@@ -131,9 +131,7 @@ class CachePanel(Panel):
     """
     Panel that displays the cache statistics.
     """
-    name = 'Cache'
     template = 'debug_toolbar/panels/cache.html'
-    has_content = True
 
     def __init__(self, *args, **kwargs):
         super(CachePanel, self).__init__(*args, **kwargs)
@@ -183,16 +181,19 @@ def _store_call_info(self, sender, name=None, time_taken=0,
             'backend': backend
         })
 
-    def nav_title(self):
-        return _('Cache')
+    # Implement the Panel API
 
+    nav_title = _('Cache')
+
+    @property
     def nav_subtitle(self):
         cache_calls = len(self.calls)
         return ungettext('%(cache_calls)d call in %(time).2fms',
                          '%(cache_calls)d calls in %(time).2fms',
                          cache_calls) % {'cache_calls': cache_calls,
                                          'time': self.total_time}
 
+    @property
     def title(self):
         count = len(getattr(settings, 'CACHES', ['default']))
         return ungettext('Cache calls from %(count)d backend',

debug_toolbar/panels/headers.py

@@ -12,11 +12,8 @@ class HeadersPanel(Panel):
     """
     A panel to display HTTP headers.
     """
-    name = 'Headers'
-    template = 'debug_toolbar/panels/headers.html'
-    has_content = True
     # List of environment variables we want to display
-    environ_filter = set((
+    ENVIRON_FILTER = set((
         'CONTENT_LENGTH',
         'CONTENT_TYPE',
         'DJANGO_SETTINGS_MODULE',
@@ -35,11 +32,9 @@ class HeadersPanel(Panel):
         'TZ',
     ))
 
-    def nav_title(self):
-        return _('Headers')
+    title = _('Headers')
 
-    def title(self):
-        return _('Headers')
+    template = 'debug_toolbar/panels/headers.html'
 
     def process_request(self, request):
         wsgi_env = list(sorted(request.META.items()))
@@ -48,7 +43,7 @@ def process_request(self, request):
         if 'Cookie' in self.request_headers:
             self.request_headers['Cookie'] = '=> see Request panel'
         self.environ = OrderedDict(
-            (k, v) for (k, v) in wsgi_env if k in self.environ_filter)
+            (k, v) for (k, v) in wsgi_env if k in self.ENVIRON_FILTER)
         self.record_stats({
             'request_headers': self.request_headers,
             'environ': self.environ,

debug_toolbar/panels/logging.py

@@ -105,35 +105,28 @@ def emit(self, record):
 
 
 class LoggingPanel(Panel):
-    name = 'Logging'
     template = 'debug_toolbar/panels/logging.html'
-    has_content = True
 
     def __init__(self, *args, **kwargs):
         super(LoggingPanel, self).__init__(*args, **kwargs)
         self._records = {}
 
-    def process_request(self, request):
-        collector.clear_records()
-
-    def process_response(self, request, response):
-        records = self.get_and_delete()
-        self.record_stats({'records': records})
-
-    def get_and_delete(self):
-        records = collector.get_records()
-        self._records[threading.currentThread()] = records
-        collector.clear_records()
-        return records
-
-    def nav_title(self):
-        return _("Logging")
+    nav_title = _("Logging")
 
+    @property
     def nav_subtitle(self):
         records = self._records[threading.currentThread()]
         record_count = len(records)
         return ungettext('%(count)s message', '%(count)s messages',
                          record_count) % {'count': record_count}
 
-    def title(self):
-        return _('Log Messages')
+    title = _('Log Messages')
+
+    def process_request(self, request):
+        collector.clear_records()
+
+    def process_response(self, request, response):
+        records = collector.get_records()
+        self._records[threading.currentThread()] = records
+        collector.clear_records()
+        self.record_stats({'records': records})

debug_toolbar/panels/profiling.py

@@ -144,15 +144,9 @@ class ProfilingPanel(Panel):
     """
     Panel that displays profiling information.
     """
-    name = 'Profiling'
-    template = 'debug_toolbar/panels/profiling.html'
-    has_content = True
-
-    def nav_title(self):
-        return _('Profiling')
+    title = _('Profiling')
 
-    def title(self):
-        return _('Profiling')
+    template = 'debug_toolbar/panels/profiling.html'
 
     def _unwrap_closure_and_profile(self, func):
         if not hasattr(func, '__code__'):

debug_toolbar/panels/redirects.py

@@ -2,7 +2,7 @@
 
 from django.core.handlers.wsgi import STATUS_CODE_TEXT
 from django.shortcuts import render
-from django.utils.translation import ugettext as _
+from django.utils.translation import ugettext_lazy as _
 
 from debug_toolbar.panels import Panel
 
@@ -11,15 +11,16 @@ class RedirectsPanel(Panel):
     """
     Panel that intercepts redirects and displays a page with debug info.
     """
-    name = 'Redirects'
-
-    has_content = False
 
     @property
     def enabled(self):
         default = 'on' if self.toolbar.config['INTERCEPT_REDIRECTS'] else 'off'
         return self.toolbar.request.COOKIES.get('djdt' + self.panel_id, default) == 'on'
 
+    has_content = False
+
+    nav_title = _('Intercept redirects')
+
     def process_response(self, request, response):
         if 300 <= int(response.status_code) < 400:
             redirect_to = response.get('Location', None)
@@ -36,5 +37,3 @@ def process_response(self, request, response):
                 response.cookies = cookies
         return response
 
-    def nav_title(self):
-        return _('Intercept redirects')

debug_toolbar/panels/request.py

@@ -13,15 +13,9 @@ class RequestPanel(Panel):
     """
     A panel to display request variables (POST/GET, session, cookies).
     """
-    name = 'Request'
     template = 'debug_toolbar/panels/request.html'
-    has_content = True
 
-    def nav_title(self):
-        return _('Request')
-
-    def title(self):
-        return _('Request')
+    title = _('Request')
 
     def process_response(self, request, response):
         self.record_stats({

debug_toolbar/panels/settings.py

@@ -12,12 +12,9 @@ class SettingsPanel(Panel):
     """
     A panel to display all variables in django.conf.settings
     """
-    name = 'Settings'
     template = 'debug_toolbar/panels/settings.html'
-    has_content = True
 
-    def nav_title(self):
-        return _('Settings')
+    nav_title = _('Settings')
 
     def title(self):
         return _('Settings from <code>%s</code>') % settings.SETTINGS_MODULE

debug_toolbar/panels/signals.py

@@ -14,9 +14,7 @@
 
 
 class SignalsPanel(Panel):
-    name = "Signals"
     template = 'debug_toolbar/panels/signals.html'
-    has_content = True
 
     SIGNALS = {
         'request_started': request_started,
@@ -33,9 +31,6 @@ class SignalsPanel(Panel):
         'post_syncdb': post_syncdb,
     }
 
-    def nav_title(self):
-        return _("Signals")
-
     def nav_subtitle(self):
         signals = self.get_stats()['signals']
         num_receivers = sum(len(s[2]) for s in signals)
@@ -51,8 +46,7 @@ def nav_subtitle(self):
                          num_receivers) % {'num_receivers': num_receivers,
                                            'num_signals': num_signals}
 
-    def title(self):
-        return _("Signals")
+    title = _("Signals")
 
     @property
     def signals(self):

debug_toolbar/panels/sql/panel.py

@@ -49,10 +49,6 @@ class SQLPanel(Panel):
     Panel that displays information about the SQL queries run while processing
     the request.
     """
-    name = 'SQL'
-    template = 'debug_toolbar/panels/sql.html'
-    has_content = True
-
     def __init__(self, *args, **kwargs):
         super(SQLPanel, self).__init__(*args, **kwargs)
         self._offset = dict((k, len(connections[k].queries)) for k in connections)
@@ -104,26 +100,31 @@ def record(self, alias, **kwargs):
         self._sql_time += kwargs['duration']
         self._num_queries += 1
 
-    @classmethod
-    def get_urls(cls):
-        return patterns('debug_toolbar.panels.sql.views',               # noqa
-            url(r'^sql_select/$', 'sql_select', name='sql_select'),
-            url(r'^sql_explain/$', 'sql_explain', name='sql_explain'),
-            url(r'^sql_profile/$', 'sql_profile', name='sql_profile'),
-        )
+    # Implement the Panel API
 
-    def nav_title(self):
-        return _('SQL')
+    nav_title = _('SQL')
 
+    @property
     def nav_subtitle(self):
         return __("%d query in %.2fms", "%d queries in %.2fms",
                   self._num_queries) % (self._num_queries, self._sql_time)
 
+    @property
     def title(self):
         count = len(self._databases)
-        return __('SQL Queries from %(count)d connection',
-                  'SQL Queries from %(count)d connections',
-                  count) % dict(count=count)
+        return __('SQL queries from %(count)d connection',
+                  'SQL queries from %(count)d connections',
+                  count) % {'count': count}
+
+    template = 'debug_toolbar/panels/sql.html'
+
+    @classmethod
+    def get_urls(cls):
+        return patterns('debug_toolbar.panels.sql.views',               # noqa
+            url(r'^sql_select/$', 'sql_select', name='sql_select'),
+            url(r'^sql_explain/$', 'sql_explain', name='sql_explain'),
+            url(r'^sql_profile/$', 'sql_profile', name='sql_profile'),
+        )
 
     def enable_instrumentation(self):
         # This is thread-safe because database connections are thread-local.

debug_toolbar/panels/templates/panel.py

@@ -48,10 +48,6 @@ class TemplatesPanel(Panel):
     """
     A panel that lists all templates used during processing of a response.
     """
-    name = 'Templates'
-    template = 'debug_toolbar/panels/templates.html'
-    has_content = True
-
     def __init__(self, *args, **kwargs):
         super(TemplatesPanel, self).__init__(*args, **kwargs)
         self.templates = []
@@ -113,19 +109,23 @@ def _store_template_info(self, sender, **kwargs):
         kwargs['context'] = [force_text(item) for item in context_list]
         self.templates.append(kwargs)
 
-    @classmethod
-    def get_urls(cls):
-        return patterns('debug_toolbar.panels.templates.views',         # noqa
-            url(r'^template_source/$', 'template_source', name='template_source'),
-        )
+    # Implement the Panel API
 
-    def nav_title(self):
-        return _('Templates')
+    nav_title = _('Templates')
 
+    @property
     def title(self):
         num_templates = len(self.templates)
         return _('Templates (%(num_templates)s rendered)') % {'num_templates': num_templates}
 
+    template = 'debug_toolbar/panels/templates.html'
+
+    @classmethod
+    def get_urls(cls):
+        return patterns('debug_toolbar.panels.templates.views',         # noqa
+            url(r'^template_source/$', 'template_source', name='template_source'),
+        )
+
     def process_response(self, request, response):
         context_processors = dict(
             [