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

Keep deferred effects and their completion inside an operation ledger.

Method __init__ Initialize an incident with its original exception and delivery status.
Method abandon Mark unstarted delivery as abandoned and notify waiting owners.
Method finish Store the selected handling plan and notify incident waiters.
Method reclaim Reset an abandoned incident for another delivery attempt.
Async Method wait Await incident completion without cancelling its delivery.
Class Variable __slots__ Incident fields retained only for the owning operation's lifetime.
Instance Variable abandoned Whether delivery was cancelled before starting and can be reclaimed.
Instance Variable context Metadata supplied to the hook when delivery starts.
Instance Variable exception Original exception used for incident identity and native traceback.
Instance Variable handling Selected deferred effects shared by incident consumers.
Instance Variable ready Thread-safe completion notice without an exception-valued result.
Instance Variable receipt Immutable delivery status shared by duplicate notifications.
Instance Variable started Whether delivery has started and may already have performed effects.
def __init__(self, exception: BaseException, receipt: FailureReceipt): (source)

Initialize an incident with its original exception and delivery status.

Parameters
exception:BaseExceptionOriginal exception retained for identity-based lookup.
receipt:FailureReceiptInitial delivery status for the incident.
Returns
NoneNo return value.
def abandon(self): (source)

Mark unstarted delivery as abandoned and notify waiting owners.

Returns
NoneNo return value.
def finish(self, handling: FailureHandling | None): (source)

Store the selected handling plan and notify incident waiters.

Parameters
handling:FailureHandling or NoneDeferred handling plan, or None when no plan is available.
Returns
NoneNo return value.
def reclaim(self): (source)

Reset an abandoned incident for another delivery attempt.

Returns
NoneNo return value.
async def wait(self): (source)

Await incident completion without cancelling its delivery.

Use a loop-local notification so cancelling one waiter leaves the shared completion signal intact.

Returns
NoneNo return value.
Raises
asyncio.CancelledErrorIf this waiter is cancelled.
__slots__: tuple[str, ...] = (source)

Incident fields retained only for the owning operation's lifetime.

abandoned: bool = (source)

Whether delivery was cancelled before starting and can be reclaimed.

context: FailureContext | None = (source)

Metadata supplied to the hook when delivery starts.

exception = (source)

Original exception used for incident identity and native traceback.

handling: FailureHandling | None = (source)

Selected deferred effects shared by incident consumers.

Thread-safe completion notice without an exception-valued result.

Immutable delivery status shared by duplicate notifications.

Whether delivery has started and may already have performed effects.