orionis.foundation.config.queue.Queue

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 Queue(BaseEntity): (source)

View In Hierarchy

Configure named queue connections, failure storage, and workers.

Parameters
default	Default connection name, read from `QUEUE_CONNECTION`.
connections	Conventional connections or named backends converted to typed entities.
failed	Database connection and table used to preserve failed jobs.
worker	Default concurrency, polling interval, timeout, tries, and backoff.

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.
Class Variable	`connections`	Undocumented
Class Variable	`default`	Undocumented
Class Variable	`failed`	Undocumented
Class Variable	`worker`	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

@staticmethod

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:`Worker`	Validated execution defaults.
failed:`Failed`	Validated failed-job storage.

Returns
`None`	Check relationships across the configuration entities.

Raises
`ValueError`	If a lease is unsafe or persistent storage namespaces overlap.

@staticmethod

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
`None`	Require independent tables or Redis prefixes for durable connections.

Raises
`ValueError`	If 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
`TypeError`	If a connection has an unexpected type or unsupported fields.
`ValueError`	If a connection name, driver, or nested setting is invalid.

def __normalizeFailed(self) -> Failed: (source) ¶

Convert failure storage mappings to a validated immutable entity.

Returns
`Failed`	Validated failed-job storage.

Raises
`TypeError`	If settings have an unexpected type or unsupported fields.
`ValueError`	If a database identifier is invalid.

def __normalizeWorker(self) -> Worker: (source) ¶

Convert worker mappings to a validated immutable entity.

Returns
`Worker`	Validated worker defaults.

Raises
`TypeError`	If settings have an unexpected type or unsupported fields.
`ValueError`	If a worker limit or duration is invalid.

def __post_init__(self): (source) ¶

overrides orionis.support.entities.BaseEntity.__post_init__

Normalize nested entities and reject invalid worker leases.

Returns
`None`	Store typed settings and validate their relationships.

Raises
`TypeError`	If settings or durations have invalid types.
`ValueError`	If identifiers, drivers, defaults, or lease relationships are invalid.

connections: Connections | dict = (source) ¶

Undocumented

default: str = (source) ¶

Undocumented

failed: Failed | dict = (source) ¶

Undocumented

worker: Worker | dict = (source) ¶

Undocumented