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

package documentation
(source)

Undocumented

Module context Undocumented
Package contracts Undocumented
Package drivers Undocumented
Package entities Undocumented
Module exceptions No module docstring; 8/8 exceptions documented
Package failed Undocumented
Module functions No module docstring; 0/1 constant, 3/3 functions documented
Module job Undocumented
Module manager No module docstring; 1/1 function, 1/1 class documented
Module pending Undocumented
Module provider No module docstring; 1/1 class documented
Module schema No module docstring; 0/1 constant, 3/3 functions documented
Module serializer No module docstring; 0/5 constant, 6/6 functions, 2/2 classes documented
Module types Undocumented
Module worker No module docstring; 0/1 constant, 2/2 classes documented

From __init__.py:

Class BaseJob Declare serializable job fields and asynchronous service dependencies.
Class JobContext Expose the current reservation and explicit lifecycle operations.
Class JobEnvelope Carry immutable, versioned job data independently of backend state.
Class PendingDispatch Defer a single dispatch until awaited and allow options before submission.
Function __dir__ List loaded attributes and declared public queue exports.
Function __getattr__ Resolve and cache a declared public queue export.
Constant _EXPORTS Undocumented
def __dir__() -> list[str]: (source)

List loaded attributes and declared public queue exports.

Returns
list[str]Sorted package attribute names.
def __getattr__(name: str) -> object: (source)

Resolve and cache a declared public queue export.

Parameters
name:strPublic attribute requested by application code.
Returns
objectExported class from its defining module.
_EXPORTS: dict = (source)

Undocumented

Value
{'BaseJob': ('orionis.queues.job', 'BaseJob'),
 'JobContext': ('orionis.queues.context', 'JobContext'),
 'JobEnvelope': ('orionis.queues.entities.envelope', 'JobEnvelope'),
 'PendingDispatch': ('orionis.queues.pending', 'PendingDispatch')}