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 how the application identity is located and verified.

The framework never imports the identity class directly: it receives a dotted path and resolves it lazily, so any model may play the role of the authenticatable identity.

Method __post_init__ Validate the identity configuration after initialization.
Instance Variable model Dotted path of the model backing the authenticated identity.
Instance Variable username Attribute holding the public credential used to look an identity up, such as the email address.

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 identity configuration after initialization.

Returns
NoneThis method validates the instance attributes in place.
Raises
TypeErrorIf any option is not a string.
ValueErrorIf the model path does not look like a dotted class path.

Dotted path of the model backing the authenticated identity.

username: str = (source)

Attribute holding the public credential used to look an identity up, such as the email address.