Module

templating.trace

Typed return diagnostics for DevTools and debug headers.

1Class3Functions

Classes

ReturnTrace 14 ▼
Bounded, server-owned diagnostic for a typed route return.

Bounded, server-owned diagnostic for a typed route return.

Attributes

Name Type Description
return_type str —
category str —
is_htmx bool —
render_intent str —
status int | None —
template str | None —
block str | None —
target str | None —
swap str | None —
context_keys tuple[str, ...] —
streaming bool —
sse bool —
notes tuple[str, ...] —

Methods

payload 0 dict[str, Any] ▼
Return a JSON-serializable payload.
def payload(self) -> dict[str, Any]
Returns
dict[str, Any]

Functions

stash_return_trace_for_request 2 None ▼
Store a return trace on the current request.
def stash_return_trace_for_request(trace: ReturnTrace, request: Request | None) -> None
Parameters
Name Type Description
trace ReturnTrace
request Request | None
get_return_trace 1 ReturnTrace | None ▼
Return the stashed typed return trace, if present.
def get_return_trace(request: Any) -> ReturnTrace | None
Parameters
Name Type Description
request Any
Returns
ReturnTrace | None
encode_return_trace 1 str ▼
Encode a return trace for a compact debug response header.
def encode_return_trace(trace: ReturnTrace) -> str
Parameters
Name Type Description
trace ReturnTrace
Returns
str