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

Represent the configuration of session based authentication.

Only the keys owned by authentication live here. Cookie lifetime, driver and encryption keep their single source of truth in config/session.py.

Method __post_init__ Validate the session authentication options after initialization.
Instance Variable home Path browsers are redirected to once the login succeeds, and the target guest-only pages send already authenticated visitors to.
Instance Variable key Session key holding the identifier of the authenticated identity.
Instance Variable redirect_to Path browsers are redirected to when authentication is required. None renders the standard 401 error response instead.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
def __post_init__(self): (source)

Validate the session authentication options after initialization.

Returns
NoneThis method validates the instance attributes in place.
Raises
TypeErrorIf key or home is not a string, or redirect_to is neither a string nor None.
ValueErrorIf key or home is empty.

Path browsers are redirected to once the login succeeds, and the target guest-only pages send already authenticated visitors to.

Session key holding the identifier of the authenticated identity.

redirect_to: str | None = (source)

Path browsers are redirected to when authentication is required. None renders the standard 401 error response instead.