Module

`pages.debug`

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.

Classes

RouteDebugInfo 6 ▼

Route contract metadata for debug headers.

Attributes

Name	Type	Description
`route_kind`	`str`	—
`route_files`	`str`	—
`route_meta`	`str`	—
`route_section`	`str`	—
`context_chain`	`str`	—
`shell_context_keys`	`str`	—

Functions

set_route_debug_metadata 2 None ▼

Store route debug metadata on the request for LayoutDebugMiddleware.

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

Parameters

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

get_route_debug_metadata 1 RouteDebugInfo | None ▼

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

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

Parameters

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

Returns

RouteDebugInfo | None

build_route_debug_info 11 RouteDebugInfo ▼

Build RouteDebugInfo from page_wrapper context.

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

Parameters

Name	Type	Description
`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`

Returns

RouteDebugInfo