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 a durable database queue connection.

Method __post_init__ Validate the driver, database identifiers, and reservation duration.
Instance Variable connection Framework database connection, or its default when omitted.
Instance Variable driver Database driver identifier.
Instance Variable queue Default logical queue name read from QUEUE_DB_QUEUE.
Instance Variable retry_after Reservation duration read from QUEUE_DB_RETRY_AFTER in seconds.
Instance Variable table Unqualified SQL table used to persist jobs.

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, database identifiers, and reservation duration.

Returns
NoneKeep validated connection settings unchanged.
Raises
TypeErrorIf a setting has an invalid type.
ValueErrorIf a driver, identifier, or duration is invalid.
connection: str | None = (source)

Framework database connection, or its default when omitted.

driver: orionis.foundation.config.queue.enums.Drivers | str = (source)

Database driver identifier.

Default logical queue name read from QUEUE_DB_QUEUE.

retry_after: float = (source)

Reservation duration read from QUEUE_DB_RETRY_AFTER in seconds.

Unqualified SQL table used to persist jobs.