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
Defer a single dispatch until awaited and allow options before submission.
| Method | __await__ |
Start or join the deferred dispatch when awaited. |
| Method | __init__ |
Retain a job and its asynchronous submission callback. |
| Method | _check |
Reject changes after the submission task has started. |
| Async Method | _run |
Submit once and share the result with every awaiter. |
| Method | delay |
Schedule availability relative to submission time. |
| Method | on |
Select the configured backend before submission. |
| Method | on |
Select a logical channel before submission. |
| Class Variable | __slots__ |
Declare the instance attribute slots reserved by this class. |
| Instance Variable | _completion |
Completion provider or result associated with the primitive. |
| Instance Variable | _connection |
Configured connection used to store or dispatch the operation. |
| Instance Variable | _delay |
Delay value used by PendingDispatch. |
| Instance Variable | _job |
Instance whose declared data will be serialized on submission. |
| Instance Variable | _queue |
Name of the queue receiving or storing the job. |
| Instance Variable | _submit |
Manager entry point invoked only when awaited. |
Start or join the deferred dispatch when awaited.
| Returns | |
collections.abc.Generator[object, None, str] | Iterator consumed by Python's await protocol. |
Retain a job and its asynchronous submission callback.
| Parameters | |
submit:orionis.queues.types.DispatchCallback | Manager entry point invoked only when awaited. |
job:orionis.queues.BaseJob | Instance whose declared data will be serialized on submission. |
| Returns | |
None | Complete the documented operation without returning a value. |
Reject changes after the submission task has started.
| Returns | |
None | Validate the pending operation's state. |
Schedule availability relative to submission time.
| Parameters | |
seconds:float | Finite nonnegative delay. |
| Returns | |
orionis.queues.PendingDispatch | This pending operation. |
Select the configured backend before submission.
| Parameters | |
name:str | Connection name from queue configuration. |
| Returns | |
orionis.queues.PendingDispatch | This pending operation. |
Select a logical channel before submission.
| Parameters | |
name:str | Channel within the selected connection. |
| Returns | |
orionis.queues.PendingDispatch | This pending operation. |