Initial commit

Author: node13h

.gitignore

@@ -0,0 +1,3 @@
+*.pyc
+django_debug_toolbar_template_profiler.egg-info
+dist

LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014, Sergej Alikov
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of the FreeBSD Project.

MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.rst
+recursive-include template_profiler_panel/templates *

README.rst

@@ -0,0 +1,21 @@
+Django Debug Toolbar Template Profiler
+======================================
+
+This panel displays template time spent rendering each template and
+graphical respresentation on the timeline (see screenshot)
+
+
+Install
+=======
+
+- Add 'template_profiler_panel.panels.template.TemplateProfilerPanel' to
+  DEBUG_TOOLBAR_PANELS in your settings.py (see
+  http://django-debug-toolbar.readthedocs.org/en/latest/configuration.html#debug-toolbar-panels)
+
+- Add 'template_profiler_panel' to INSTALLED_APPS
+
+
+Screenshot
+==========
+.. image:: screenshot.png
+

screenshot.png

@@ -0,0 +1,32 @@
+from setuptools import setup, find_packages
+from io import open
+
+setup(
+    name='django-debug-toolbar-template-profiler',
+    version='1.0.0',
+    description='Displays template rendering time on the timeline',
+    long_description=open('README.rst', encoding='utf-8').read(),
+    author='Sergej Alikov',
+    author_email='[email protected]',
+    url='https://github.com/node13h/django-debug-toolbartemplate-profiler',
+    download_url='https://pypi.python.org/pypi/django-debug-toolbar-template-profiler',
+    license='Simplified BSD License',
+    packages=find_packages(),
+    install_requires=[
+        'django-debug-toolbar>=1.0',
+    ],
+    include_package_data=True,
+    zip_safe=False,                 # because we're including static files
+    classifiers=[
+        'Development Status :: 5 - Production/Stable',
+        'Environment :: Web Environment',
+        'Framework :: Django',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+    ],
+)

setup.py

@@ -0,0 +1,143 @@
+from time import time
+from collections import defaultdict
+from inspect import stack
+
+from django.dispatch import Signal
+from django.template import Template
+from django.utils.translation import ugettext_lazy as _
+
+from debug_toolbar.panels import Panel
+
+
+def dummy_color_generator():
+    while True:
+        yield '#bbbbbb'
+
+# Contrasting_color_generator is available since debug toolbar version 1.1.
+try:
+    from debug_toolbar.panels.sql.utils import contrasting_color_generator
+except ImportError:
+    # Support older versions of debug toolbar
+    contrasting_color_generator = dummy_color_generator
+
+template_rendered = Signal(
+    providing_args=['instance', 'start', 'end', 'level'])
+
+
+def template_render_wrapper(self, context):
+    result = None
+    if hasattr(Template, 'tp_saved_render'):
+        t_start = time()
+        try:
+            result = Template.tp_saved_render(self, context)
+        finally:
+            t_end = time()
+
+            template_rendered.send(
+                sender=Template, instance=self, start=t_start, end=t_end,
+                level=len(stack()))
+
+    return result
+
+# Wrap the original Template.render
+if not hasattr(Template, 'tp_saved_render'):
+    Template.tp_saved_render = Template.render
+    Template.render = template_render_wrapper
+
+
+class TemplateProfilerPanel(Panel):
+    '''
+    Displays template rendering times on the request timeline
+    '''
+
+    template = 'template_profiler_panel/template.html'
+    colors = None
+    templates = None
+    color_generator = None
+    t_min = 0
+    t_max = 0
+    total = 0
+
+    def __init__(self, *args, **kwargs):
+        self.colors = {}
+        self.templates = []
+        self.color_generator = contrasting_color_generator()
+        return super(TemplateProfilerPanel, self).__init__(*args, **kwargs)
+
+    @property
+    def nav_title(self):
+        return _('Template Profiler')
+
+    @property
+    def nav_subtitle(self):
+        return _('{} calls in {:.2f} ms').format(
+            self.total, (self.t_max - self.t_min) * 1000.0)
+
+    @property
+    def title(self):
+        return _('Template Rendering Time')
+
+    def _get_color(self, level):
+        return self.colors.setdefault(level, next(self.color_generator))
+
+    def record(self, sender, instance, start, end, level, **kwargs):
+
+        bg = self._get_color(level)
+        text = '#ffffff' if int(bg[1:], 16) < 0x8fffff else '#000000'
+        color = {'bg': bg, 'text': text}
+
+        self.templates.append({
+            'start': start,
+            'end': end,
+            'time': (end - start) * 1000.0,
+            'level': level,
+            'name': instance.name,
+            'color': color,
+        })
+
+    def enable_instrumentation(self):
+        template_rendered.connect(self.record)
+
+    def disable_instrumentation(self):
+        template_rendered.disconnect(self.record)
+
+    def _calc_p(self, part, whole):
+        return (part / whole) * 100.0
+
+    def _calc_timeline(self, start, end):
+        result = {}
+        result['offset_p'] = self._calc_p(
+            start - self.t_min, self.t_max - self.t_min)
+
+        result['duration_p'] = self._calc_p(
+            end - start, self.t_max - self.t_min)
+
+        result['rel_duration_p'] = self._calc_p(
+            result['duration_p'], 100 - result['offset_p'])
+
+        return result
+
+    def process_response(self, request, response):
+        summary = defaultdict(float)
+
+        # Collect stats
+        for template in self.templates:
+            if self.t_min == 0:
+                self.t_min = template['start']
+            elif template['start'] < self.t_min:
+                self.t_min = template['start']
+
+            if template['end'] > self.t_max:
+                self.t_max = template['end']
+
+            summary[template['name']] += template['time']
+
+        # Calc timelines
+        for template in self.templates:
+            template.update(
+                self._calc_timeline(template['start'], template['end']))
+
+        self.total = len(self.templates)
+
+        self.record_stats(
+            {'templates': self.templates, 'summary': dict(summary)})