Parameters & Converters

The declarations that bind a handler's arguments to parts of the request, and the path converters behind them.

Path

Bases: ParamBase

Path parameter declaration.

resolve_default

resolve_default() -> Any

Return a fresh default - calling default_factory when one is set.

validate

validate(value: Any, name: str) -> Any

Validate value against constraints.

Query

Bases: ParamBase

Query parameter declaration.

resolve_default

resolve_default() -> Any

Return a fresh default - calling default_factory when one is set.

validate

validate(value: Any, name: str) -> Any

Validate value against constraints.

Header

Bases: ParamBase

HTTP header parameter declaration.

resolve_default

resolve_default() -> Any

Return a fresh default - calling default_factory when one is set.

validate

validate(value: Any, name: str) -> Any

Validate value against constraints.

Cookie

Bases: ParamBase

Cookie parameter declaration.

resolve_default

resolve_default() -> Any

Return a fresh default - calling default_factory when one is set.

validate

validate(value: Any, name: str) -> Any

Validate value against constraints.

Body

Bases: ParamBase

Request body parameter declaration.

resolve_default

resolve_default() -> Any

Return a fresh default - calling default_factory when one is set.

validate

validate(value: Any, name: str) -> Any

Validate value against constraints.

Form

Bases: ParamBase

Form field parameter declaration.

resolve_default

resolve_default() -> Any

Return a fresh default - calling default_factory when one is set.

validate

validate(value: Any, name: str) -> Any

Validate value against constraints.

File

Bases: ParamBase

File upload parameter declaration.

resolve_default

resolve_default() -> Any

Return a fresh default - calling default_factory when one is set.

validate

validate(value: Any, name: str) -> Any

Validate value against constraints.

Converter module-attribute

Converter = _Converter

register_converter

register_converter(name: str, converter_cls: type[_Converter]) -> None

Register a custom path converter.

After register_converter("slug", SlugConverter), routes may use {post:slug} and the radix tree validates/coerces the segment via SlugConverter().match(...). converter_cls must subclass Converter (= _Converter). A built-in name cannot be shadowed - that raises ValueError.

RouteInfo

Stored route metadata.

RouteMatch

Result of matching a path against the tree.