Module

server.debug.render_plan_snapshot

Serialize RenderPlan for dev-mode debug HTML (repr previews, bounded size).

4Functions

Functions

summarize_context_for_debug 1 list[tuple[str, str]] ▼
Return (key, repr preview) pairs for debug display.
def summarize_context_for_debug(ctx: dict[str, Any]) -> list[tuple[str, str]]
Parameters
Name Type Description
ctx dict[str, Any]
Returns
list[tuple[str, str]]
serialize_render_plan_for_debug 1 dict[str, Any] ▼
Build a snapshot dict for the debug error page.
def serialize_render_plan_for_debug(plan: RenderPlan) -> dict[str, Any]
Parameters
Name Type Description
plan RenderPlan
Returns
dict[str, Any]
stash_render_debug_for_request 3 None ▼
Store render plan snapshot on the request for `render_debug_page`(). Only seri…
def stash_render_debug_for_request(plan: RenderPlan, request: Request | None, *, debug: bool = False) -> None

Store render plan snapshot on the request forrender_debug_page().

Only serializes when debug is True, avoiding repr/serialization overhead in production.

Parameters
Name Type Description
plan RenderPlan
request Request | None
debug bool Default:False
read_render_debug_from_request 1 dict[str, Any] | None ▼
Return stashed snapshot if present (request may be a test double).
def read_render_debug_from_request(request: Any) -> dict[str, Any] | None
Parameters
Name Type Description
request Any
Returns
dict[str, Any] | None