orionis.queues.contracts.worker.IWorker

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

class IWorker(ABC): (source)

Declare asynchronous consumption and graceful stopping.

Async Method	`execute`	Execute one claim through scoped DI and fenced transitions.
Async Method	`run`	Consume jobs until stopped or the requested limit is reached.
Method	`stop`	Stop reserving jobs and drain in-flight executions.
Class Variable	`__slots__`	Undocumented

async def execute(self, reserved: ReservedJob, *, raise_errors: bool = False): (source) ¶

overridden in orionis.queues.worker.Worker

Execute one claim through scoped DI and fenced transitions.

Parameters
reserved:`ReservedJob`	Claim to execute.
raise_errors:`bool, optional`	Propagate the original error for synchronous dispatch.

Returns
`None`	Complete acknowledgement, release, or failure handling.

async def run(self, *, stop_when_empty: bool = False, max_jobs: int | None = None) -> int: (source) ¶

overridden in orionis.queues.worker.Worker

Consume jobs until stopped or the requested limit is reached.

Parameters
stop_when_empty:`bool, optional`	Exit after all consumers find no immediately eligible job.
max_jobs:`int \| None, optional`	Maximum number of attempts started during this run.

Returns
`int`	Number of processed reservations.

overridden in orionis.queues.worker.Worker

Stop reserving jobs and drain in-flight executions.

Returns
`None`	Request graceful shutdown.

overridden in orionis.queues.worker.Worker

Undocumented