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 named queue connections, failure storage, and workers.

Static Method __validateConnections Validate reservation leases and isolate failure storage.
Static Method __validateStorageNamespaces Require distinct persistent storage for named durable connections.
Method __normalizeConnections Validate conventional or named connections as typed entities.
Method __normalizeFailed Convert failure storage mappings to a validated immutable entity.
Method __normalizeWorker Convert worker mappings to a validated immutable entity.
Method __post_init__ Normalize nested entities and reject invalid worker leases.
Instance Variable connections Conventional connections or named backends converted to typed entities.
Instance Variable default Default connection name, read from QUEUE_CONNECTION.
Instance Variable failed Database connection and table used to preserve failed jobs.
Instance Variable worker Default concurrency, polling interval, timeout, tries, and backoff.

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 __validateConnections(connections: dict[str, Sync | Database | Redis], worker: Worker, failed: Failed): (source)

Validate reservation leases and isolate failure storage.

Parameters
connections:dict[str, Sync | Database | Redis]Validated named connection entities.
worker:orionis.foundation.config.queue.WorkerValidated execution defaults.
failed:orionis.foundation.config.queue.FailedValidated failed-job storage.
Returns
NoneCheck relationships across the configuration entities.
Raises
ValueErrorIf a lease is unsafe or persistent storage namespaces overlap.
def __validateStorageNamespaces(connections: dict[str, Sync | Database | Redis]): (source)

Require distinct persistent storage for named durable connections.

Parameters
connections:dict[str, Sync | Database | Redis]Validated named connection entities.
Returns
NoneRequire independent tables or Redis prefixes for durable connections.
Raises
ValueErrorIf two connections use the same persistent storage namespace.
def __normalizeConnections(self) -> dict[str, Sync | Database | Redis]: (source)

Validate conventional or named connections as typed entities.

Returns
dict[str, Sync | Database | Redis]Validated connections indexed by their configured names.
Raises
TypeErrorIf a connection has an unexpected type or unsupported fields.
ValueErrorIf a connection name, driver, or nested setting is invalid.
def __normalizeFailed(self) -> Failed: (source)

Convert failure storage mappings to a validated immutable entity.

Returns
orionis.foundation.config.queue.FailedValidated failed-job storage.
Raises
TypeErrorIf settings have an unexpected type or unsupported fields.
ValueErrorIf a database identifier is invalid.
def __normalizeWorker(self) -> Worker: (source)

Convert worker mappings to a validated immutable entity.

Returns
orionis.foundation.config.queue.WorkerValidated worker defaults.
Raises
TypeErrorIf settings have an unexpected type or unsupported fields.
ValueErrorIf a worker limit or duration is invalid.
def __post_init__(self): (source)

Normalize nested entities and reject invalid worker leases.

Returns
NoneStore typed settings and validate their relationships.
Raises
TypeErrorIf settings or durations have invalid types.
ValueErrorIf identifiers, drivers, defaults, or lease relationships are invalid.
connections: orionis.foundation.config.queue.Connections | dict = (source)

Conventional connections or named backends converted to typed entities.

Default connection name, read from QUEUE_CONNECTION.

failed: orionis.foundation.config.queue.Failed | dict = (source)

Database connection and table used to preserve failed jobs.

worker: orionis.foundation.config.queue.Worker | dict = (source)

Default concurrency, polling interval, timeout, tries, and backoff.