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 console base components and public imports.

Module command Define the metadata and execution hooks shared by console commands.
Package contracts Group the console base contracts components and public imports.
Module listener Provide lifecycle hooks for scheduled task events.
Module scheduler Provide the base declaration interface for application schedules.

From __init__.py:

Class BaseCommand Define the metadata and execution hooks shared by console commands.
Class BaseScheduler Provide the base declaration interface for application schedules.
Class BaseTaskListener Provide lifecycle hooks for scheduled task events.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

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

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'BaseCommand': ('orionis.console.base.command', 'BaseCommand'),
 'BaseScheduler': ('orionis.console.base.scheduler', 'BaseScheduler'),
 'BaseTaskListener': ('orionis.console.base.listener', 'BaseTaskListener')}