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

Bootstrap the console runtime and dispatch command invocations.

Async Method boot Initialize the kernel CLI and register commands with the reactor.
Async Method handle Process and dispatch command line arguments to the appropriate handler.
Constant _HELP_FLAGS Help flags used by KernelCLI.
Constant IGNORE_FLAGS Ignore flags used by KernelCLI.
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable __reactor Create and assign the reactor instance using the application factory.
async def boot(self, application: IApplication): (source)

Initialize the kernel CLI and register commands with the reactor.

Parameters
application:orionis.IApplicationThe application instance used to create the reactor.
Returns
NoneThis method does not return a value.
async def handle(self, args: list[str] | None = None) -> int: (source)

Process and dispatch command line arguments to the appropriate handler.

Parameters
args:list of str, optionalList of command line arguments.
Returns
intThe exit code from the command execution.

Help flags used by KernelCLI.

Value
frozenset(set(['help', '--help', '-h']))

Ignore flags used by KernelCLI.

Value
frozenset(set(['reactor',
               '-c',
               '-m',
               '-',
               '-i',
               '-q',
               '-B',
...
__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

Create and assign the reactor instance using the application factory.