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

Undocumented

Method addFluentCommand Define a new command using the fluent interface.
Async Method all Return all loaded commands.
Async Method get Retrieve a command instance by its signature.
Async Method load Load all command classes and their metadata.
def addFluentCommand(self, signature: str, handler: list[type[Any], str | None]) -> ICommand: (source)

Define a new command using the fluent interface.

Create a command with the given signature and handler. The handler must be a list containing the class and optionally the method name. Validate input types and conventions. Return the created ICommand instance.

Parameters
signature:strUnique identifier for the command.
handler:list of AnyList containing the class and optionally the method name.
Returns
ICommandThe created FluentCommand instance.
Raises
TypeErrorIf the signature is not a string or the handler is not a valid list.
ValueErrorIf the signature does not meet naming conventions.
async def all(self) -> dict[str, Command]: (source)

Return all loaded commands.

Returns
dict[str, Command]A dictionary mapping command signatures to Command instances.
async def get(self, signature: str) -> Command | None: (source)

Retrieve a command instance by its signature.

Parameters
signature:strThe unique signature identifying the command.
Returns
Command | NoneThe Command instance if found, otherwise None.
async def load(self): (source)

Load all command classes and their metadata.

This method loads command metadata from cache if available, otherwise discovers core commands, custom commands, and fluent commands. It then builds Command instances for each command and populates the internal commands dictionary.

Returns
NoneThis method populates the internal commands dictionary and does not return a value.