ORIONIS API REFERENCE

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.

class documentation

Queue flash payloads for responses and deferred views.

Owners initialize the slot and decide when to apply it to the session. Pending views apply it before rendering; responses apply it during dispatch.

Method withErrors Flash validation errors for the next request.
Method withFlash Queue a status message for the owning response or pending view.
Method withInput Flash the submitted payload so the next request can repopulate it.
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _flash Session values scheduled for availability during the next request.
def withErrors(self: Self, errors: Mapping[str, Any] | Exception) -> Self: (source)

Flash validation errors for the next request.

Errors are read back in templates through the errors global.

Parameters
errors:collections.abc.Mapping[str, typing.Any] | ExceptionMapping of field to message(s), or a validation exception.
Returns
typing.SelfThe same owner, allowing fluent chaining.
def withFlash(self: Self, key: str, value: Any | None = None) -> Self: (source)

Queue a status message for the owning response or pending view.

The value survives for exactly one subsequent request and is read back in templates through the flash() global.

Parameters
key:strFlash data key.
value:typing.Any, optionalValue to flash.
Returns
typing.SelfThe same owner, allowing fluent chaining.
def withInput(self: Self, values: Mapping[str, Any]) -> Self: (source)

Flash the submitted payload so the next request can repopulate it.

Values are read back in templates through the old() global. Credential-like fields such as password are stripped.

Parameters
values:collections.abc.Mapping[str, typing.Any]Submitted form payload to remember.
Returns
typing.SelfThe same owner, allowing fluent chaining.
__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

Session values scheduled for availability during the next request.