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

Transfer report ownership from a worker submission to its loop task.

Static Method _cancelTask Forward public cancellation without releasing task ownership.
Method __init__ Retain one submission until admission and terminal task completion.
Method _admit Transfer a published submission to a real task on the owning loop.
Method _finished Transfer a terminal task outcome and release loop-side ownership.
Method _reject Close unadmitted work and settle its public future before diagnosis.
Method _releaseSubmission Release a submission after admission or a terminal scheduling failure.
Method submit Publish ownership before enqueueing the loop-side admission callback.
Class Variable __slots__ Submission state retained through admission and terminal delivery.
Instance Variable _context Incident metadata shared by admission and diagnosis.
Instance Variable _coroutine Reporting coroutine owned until admitted or closed.
Instance Variable _exception Original application failure.
Instance Variable _future Public future that stays cancellable until task completion.
Instance Variable _incident Claim whose unused delivery must be abandoned.
Instance Variable _loop Event loop receiving the reporting coroutine.
Instance Variable _runtime Runtime retaining pending report ownership.
def _cancelTask(reference: ReferenceType[asyncio.Task], result: ThreadFuture): (source)

Forward public cancellation without releasing task ownership.

Parameters
reference:weakref.ReferenceType[asyncio.Task]Non-owning reference so a retained receipt future releases context.
result:concurrent.futures.FuturePublic future that may have been cancelled by any thread.
Returns
NoneNo return value.
def __init__(self, runtime: FailureRuntime, loop: asyncio.AbstractEventLoop, exception: BaseException, context: FailureContext, incident: _Incident): (source)

Retain one submission until admission and terminal task completion.

Parameters
runtime:FailureRuntimeRuntime owning the cross-thread report.
loop:asyncio.AbstractEventLoopEvent loop that must execute the report.
exception:BaseExceptionOriginal failure to deliver.
context:FailureContextIncident metadata claimed by the originating callback.
incident:_IncidentPending incident to retain or abandon at completion.
Returns
NoneNo return value.
def _admit(self): (source)

Transfer a published submission to a real task on the owning loop.

Returns
NoneNo return value.
Raises
BaseExceptionIf task creation raises a control-flow signal after cleanup.
def _finished(self, task: asyncio.Task): (source)

Transfer a terminal task outcome and release loop-side ownership.

Parameters
task:asyncio.TaskReporting task whose actual cleanup has completed.
Returns
NoneNo return value.
def _reject(self, secondary: BaseException): (source)

Close unadmitted work and settle its public future before diagnosis.

Parameters
secondary:BaseExceptionOriginal failure to enqueue or create the reporting task.
Returns
NoneNo return value.
def _releaseSubmission(self): (source)

Release a submission after admission or a terminal scheduling failure.

Returns
NoneNo return value.
def submit(self) -> ThreadFuture | None: (source)

Publish ownership before enqueueing the loop-side admission callback.

Returns
concurrent.futures.Future or NoneCancellable delivery future, or None if enqueueing failed.
Raises
BaseExceptionIf enqueueing raises a control-flow signal after cleanup.
__slots__: tuple[str, ...] = (source)

Submission state retained through admission and terminal delivery.

_context = (source)

Incident metadata shared by admission and diagnosis.

_coroutine = (source)

Reporting coroutine owned until admitted or closed.

_exception = (source)

Original application failure.

Public future that stays cancellable until task completion.

_incident = (source)

Claim whose unused delivery must be abandoned.

Event loop receiving the reporting coroutine.

_runtime = (source)

Runtime retaining pending report ownership.