debug_toolbar/panels/__init__.py


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

from django.template.defaultfilters import slugify
from debug_toolbar.middleware import DebugToolbarMiddleware


class DebugPanel(object):
    """
    Base class for debug panels.
    """
    # name = Base
    has_content = False # If content returns something, set to true in subclass
    
    # We'll maintain a local context instance so we can expose our template
    # context variables to panels which need them:
    context = {}
    
    # Panel methods
    def __init__(self, context={}):
        self.context.update(context)
        self.toolbar = DebugToolbarMiddleware.get_current()
        self.slug = slugify(self.name)
    
    def dom_id(self):
        return 'djDebug%sPanel' % (self.name.replace(' ', ''))
    
    def nav_title(self):
        """Title showing in toolbar"""
        raise NotImplementedError
    
    def nav_subtitle(self):
        """Subtitle showing until title in toolbar"""
        return ''
    
    def title(self):
        """Title showing in panel"""
        raise NotImplementedError
    
    def url(self):
        raise NotImplementedError
    
    def content(self):
        raise NotImplementedError
    
    def record_stats(self, stats):
        panel_stats = self.toolbar.stats.get(self.slug)
        if panel_stats:
            panel_stats.update(stats)
        else:
            self.toolbar.stats[self.slug] = stats
    
    def get_stats(self):
        return self.toolbar.stats.get(self.slug, {})
    
    # Standard middleware methods
    def process_request(self, request):
        pass
    
    def process_view(self, request, view_func, view_args, view_kwargs):
        pass
    
    def process_response(self, request, response):
        pass