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

Group the conventional validated queue connections.

Method __post_init__ Convert connection mappings into strictly validated entities.
Instance Variable database Durable database connection settings.
Instance Variable redis Durable Redis connection settings.
Instance Variable sync Synchronous connection settings.

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)

Convert connection mappings into strictly validated entities.

Returns
NoneStore an entity for each supported connection.
Raises
TypeErrorIf a connection has an unexpected type or unsupported fields.
ValueErrorIf a nested setting fails its connection's validation.
database: orionis.foundation.config.queue.Database | dict = (source)

Durable database connection settings.

redis: orionis.foundation.config.queue.Redis | dict = (source)

Durable Redis connection settings.

sync: orionis.foundation.config.queue.Sync | dict = (source)

Synchronous connection settings.