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 Redis queue connection.

Method __post_init__ Validate Redis connection fields, namespace, and reservation duration.
Instance Variable db Nonnegative database index read from REDIS_DB.
Instance Variable driver Redis driver identifier.
Instance Variable endpoint Redis host read from REDIS_HOST.
Instance Variable password Optional authentication password read from REDIS_PASSWORD.
Instance Variable port TCP port read from REDIS_PORT, between 1 and 65535.
Instance Variable prefix Namespace read from QUEUE_REDIS_PREFIX to isolate persisted jobs.
Instance Variable queue Default logical queue name read from QUEUE_REDIS_QUEUE.
Instance Variable retry_after Reservation duration read from QUEUE_REDIS_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 Redis connection fields, namespace, and reservation duration.

Returns
NoneKeep validated connection settings unchanged.
Raises
TypeErrorIf a setting has an invalid type.
ValueErrorIf a driver, identifier, numeric range, or duration is invalid.

Nonnegative database index read from REDIS_DB.

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

Redis driver identifier.

endpoint: str = (source)

Redis host read from REDIS_HOST.

password: str | None = (source)

Optional authentication password read from REDIS_PASSWORD.

TCP port read from REDIS_PORT, between 1 and 65535.

Namespace read from QUEUE_REDIS_PREFIX to isolate persisted jobs.

Default logical queue name read from QUEUE_REDIS_QUEUE.

retry_after: float = (source)

Reservation duration read from QUEUE_REDIS_RETRY_AFTER in seconds.