orionis.queues.manager.QueueManager

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.

Explore modules View classes

class documentation

class QueueManager(IQueueManager): (source)

Constructor: QueueManager(app, serializer)

View In Hierarchy

Resolve lazy connections and expose the canonical deferred dispatch API.

Method	`__init__`	Validate and serialize queue settings without opening backend clients.
Method	`_connectionName`	Validate selection against the configured named backends.
Async Method	`_createDriver`	Construct a configured driver through framework database services.
Async Method	`_submit`	Serialize validated job options and submit to the selected backend.
Async Method	`boot`	Register jobs from the application's configured jobs path.
Async Method	`close`	Release queue-owned resources without closing shared database services.
Async Method	`connection`	Resolve one shared lazy driver for the selected named connection.
Method	`dispatch`	Create one awaitable dispatch without serializing or persisting data.
Async Method	`failed`	Resolve durable failed-job storage only when first requested.
Async Method	`retryFailed`	Requeue preserved job data with attempts reset by a fresh push.
Async Method	`worker`	Create an independent persistent worker using validated defaults.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_app`	Undocumented
Instance Variable	`_config`	Undocumented
Instance Variable	`_driver_lock`	Undocumented
Instance Variable	`_drivers`	Undocumented
Instance Variable	`_failed`	Undocumented
Instance Variable	`_failed_lock`	Undocumented
Instance Variable	`_serializer`	Undocumented

def __init__(self, app: IApplication, serializer: IJobSerializer): (source) ¶

Validate and serialize queue settings without opening backend clients.

Parameters
app:`IApplication`	Existing application container.
serializer:`IJobSerializer`	Singleton registered-job serializer.

Returns
`None`	Retain the normalized wire settings for lazy backend resolution.

Raises
`TypeError`	If queue settings have invalid types or unsupported fields.
`ValueError`	If queue settings or their storage relationships are invalid.

def _connectionName(self, name: str | None) -> str: (source) ¶

Validate selection against the configured named backends.

Parameters
name:`str \| None`	Explicit selection or central default.

Returns
`str`	Existing configured connection name.

async def _createDriver(self, name: str) -> IQueueDriver: (source) ¶

Construct a configured driver through framework database services.

Parameters
name:`str`	Validated configured connection name.

Returns
`IQueueDriver`	Driver whose real I/O starts with its first operation.

async def _submit(self, job: BaseJob, connection: str | None, queue: str | None, delay: float) -> str: (source) ¶

Serialize validated job options and submit to the selected backend.

Parameters
job:`BaseJob`	Job containing only declared serializable state.
connection:`str \| None`	Explicit backend selection.
queue:`str \| None`	Explicit channel selection.
delay:`float`	Delay in seconds before availability.

Returns
`str`	Dispatch identifier.

async def boot(self): (source) ¶

Returns
`None`	Register discovered job classes with the shared serializer.

Raises
`QueueConfigurationError`	If the jobs path is invalid or a discovered module cannot be imported.

async def close(self): (source) ¶

overrides orionis.queues.contracts.manager.IQueueManager.close

Release queue-owned resources without closing shared database services.

Returns
`None`	Close cached drivers and any initialized failed-job repository, then clear their cached references.

async def connection(self, name: str | None = None) -> IQueueDriver: (source) ¶

overrides orionis.queues.contracts.manager.IQueueManager.connection

Resolve one shared lazy driver for the selected named connection.

Parameters
name:`str \| None, optional`	Explicit connection or central default.

Returns
`IQueueDriver`	Backend shared by its logical channels.

def dispatch(self, job: BaseJob) -> PendingDispatch: (source) ¶

overrides orionis.queues.contracts.manager.IQueueManager.dispatch

Create one awaitable dispatch without serializing or persisting data.

Parameters
job:`BaseJob`	Application job containing persistent constructor state.

Returns
`PendingDispatch`	Fluent operation submitted only when awaited.

async def failed(self) -> IFailedJobRepository: (source) ¶

overrides orionis.queues.contracts.manager.IQueueManager.failed

Resolve durable failed-job storage only when first requested.

Returns
`IFailedJobRepository`	Repository shared by all queue connections.

async def retryFailed(self, failed_id: str) -> str: (source) ¶

overrides orionis.queues.contracts.manager.IQueueManager.retryFailed

Requeue preserved job data with attempts reset by a fresh push.

Parameters
failed_id:`str`	Failure record identifier.

Returns
`str`	Restored job identifier.

async def worker(self, connection: str | None = None, queues: tuple[str, ...] | None = None, concurrency: int | None = None) -> Worker: (source) ¶

overrides orionis.queues.contracts.manager.IQueueManager.worker

Create an independent persistent worker using validated defaults.

Parameters
connection:`str \| None, optional`	Explicit backend or central default.
queues:`tuple[str, ...] \| None, optional`	Channels ordered by priority.
concurrency:`int \| None, optional`	Simultaneous job executions or configured default.

Returns
`Worker`	Consumer runtime sharing the existing application container.

__slots__: tuple[str, ...] = (source) ¶

overrides orionis.queues.contracts.manager.IQueueManager.__slots__

Undocumented

_app = (source) ¶

Undocumented

_config = (source) ¶

Undocumented

_driver_lock = (source) ¶

Undocumented

_drivers: dict[str, IQueueDriver] = (source) ¶

Undocumented

_failed: IFailedJobRepository | None = (source) ¶

Undocumented

_failed_lock = (source) ¶

Undocumented

_serializer = (source) ¶

Undocumented