orionis.console.core.contracts.reactor.IReactor

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.

Explore modules View classes

class documentation

class IReactor(ABC): (source)

Known subclasses: orionis.console.core.reactor.Reactor

View In Hierarchy

Undocumented

Async Method	`call`	Execute a registered command by its signature.
Method	`command`	Register a fluent command with the given signature and handler.
Async Method	`hasCommand`	Check whether a command signature is registered.
Async Method	`info`	Return registered commands metadata.

@abstractmethod

async def call(self, signature: str, args: list[str] | None = None) -> int: (source) ¶

overridden in orionis.console.core.reactor.Reactor

Execute a registered command by its signature.

Parameters
signature:`str`	Command signature to execute.
args:`list of str or None, optional`	Arguments to pass to the command.

Returns
`int`	The output produced by the command execution.

Raises
`ValueError`	If the command is not found.
`Exception`	If command execution fails.

@abstractmethod

def command(self, signature: str, handler: list[type[Any] | str | None] | str) -> ICommand: (source) ¶

overridden in orionis.console.core.reactor.Reactor

Parameters
signature:`str`	Command signature to register.
handler:`list[type[Any] \| str \| None] \| str`	Handler class and optional method name.

Returns
`ICommand`	The registered command instance.

@abstractmethod

async def hasCommand(self, signature: str) -> bool: (source) ¶

overridden in orionis.console.core.reactor.Reactor

Check whether a command signature is registered.

Parameters
signature:`str`	Command signature to look up.

Returns
`bool`	Whether the signature identifies a registered command.

@abstractmethod

async def info(self) -> list[dict]: (source) ¶

overridden in orionis.console.core.reactor.Reactor

Return registered commands metadata.

Retrieve all loaded commands from the internal registry, skipping internal commands (those with double underscores). Each command is represented as a dictionary containing its signature and description.

Returns
`list of dict`	List of dictionaries with 'signature' and 'description' for each command.