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.

Explore modules View classes

orionis.console.base.contracts.command.IBaseCommand

class documentation

class IBaseCommand(ABC): (source)

Known subclasses: orionis.console.base.BaseCommand

View In Hierarchy

Undocumented

Method getArgument Retrieve the value of a command-line argument by key, with optional default.
Method getArguments Return all parsed command-line arguments and options.
Async Method handle Run the main logic for the command.
Method setArguments Set the internal arguments dictionary with parsed command-line arguments.
Class Variable arguments Undocumented
Class Variable description Undocumented
Class Variable signature Undocumented
Class Variable timestamps Undocumented
def getArgument(self, key: str, default: Any = None) -> Any: (source)
overridden in orionis.console.base.BaseCommand

Retrieve the value of a command-line argument by key, with optional default.

Parameters
key:strArgument name to retrieve.
default:Any, optionalValue to return if key is not found. Defaults to None.
Returns
AnyValue of the argument if found, else the default value.
Raises
ValueErrorIf key is not a string or internal arguments are not a dictionary.
def getArguments(self) -> dict[str, Any]: (source)
overridden in orionis.console.base.BaseCommand

Return all parsed command-line arguments and options.

Provides direct access to the internal arguments dictionary for the command.

Returns
Dict[str, Any]The dictionary of all parsed arguments and options.
async def handle(self): (source)
overridden in orionis.console.base.BaseCommand

Run the main logic for the command.

This method must be implemented by subclasses to define the command's behavior. It is called after argument parsing and validation.

Returns
NoneNo value is returned. Output should be handled via console methods.
Raises
NotImplementedErrorRaised if not implemented in a subclass.
def setArguments(self, args: dict[str, Any]): (source)
overridden in orionis.console.base.BaseCommand

Set the internal arguments dictionary with parsed command-line arguments.

Parameters
args:Dict[str, Any]Dictionary of parsed command-line arguments and options.
Returns
NoneNo return value.
arguments: ClassVar[list[Argument]] = (source)
overridden in orionis.console.base.BaseCommand

Undocumented

description: ClassVar[str] = (source)
overridden in orionis.console.base.BaseCommand

Undocumented

signature: ClassVar[str] = (source)
overridden in orionis.console.base.BaseCommand

Undocumented

timestamps: ClassVar[bool] = (source)
overridden in orionis.console.base.BaseCommand

Undocumented