orionis.http.validation

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

module documentation

(source)

Undocumented

Function	`_is_local_reference`	Accept a local path or an absolute reference with the application origin.
Function	`_url_origin`	Extract the normalized scheme, hostname, and effective port of a URL.
Function	`previous_url`	Resolve the page a failed submission should be redirected back to.
Async Function	`validation_response`	Translate a schema validation failure into an HTTP response.
Constant	`_DEFAULT_PORTS`	Undocumented
Constant	`_DELETE_CODE`	Undocumented
Constant	`_FIRST_PRINTABLE_CODE`	Undocumented

def _is_local_reference(reference: str, base_url: str) -> bool: (source) ¶

Accept a local path or an absolute reference with the application origin.

Parameters
reference:`str`	Untrusted referrer supplied by the client.
base_url:`str`	Base URL of the current application request.

Returns
`bool`	Whether the referrer is suitable for a same-origin redirect.

def _url_origin(url: str) -> tuple[str, str | None, int | None]: (source) ¶

Extract the normalized scheme, hostname, and effective port of a URL.

Parameters
url:`str`	Absolute URL whose origin is compared with the application origin.

Returns
`tuple[str, str \| None, int \| None]`	Scheme, lowercase hostname, and explicit or default port.

Raises
`ValueError`	If the authority or port is malformed or contains user credentials.

def previous_url(request: Request) -> str: (source) ¶

Resolve the page a failed submission should be redirected back to.

Resolution order: the last page recorded by the session middleware, the referring URL when it belongs to this application, and finally the URL the form was submitted to.

Parameters
request:`Request`	Incoming HTTP request.

Returns
`str`	Absolute URL or path to redirect back to.

async def validation_response(exc: ValidationException, request: Request, responses: IDefaultResponses) -> Response: (source) ¶

Translate a schema validation failure into an HTTP response.

JSON and AJAX clients receive the structured 422 payload, while browsers are redirected back to the submitted form with the errors and the previous input flashed into the session.

Parameters
exc:`ValidationException`	Failure carrying every field error found in the payload.
request:`Request`	Incoming HTTP request.
responses:`IDefaultResponses`	Default response factory used to render the error payload.

Returns
`Response`	A `422` response, or a `302` redirect back to the previous page.

_DEFAULT_PORTS: dict[str, int] = (source) ¶

Undocumented

Value

{'http': 80, 'https': 443}

_DELETE_CODE: int = (source) ¶

Undocumented

Value

_FIRST_PRINTABLE_CODE: int = (source) ¶

Undocumented

Value