Pyramid Debugtoolbar

4.12.1 · active · verified Sat Apr 11

Pyramid Debugtoolbar is a package that provides an interactive HTML debugger for Pyramid application development. It offers various panels to inspect requests, responses, SQL queries, templates, and more, significantly aiding in development and debugging. The library is actively maintained, with its latest version 4.12.1 released in February 2024.

Warnings

breaking Older versions of `pyramid_debugtoolbar` (prior to 1.0.8) are not compatible with Pyramid versions 1.5a2 and newer, due to changes in Pyramid's core. Ensure you upgrade `pyramid_debugtoolbar` if you are using a newer Pyramid version.
Fix: Upgrade `pyramid_debugtoolbar` to version 1.0.8 or later when using Pyramid 1.5a2+ (e.g., `pip install 'pyramid_debugtoolbar>=1.0.8'`).
breaking The debug toolbar should NEVER be enabled in a production environment. It allows arbitrary code execution from semi-trusted sources, posing a severe security risk.
Fix: Ensure `pyramid_debugtoolbar` is only included or activated in development/staging environments, typically by managing `pyramid.includes` in environment-specific `.ini` files.
gotcha The toolbar can consume significant memory, especially during long-running tasks, as it captures a large amount of application state for introspection. This can lead to high memory usage or Out-Of-Memory (OOM) errors.
Fix: Consider disabling the toolbar or specific panels for memory-intensive operations. The `debugtoolbar.exclude_routes` or `debugtoolbar.exclude_prefixes` settings can prevent data collection for certain paths.
gotcha When running a Pyramid application over HTTPS, `pyramid_debugtoolbar` might generate HTTP links for its static assets (CSS, JavaScript), leading to mixed content warnings in browsers and potentially broken toolbar functionality.
Fix: You may need to explicitly configure `request.static_url` in your application to force HTTPS, or ensure your proxy/load balancer correctly rewrites schemes for static assets. A workaround involves patching `URLMethodsMixin.static_url` to inject `_scheme='https'` for all static URLs.

Install

pip install pyramid-debugtoolbar Install stable version

Imports

pyramid_debugtoolbar
```
config.include('pyramid_debugtoolbar')
```
The primary way to enable the toolbar is by including it in your Pyramid application's configuration, not a direct Python import for runtime use.

Quickstart

This quickstart demonstrates how to integrate `pyramid_debugtoolbar` into a minimal Pyramid application. The toolbar is enabled by calling `config.include('pyramid_debugtoolbar')` during application setup. Once running, visit `http://localhost:6543` and click the Pyramid logo in the upper right to access debugging information. Alternatively, you can activate it by adding `pyramid_debugtoolbar` to the `pyramid.includes` setting in your application's `.ini` file.

from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response

def hello_world(request):
    return Response('Hello, Debugtoolbar!')

if __name__ == '__main__':
    with Configurator() as config:
        # Include the debug toolbar
        config.include('pyramid_debugtoolbar')

        config.add_route('home', '/')
        config.add_view(hello_world, route_name='home')

        app = config.make_wsgi_app()

    server = make_server('0.0.0.0', 6543, app)
    print('Serving on http://localhost:6543 (debug toolbar enabled)')
    server.serve_forever()

view raw JSON →