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.BaseCommand

class documentation

class BaseCommand(Console, IBaseCommand): (source)

Constructor: BaseCommand()

View In Hierarchy

Undocumented

Method __init__ Initialize the BaseCommand instance.
Method getArgument Retrieve the value of a command-line argument.
Method getArguments Retrieve all parsed command-line arguments.
Async Method handle Run the main logic for the command.
Method setArguments Set the internal arguments dictionary with the provided arguments.
Class Variable arguments Undocumented
Class Variable description Undocumented
Class Variable signature Undocumented
Class Variable timestamps Undocumented
Instance Variable __arguments__ Undocumented
def __init__(self): (source)

Initialize the BaseCommand instance.

Calls the superclass initializer and sets up the internal argument storage.

Returns
NoneThis method does not return a value.
def getArgument(self, key: str, default: Any | None = None) -> Any | None: (source)
overrides orionis.console.base.contracts.command.IBaseCommand.getArgument

Retrieve the value of a command-line argument.

Parameters
key:strThe name of the argument to retrieve.
default:Any or None, optionalThe value to return if the argument is not present. Defaults to None.
Returns
Any or NoneThe value of the argument if present, otherwise the default value.
def getArguments(self) -> dict[str, Any]: (source)
overrides orionis.console.base.contracts.command.IBaseCommand.getArguments

Retrieve all parsed command-line arguments.

Returns
dict[str, Any]A copy of the dictionary containing all parsed arguments.
async def handle(self): (source)
overrides orionis.console.base.contracts.command.IBaseCommand.handle

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)
overrides orionis.console.base.contracts.command.IBaseCommand.setArguments

Set the internal arguments dictionary with the provided arguments.

Parameters
args:dict[str, Any]Dictionary containing parsed command-line arguments.
Returns
NoneThis method does not return a value.
Raises
TypeErrorIf the provided arguments are not a dictionary.
arguments: ClassVar[list[Argument]] = (source)
overrides orionis.console.base.contracts.command.IBaseCommand.arguments

Undocumented

description: str = (source)
overrides orionis.console.base.contracts.command.IBaseCommand.description

Undocumented

signature: str = (source)
overrides orionis.console.base.contracts.command.IBaseCommand.signature

Undocumented

timestamps: bool = (source)
overrides orionis.console.base.contracts.command.IBaseCommand.timestamps

Undocumented

__arguments__: dict[str, Any] = (source)

Undocumented