debug - Chirp

pages.debug

module

Route contract debug metadata for LayoutDebugMiddleware.

When config.debug is True, page handlers store route contract info on the request. LayoutDebugMiddleware reads it and emits X-Chirp-Route-* headers.

Route contract debug metadata for LayoutDebugMiddleware.

When config.debug is True, page handlers store route contract info on the request. LayoutDebugMiddleware reads it and emits X-Chirp-Route-* headers.

pages.debug

Name	Type	Default	Description
`type`		—
`qualified_name`		—
`element_type`		—
`description`		—
`source_file`		—
`line_number`		—
`is_autodoc`		—
`autodoc_element`		—
`_autodoc_template`		—
`_autodoc_url_path`		—
`_autodoc_page_type`		—
`title`		—
`doc_content_hash`		—

Symbols on this page

class RouteDebugInfo

Route contract metadata for debug headers.

function set_route_debug_metadata

Store route debug metadata on the request for LayoutDebugMiddleware.

function get_route_debug_metadata

Retrieve route debug metadata from the request (does not pop).

function build_route_debug_info

Build RouteDebugInfo from page_wrapper context.

RouteDebugInfo

class

Route contract metadata for debug headers.

set_route_debug_metadata

function

def set_route_debug_metadata(request: Request | None, info: RouteDebugInfo) -> None

Store route debug metadata on the request for LayoutDebugMiddleware.

Parameters

Name	Type	Default	Description
`request`	`Request \| None`	—
`info`	`RouteDebugInfo`	—

get_route_debug_metadata

function

def get_route_debug_metadata(request: Request | None) -> RouteDebugInfo | None

Retrieve route debug metadata from the request (does not pop).

Parameters

Name	Type	Default	Description
`request`	`Request \| None`	—

build_route_debug_info

function

def build_route_debug_info(*, route_kind: str, template_name: str | None, meta: object | None, meta_provider: object | None, context_providers: tuple[object, ...], layout_chain: object, actions: tuple[object, ...], viewmodel_provider: object | None, meta_resolved: object | None, section_ctx: dict, shell_ctx: dict) -> RouteDebugInfo

Build RouteDebugInfo from page_wrapper context.

Parameters

Name	Type	Default
`route_kind`	`str`	—
`template_name`	`str \| None`	—
`meta`	`object \| None`	—
`meta_provider`	`object \| None`	—
`context_providers`	`tuple[object, ...]`	—
`layout_chain`	`object`	—
`actions`	`tuple[object, ...]`	—
`viewmodel_provider`	`object \| None`	—
`meta_resolved`	`object \| None`	—
`section_ctx`	`dict`	—
`shell_ctx`	`dict`	—

View source · /home/runner/work/chirp/chirp/site/../src/chirp/pages/debug.py:1