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

class SchedulerBackend(AsyncIOScheduler): (source)

Constructor: SchedulerBackend(event_loop, timezone)

View In Hierarchy

Bridge native loop callbacks to the framework's awaited shutdown.

Method __init__ Retain the native executor and its shutdown snapshot.
Method __shutdownOnLoop Run shutdown on the owning loop and always retire its timer.
Method _createDefaultExecutor Create the executor through APScheduler's required extension hook.
Method abortStart Release owned stores and executors after partial startup.
Method shutdown Finish native shutdown before returning to a waiting worker thread.
Method takePending Transfer pending job cleanup to the framework shutdown owner.
Instance Variable __executor Native executor whose futures must outlive cancellation requests.
Instance Variable __pending Job futures awaiting transfer to the framework's shutdown owner.
Instance Variable _eventloop Retired owner loop after native shutdown, including failures.
def __init__(self, *, event_loop: asyncio.AbstractEventLoop, timezone: tzinfo): (source)

Retain the native executor and its shutdown snapshot.

Parameters
event_loop:asyncio.AbstractEventLoopLoop owning scheduled jobs and native shutdown.
timezone:datetime.tzinfoTimezone used by the scheduler.
Returns
NoneNo return value.
def __shutdownOnLoop(self, *, wait: bool): (source)

Run shutdown on the owning loop and always retire its timer.

Parameters
wait:boolNative executor shutdown option.
Returns
NoneNo return value.
def _createDefaultExecutor(self) -> _Executor: (source)

Create the executor through APScheduler's required extension hook.

Returns
_ExecutorExecutor retaining the native future registry.
def abortStart(self, primary: BaseException): (source)

Release owned stores and executors after partial startup.

Parameters
primary:BaseExceptionStartup failure retained while cleanup failures are observed.
Returns
NoneNo return value.
def shutdown(self, wait: bool = True): (source)

Finish native shutdown before returning to a waiting worker thread.

Parameters
wait:bool, default TrueNative executor shutdown option.
Returns
NoneNo return value.
Raises
SchedulerNotRunningErrorIf no owning loop remains.
BaseExceptionIf native shutdown fails, preserving the original exception.
def takePending(self) -> tuple[asyncio.Future[object], ...]: (source)

Transfer pending job cleanup to the framework shutdown owner.

Returns
tuple of asyncio.FuturePreviously captured futures, released from this backend's snapshot.

Native executor whose futures must outlive cancellation requests.

Job futures awaiting transfer to the framework's shutdown owner.

_eventloop = (source)

Retired owner loop after native shutdown, including failures.