Make Panel.panel_id a classmember.

This avoids needing to create an instance of a panel to get its
panel ID.

Author: tim-schilling

debug_toolbar/panels/__init__.py

@@ -1,4 +1,5 @@
 from django.template.loader import render_to_string
+from django.utils.functional import classproperty
 
 from debug_toolbar import settings as dt_settings
 from debug_toolbar.utils import get_name_from_obj
@@ -16,9 +17,9 @@ def __init__(self, toolbar, get_response):
 
     # Private panel properties
 
-    @property
-    def panel_id(self):
-        return self.__class__.__name__
+    @classproperty
+    def panel_id(cls):
+        return cls.__name__
 
     @property
     def enabled(self) -> bool:

debug_toolbar/panels/history/__init__.py

@@ -1,3 +1,3 @@
 from debug_toolbar.panels.history.panel import HistoryPanel
 
-__all__ = ["HistoryPanel"]
+__all__ = [HistoryPanel.panel_id]

debug_toolbar/panels/sql/__init__.py

@@ -1,3 +1,3 @@
 from debug_toolbar.panels.sql.panel import SQLPanel
 
-__all__ = ["SQLPanel"]
+__all__ = [SQLPanel.panel_id]

debug_toolbar/panels/sql/forms.py

@@ -46,14 +46,16 @@ def clean_alias(self):
         return value
 
     def clean(self):
+        from debug_toolbar.panels.sql import SQLPanel
+
         cleaned_data = super().clean()
         toolbar = DebugToolbar.fetch(
-            self.cleaned_data["request_id"], panel_id="SQLPanel"
+            self.cleaned_data["request_id"], panel_id=SQLPanel.panel_id
         )
         if toolbar is None:
             raise ValidationError(_("Data for this panel isn't available anymore."))
 
-        panel = toolbar.get_panel_by_id("SQLPanel")
+        panel = toolbar.get_panel_by_id(SQLPanel.panel_id)
         # Find the query for this form submission
         query = None
         for q in panel.get_stats()["queries"]:

debug_toolbar/panels/templates/__init__.py

@@ -1,3 +1,3 @@
 from debug_toolbar.panels.templates.panel import TemplatesPanel
 
-__all__ = ["TemplatesPanel"]
+__all__ = [TemplatesPanel.panel_id]

docs/changes.rst

@@ -22,7 +22,7 @@ Serializable (don't include in main)
   this id and avoid passing SQL to be executed.
 * Move the formatting logic of SQL queries to just before rendering in
   ``SQLPanel.content``.
-
+* Make ``Panel.panel_id`` a class member.
 
 Pending
 -------

tests/panels/test_cache.py

@@ -1,10 +1,12 @@
 from django.core import cache
 
+from debug_toolbar.panels.cache import CachePanel
+
 from ..base import BaseTestCase
 
 
 class CachePanelTestCase(BaseTestCase):
-    panel_id = "CachePanel"
+    panel_id = CachePanel.panel_id
 
     def test_recording(self):
         self.assertEqual(len(self.panel.calls), 0)

tests/panels/test_history.py

@@ -4,6 +4,7 @@
 from django.test import RequestFactory, override_settings
 from django.urls import resolve, reverse
 
+from debug_toolbar.panels.history import HistoryPanel
 from debug_toolbar.store import get_store
 from debug_toolbar.toolbar import DebugToolbar
 
@@ -14,7 +15,7 @@
 
 
 class HistoryPanelTestCase(BaseTestCase):
-    panel_id = "HistoryPanel"
+    panel_id = HistoryPanel.panel_id
 
     def test_disabled(self):
         config = {"DISABLE_PANELS": {"debug_toolbar.panels.history.HistoryPanel"}}
@@ -93,7 +94,7 @@ def test_history_panel_integration_content(self):
         request_ids = list(store.request_ids())
         self.assertEqual(len(request_ids), 1)
         toolbar = DebugToolbar.fetch(request_ids[0])
-        content = toolbar.get_panel_by_id("HistoryPanel").content
+        content = toolbar.get_panel_by_id(HistoryPanel.panel_id).content
         self.assertIn("bar", content)
         self.assertIn('name="exclude_history" value="True"', content)
 
@@ -131,7 +132,7 @@ def test_history_sidebar_includes_history(self):
         """Validate the history sidebar view."""
         self.client.get("/json_view/")
         panel_keys = copy.copy(self.PANEL_KEYS)
-        panel_keys.add("HistoryPanel")
+        panel_keys.add(HistoryPanel.panel_id)
         request_id = list(get_store().request_ids())[0]
         data = {"request_id": request_id}
         response = self.client.get(reverse("djdt:history_sidebar"), data=data)

tests/panels/test_profiling.py

@@ -3,6 +3,8 @@
 from django.http import HttpResponse
 from django.test.utils import override_settings
 
+from debug_toolbar.panels.profiling import ProfilingPanel
+
 from ..base import BaseTestCase, IntegrationTestCase
 from ..views import listcomp_view, regular_view
 
@@ -11,7 +13,7 @@
     DEBUG_TOOLBAR_PANELS=["debug_toolbar.panels.profiling.ProfilingPanel"]
 )
 class ProfilingPanelTestCase(BaseTestCase):
-    panel_id = "ProfilingPanel"
+    panel_id = ProfilingPanel.panel_id
 
     def test_regular_view(self):
         self._get_response = lambda request: regular_view(request, "profiling")

tests/panels/test_redirects.py

@@ -3,11 +3,13 @@
 from django.conf import settings
 from django.http import HttpResponse
 
+from debug_toolbar.panels.redirects import RedirectsPanel
+
 from ..base import BaseTestCase
 
 
 class RedirectsPanelTestCase(BaseTestCase):
-    panel_id = "RedirectsPanel"
+    panel_id = RedirectsPanel.panel_id
 
     def test_regular_response(self):
         not_redirect = HttpResponse()