debug_toolbar.litestar.config

Litestar-specific configuration for the debug toolbar.

Classes

LitestarDebugToolbarConfig([enabled, ...])

Litestar-specific configuration for the debug toolbar.

class debug_toolbar.litestar.config.LitestarDebugToolbarConfig(enabled=True, panels=<factory>, intercept_redirects=False, show_toolbar_callback=None, insert_before='</body>', max_request_history=50, api_path='/_debug_toolbar', static_path='/_debug_toolbar/static', allowed_hosts=<factory>, extra_panels=<factory>, exclude_panels=<factory>, memory_backend='auto', panel_display_depth=10, panel_display_max_items=100, panel_display_max_string=1000, async_profiler_backend='auto', async_blocking_threshold_ms=100.0, async_enable_blocking_detection=True, async_enable_event_loop_monitoring=True, async_event_loop_lag_threshold_ms=10.0, async_capture_task_stacks=True, async_max_stack_depth=10, websocket_tracking_enabled=True, websocket_max_connections=50, websocket_max_messages_per_connection=100, websocket_max_message_size=10240, websocket_connection_ttl=3600, storage=None, exclude_paths=<factory>, exclude_patterns=<factory>, show_on_errors=True)

Litestar-specific configuration for the debug toolbar.

Extends the base configuration with Litestar-specific options.

exclude_paths

URL paths to exclude from toolbar processing.

exclude_patterns

Regex patterns for paths to exclude.

show_on_errors

Whether to show toolbar on error responses.

show_toolbar_callback

Callback receiving Litestar Request object.

exclude_paths: Sequence[str]

exclude_patterns: Sequence[str]

show_on_errors: bool = True

show_toolbar_callback: Callable[[Request], bool] | None = None

should_show_toolbar(request)

Determine if the toolbar should be shown for this request.

Parameters:

request (Request) – The Litestar request object.

Return type:

bool

Returns:

True if the toolbar should be shown.

__init__(enabled=True, panels=<factory>, intercept_redirects=False, show_toolbar_callback=None, insert_before='</body>', max_request_history=50, api_path='/_debug_toolbar', static_path='/_debug_toolbar/static', allowed_hosts=<factory>, extra_panels=<factory>, exclude_panels=<factory>, memory_backend='auto', panel_display_depth=10, panel_display_max_items=100, panel_display_max_string=1000, async_profiler_backend='auto', async_blocking_threshold_ms=100.0, async_enable_blocking_detection=True, async_enable_event_loop_monitoring=True, async_event_loop_lag_threshold_ms=10.0, async_capture_task_stacks=True, async_max_stack_depth=10, websocket_tracking_enabled=True, websocket_max_connections=50, websocket_max_messages_per_connection=100, websocket_max_message_size=10240, websocket_connection_ttl=3600, storage=None, exclude_paths=<factory>, exclude_patterns=<factory>, show_on_errors=True)