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

Execute one immediate attempt through the shared worker pipeline.

Method __init__ Prepare immediate execution without a durable backend.
Async Method clear Return zero removed jobs for an immediate channel.
Async Method close Signal the worker to stop without closing application services.
Async Method delete Acknowledge completion of an immediate execution.
Async Method push Execute the job immediately and propagate its original exception.
Async Method release Reject persistent retry on an immediate connection.
Async Method reserve Return no durable work for an immediate connection.
Async Method size Return the empty durable size of an immediate channel.
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _retry_after Execution lease used by the shared pipeline.
Instance Variable _serializer Registered job serializer.
Instance Variable _worker Worker produced by Worker.
def __init__(self, app: IApplication, serializer: IJobSerializer, connection: str, failed_resolver: FailedResolver, retry_after: float = 90.0): (source)

Prepare immediate execution without a durable backend.

Parameters
app:orionis.IApplicationExisting application container.
serializer:orionis.queues.contracts.serializer.IJobSerializerRegistered job serializer.
connection:strLogical connection name.
failed_resolver:orionis.queues.worker.FailedResolverResolver called only on terminal failure.
retry_after:float, optionalExecution lease used by the shared pipeline.
Returns
NoneComplete the documented operation without returning a value.
async def clear(self, queue: str) -> int: (source)

Return zero removed jobs for an immediate channel.

Parameters
queue:strUnused channel name.
Returns
intZero, because no jobs are persisted.
async def close(self): (source)

Signal the worker to stop without closing application services.

Returns
NoneSet the stop signal without waiting for running jobs.
async def delete(self, reserved: ReservedJob) -> bool: (source)

Acknowledge completion of an immediate execution.

Parameters
reserved:orionis.queues.entities.reserved_job.ReservedJobUnused immediate reservation.
Returns
boolAlways true for the in-process execution.
async def push(self, envelope: JobEnvelope, delay: float = 0.0) -> str: (source)

Execute the job immediately and propagate its original exception.

Parameters
envelope:orionis.queues.JobEnvelopeImmutable job payload and execution settings.
delay:float, optionalDelay, which must be zero for immediate execution.
Returns
strCompleted dispatch identifier.
Raises
orionis.queues.exceptions.QueueDispatchErrorIf delayed execution is requested.
async def release(self, reserved: ReservedJob, delay: float = 0.0) -> bool: (source)

Reject persistent retry on an immediate connection.

Parameters
reserved:orionis.queues.entities.reserved_job.ReservedJobUnused immediate reservation.
delay:float, optionalRequested retry delay.
Returns
boolResult of the operation described above.
Raises
orionis.queues.exceptions.QueueDispatchErrorAlways, because immediate jobs have no durable storage.
async def reserve(self, queues: tuple[str, ...], retry_after: float) -> ReservedJob | None: (source)

Return no durable work for an immediate connection.

Parameters
queues:tuple[str, ...]Unused channel selection.
retry_after:floatUnused lease lifetime.
Returns
NoneImmediate jobs are executed during push.
async def size(self, queue: str) -> int: (source)

Return the empty durable size of an immediate channel.

Parameters
queue:strUnused channel name.
Returns
intZero, because no jobs are persisted.
__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

_retry_after = (source)

Execution lease used by the shared pipeline.

_serializer = (source)

Registered job serializer.

Worker produced by Worker.