https://github.com/dmclain/django-debug-toolbar-line-profiler

https://github.com/dmclain/django-debug-toolbar-line-profiler

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dmclain/django-debug-toolbar-line-profiler
• Owner: dmclain
• License: other
• Created: 2013-11-27T20:35:14.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2020-08-19T12:23:41.000Z (over 4 years ago)
• Last Synced: 2024-10-13T21:51:39.716Z (2 months ago)
• Language: Python
• Size: 24.4 KB
• Stars: 64
• Watchers: 1
• Forks: 20
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=======================================

Django Debug Toolbar Line Profile Panel

=======================================

The `Django Debug Toolbar 

`_ is a configurable set of panels that display various

debug information about the current request/response and when clicked, display

more details about the panel's content.

This package provides a panel that incorporates output from line_profiler_

The stock line_profiler is only compatible with the 2.x branch of python

but a patched version for Python 3 can be installed with::

    pip install cython

    pip install -e hg+https://bitbucket.org/kmike/line_profiler@7999f21#egg=line_profiler

(cf. http://stackoverflow.com/questions/6273139/profiling-by-line-with-python-3)

This panel will only function with django_debug_toolbar>=1.0, before that it's functionality

was contained in the debug_toolbar.panels.profiling.ProfilingPanel.

This Django Debug Toolbar panel is released under the BSD license, like Django

and the Django Debug Toolbar. If you like it, please consider contributing!

The Django Debug Toolbar was originally created by Rob Hudson

in August 2008 and was further developed by many contributors.

.. _line_profiler: http://pythonhosted.org/line_profiler/

Installation

============

To install the line_profiler panel, first install this package with ``pip install django-debug-toolbar-line-profiler``, then add debug_toolbar_line_profiler to the INSTALLED_APPS::

    INSTALLED_APPS = (

        ...

        'debug_toolbar_line_profiler',

    )

and add the panel to DEBUG_TOOLBAR_PANELS::

    DEBUG_TOOLBAR_PANELS = (

        ...

        'debug_toolbar_line_profiler.panel.ProfilingPanel',

    )

Configuration

=============

By default, the panel will profile your view function. If you use class based views

the panel will profile all functions on the class that don't start with _. If you

want additional code to be profiled, add the @profile_additional decorator like so::

    from debug_toolbar_line_profiler import profile_additional

    from boto.s3.connection import S3Connection

    

    ...

    

    @profile_additional(S3Connection.make_request)

    def your_view_code(*args, **kwargs):

        ...

Signals

=======

There is also a signal (debug_toolbar_line_profiler.signals.profiler_setup) that

you can attach to for integrating class based views like django rest framework.

Here is an example::

    from rest_framework.viewsets import ViewSet

    from rest_framework.response import Response

    from debug_toolbar_line_profiler import signals

    class AViewSet(ViewSet):

        def list(self, request):

            return Response([])

        def retrieve(self, request, pk=None):

            return Response({})

    def register_profile_views(sender, profiler, **kwargs):

        profiler.add_function(AViewSet.list)

        profiler.add_function(AViewSet.retrieve)

    signals.profiler_setup.connect(register_profile_views,

                                   dispatch_uid='register_profile_views')