- Author:
- felix_the_third
- Posted:
- January 18, 2010
- Language:
- Python
- Version:
- 1.1
- Score:
- 1 (after 1 ratings)
Adds a hidden footer to the bottom of every text/html page containing a list of SQL queries executed, the view function that was used and all templates that were loaded.
Each template path is a clickable URL of the type txmt://open/?url=file://FILENAME&line=LINENO as is the view function.
This lets you open the file very quickly in TextMate which speeds up development considerably and relieves the mind of much fetching-lookup tedium.
This version works on SVN 12002 (1.2 alpha) and earlier. The previous version was: http://www.djangosnippets.org/snippets/1033/ which got caught but some edge case in certain modules. It is based on the original by Simon http://www.djangosnippets.org/snippets/766/
To use save this as 'debug_middleware.py' somewhere on your PYTHONPATH and add 'debug_middleware.DebugFooter' to your MIDDLEWARE_CLASSES setting.
- Felix (the Third) hey wouldn't it be great if you could retrieve your password on djangosnippets ? somebody should volunteer to upgrade it
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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | import time
from django.test.signals import template_rendered
from django.conf import settings
from django.db import connection
from django.utils.encoding import force_unicode
from django.utils.safestring import mark_safe
TEMPLATE = """
<div id="debug" style="clear:both;">
<a href="#debugbox"
onclick="this.style.display = 'none';
document.getElementById('debugbox').style.display = 'block';
return false;"
style="font-size: small; color: red; text-decoration: none; display: block; margin: 12px;"
>+</a>
<div style="display: none;clear: both; border: 1px solid red; padding: 12px; margin: 12px; overflow: scroll; white-space: wrap;" id="debugbox">
<p>Server-time taken: {{ server_time|floatformat:"5" }} seconds</p>
<p>View: <strong>{{view}}</strong></p>
<p>Templates used:</p>
{% if templates %}
<ol>
{% for template in templates %}
<li><strong>{{ template.0 }}</strong> loaded from <samp>{{ template.1 }}</samp></li>
{% endfor %}
</ol>
{% else %}
None
{% endif %}
<p>Template path:</p>
{% if template_dirs %}
<ol>
{% for template in template_dirs %}
<li>{{ template }}</li>
{% endfor %}
</ol>
{% else %}
<ul><li>None</li></ul>
{% endif %}
<p>SQL executed:</p>
{% if sql %}
<ol>
{% for query in sql %}
<li{{ query.style }}>{{ query.sql|linebreaksbr }}
<p>took {{ query.time|floatformat:"3" }} seconds</p>{{ query.count }}</li>
{% endfor %}
</ol>
<p>Total SQL time: {{ sql_total }} in {{num_queries}} queries</p>
{% else %}
None
{% endif %}
</div>
</div>
</body>
"""
# Monkeypatch instrumented test renderer from django.test.utils - we could use
# django.test.utils.setup_test_environment for this but that would also set up
# e-mail interception, which we don't want
from django.test.utils import instrumented_test_render
from django.template import Template, Context
if Template.render != instrumented_test_render:
Template.original_render = Template.render
Template.render = instrumented_test_render
# MONSTER monkey-patch
old_template_init = Template.__init__
def new_template_init(self, template_string, origin=None, name='<Unknown Template>'):
old_template_init(self, template_string, origin, name)
self.origin = origin
Template.__init__ = new_template_init
class DebugFooter:
def process_request(self, request):
self.time_started = time.time()
self.templates_used = []
self.contexts_used = []
self.sql_offset_start = len(connection.queries)
template_rendered.connect(self._storeRenderedTemplates)
def process_response(self, request, response):
# Only include debug info for text/html pages not accessed via Ajax
if 'text/html' not in response['Content-Type']:
return response
if request.is_ajax():
return response
if not settings.DEBUG:
return response
if response.status_code != 200:
return response
templates = []
for t in self.templates_used:
if t.origin and t.origin.name:
templates.append( (t.name, _txtmate(t.origin.name,t.origin.name) ) )
else:
templates.append( (t.name, "no origin") )
sql_queries = connection.queries[self.sql_offset_start:]
# Reformat sql queries a bit
sql_total = 0.0
sql_counts = {}
for query in sql_queries:
raw_sql = query['sql']
query['sql'] = reformat_sql(query['sql'])
sql_total += float(query['time'])
count = sql_counts.get(raw_sql,0) + 1
sql_counts[raw_sql] = count
if count > 1:
query['style'] = mark_safe(' style="background:#ff0000;"')
query['count'] = mark_safe('<p>duplicate query count=%s</p>' % count)
else:
query['style'] = ''
query['count'] = ''
from django.core.urlresolvers import resolve
view_func, args, kwargs = resolve(request.META['PATH_INFO']) #@UnusedVariable
view = '%s.%s' % (view_func.__module__, view_func.__name__)
vf = view_func
breaker = 10
while not hasattr(vf,'func_code'):
if hasattr(vf,'view_func'):
vf = vf.view_func
else:
break # somethings wrong about the assumptions of the decorator
breaker = breaker - 1
if breaker < 0:
break
if hasattr(vf,'func_code'):
co = vf.func_code
filename = co.co_filename
lineno = co.co_firstlineno
view = _txtmate(co.co_filename,view,co.co_firstlineno)
debug_content = Template(TEMPLATE).render(Context({
'server_time': time.time() - self.time_started,
'templates': templates,
'sql': sql_queries,
'sql_total': sql_total,
'num_queries' : len(sql_queries),
'template_dirs': settings.TEMPLATE_DIRS,
'view': view
}))
content = response.content
response.content = force_unicode(content).replace('</body>', debug_content)
return response
def _storeRenderedTemplates(self, **kwargs):
#signal=signal, sender=sender, template=template, context=context):
template = kwargs.get('template')
if(template):
self.templates_used.append(template)
context = kwargs.get('context')
if(context):
self.contexts_used.append(context)
def reformat_sql(sql):
sql = sql.replace('`,`', '`, `')
sql = sql.replace('` FROM `', '` \n FROM `')
sql = sql.replace('` WHERE ', '` \n WHERE ')
sql = sql.replace(' ORDER BY ', ' \n ORDER BY ')
return sql
def _txtmate(path,name,lineno=""):
return mark_safe("<a href='txmt://open/?url=file://%s&line=%s'>%s</a>" % (path,lineno,name))
|
More like this
- Template tag - list punctuation for a list of items by shapiromatron 9 months ago
- JSONRequestMiddleware adds a .json() method to your HttpRequests by cdcarter 9 months, 1 week ago
- Serializer factory with Django Rest Framework by julio 1 year, 4 months ago
- Image compression before saving the new model / work with JPG, PNG by Schleidens 1 year, 4 months ago
- Help text hyperlinks by sa2812 1 year, 5 months ago
Comments
that's fantastically useful, thanks!
#
Please login first before commenting.