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

Configure the synchronous queue connection.

Method __post_init__ Validate the driver, queue name, and reservation duration.
Instance Variable driver Synchronous driver identifier.
Instance Variable queue Default logical queue name read from QUEUE_SYNC_QUEUE.
Instance Variable retry_after Reservation duration read from QUEUE_SYNC_RETRY_AFTER in seconds.

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 driver, queue name, and reservation duration.

Returns
NoneKeep validated connection settings unchanged.
Raises
TypeErrorIf a setting has an invalid type.
ValueErrorIf the driver, identifier, or duration is invalid.
driver: orionis.foundation.config.queue.enums.Drivers | str = (source)

Synchronous driver identifier.

Default logical queue name read from QUEUE_SYNC_QUEUE.

retry_after: float = (source)

Reservation duration read from QUEUE_SYNC_RETRY_AFTER in seconds.