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.

Parameters
driverRedis driver identifier.
endpointRedis host read from REDIS_HOST.
portTCP port read from REDIS_PORT, between 1 and 65535.
dbNonnegative database index read from REDIS_DB.
passwordOptional authentication password read from REDIS_PASSWORD.
prefixNamespace read from QUEUE_REDIS_PREFIX to isolate persisted jobs.
queueDefault logical queue name read from QUEUE_REDIS_QUEUE.
retry_afterReservation duration read from QUEUE_REDIS_RETRY_AFTER in seconds.
Method __post_init__ Validate Redis connection fields, namespace, and reservation duration.
Class Variable db Undocumented
Class Variable driver Undocumented
Class Variable endpoint Undocumented
Class Variable password Undocumented
Class Variable port Undocumented
Class Variable prefix Undocumented
Class Variable queue Undocumented
Class Variable retry_after Undocumented

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method getFields Describe field names, normalized types, defaults, and metadata.
Method toDict Convert the dataclass instance to a recursively copied dictionary.
Class Variable __slots__ Undocumented
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.

Undocumented

driver: Drivers | str = (source)

Undocumented

endpoint: str = (source)

Undocumented

password: str | None = (source)

Undocumented

Undocumented

Undocumented

Undocumented

retry_after: float = (source)

Undocumented