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. |
Initialize an incident with its original exception and delivery status.
| Parameters | |
exception:BaseException | Original exception retained for identity-based lookup. |
receipt:FailureReceipt | Initial delivery status for the incident. |
| Returns | |
None | No return value. |
Store the selected handling plan and notify incident waiters.
| Parameters | |
handling:FailureHandling or None | Deferred handling plan, or None when no plan is available. |
| Returns | |
None | No return value. |
Await incident completion without cancelling its delivery.
Use a loop-local notification so cancelling one waiter leaves the shared completion signal intact.
| Returns | |
None | No return value. |
| Raises | |
asyncio.CancelledError | If this waiter is cancelled. |