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.

Explore modules View classes

orionis.queues.JobContext

class documentation

class JobContext: (source)

Constructor: JobContext(driver, reserved, connection, fail)

View In Hierarchy

Expose the current reservation and explicit lifecycle operations.

Method __init__ Bind operational state to one job execution.
Method _requireActive Reject repeated transitions on a completed context.
Async Method delete Acknowledge the job and remove its reservation.
Async Method fail Persist a terminal error and acknowledge the reservation.
Async Method release Release the reservation for another attempt.
Class Variable __slots__ Undocumented
Instance Variable _connection Undocumented
Instance Variable _driver Undocumented
Instance Variable _fail Undocumented
Instance Variable _failure Undocumented
Instance Variable _finished Undocumented
Instance Variable _reserved Undocumented
Property attempts Return the number of reservations including this execution.
Property connection Return the logical backend connection name.
Property failure Return an explicitly reported terminal exception.
Property finished Report whether an explicit lifecycle operation completed.
Property id Return the immutable job identifier.
Property queue Return the logical queue name.
def __init__(self, driver: IQueueDriver, reserved: ReservedJob, connection: str, fail: FailureCallback): (source)

Bind operational state to one job execution.

Parameters
driver:IQueueDriverDriver owning the reservation.
reserved:ReservedJobCurrent fenced reservation.
connection:strLogical connection name.
fail:FailureCallbackCallback persisting a terminal failure.
Returns
NoneComplete the documented operation without returning a value.
def _requireActive(self): (source)

Reject repeated transitions on a completed context.

Returns
NoneComplete the documented operation without returning a value.
Raises
QueueLeaseErrorIf a lifecycle operation already completed.
async def delete(self): (source)

Acknowledge the job and remove its reservation.

Returns
NoneComplete the documented operation without returning a value.
Raises
QueueLeaseErrorIf the reservation is no longer owned by this execution.
async def fail(self, exception: Exception): (source)

Persist a terminal error and acknowledge the reservation.

Parameters
exception:ExceptionOriginal application exception.
Returns
NoneComplete the documented operation without returning a value.
Raises
QueueLeaseErrorIf the reservation is no longer owned by this execution.
async def release(self, delay: float = 0.0): (source)

Release the reservation for another attempt.

Parameters
delay:float, optionalNonnegative delay in seconds.
Returns
NoneComplete the documented operation without returning a value.
Raises
QueueConfigurationErrorIf the delay is invalid.
QueueLeaseErrorIf the reservation is no longer owned by this execution.
__slots__: tuple[str, ...] = (source)

Undocumented

_connection = (source)

Undocumented

_driver = (source)

Undocumented

_fail = (source)

Undocumented

_failure: Exception | None = (source)

Undocumented

_finished: bool = (source)

Undocumented

_reserved = (source)

Undocumented

attempts: int = (source)

Return the number of reservations including this execution.

Returns
intOne-based attempt count.
connection: str = (source)

Return the logical backend connection name.

Returns
strConfigured connection name.
failure: Exception | None = (source)

Return an explicitly reported terminal exception.

Returns
Exception | NoneError passed to fail.
finished: bool = (source)

Report whether an explicit lifecycle operation completed.

Returns
boolWhether automatic worker acknowledgement must be skipped.
id: str = (source)

Return the immutable job identifier.

Returns
strDispatch identifier.
queue: str = (source)

Return the logical queue name.

Returns
strChannel containing the job.