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.

package documentation

Group the queues components and public imports.

Module _database Share concurrent schema bootstrap for queue and failed-job storage.
Module context Expose the current reservation and explicit lifecycle operations.
Package contracts Group the queues contracts components and public imports.
Package drivers Group the queues drivers components and public imports.
Package entities Group the queues entities components and public imports.
Module exceptions Provide queues operations.
Package failed Group the queues failed components and public imports.
Module functions Provide queues operations.
Module job Declare serializable job fields and asynchronous service dependencies.
Module manager Resolve lazy connections and expose the canonical deferred dispatch API.
Module pending Defer a single dispatch until awaited and allow options before submission.
Module provider Register queue services eagerly while keeping backend I/O lazy.
Module schema Provide queues operations.
Module serializer Serialize explicit job state through a registry of application-trusted types.
Module types Define types for queues.
Module worker Provide queues operations through WorkerOptions, Worker.

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 Public export names mapped to their defining modules and attributes.
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)

Public export names mapped to their defining modules and attributes.

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