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 IBaseCommand(ABC): (source)
Known subclasses: orionis.console.base.BaseCommand
Define the contract for base command implementations.
| Method | get |
Retrieve the value of a command-line argument by key, with optional default. |
| Method | get |
Return all parsed command-line arguments and options. |
| Async Method | handle |
Run the main logic for the command. |
| Method | set |
Set the internal arguments dictionary with parsed command-line arguments. |
| Class Variable | arguments |
List of Argument instances defining command-line options and arguments. |
| Class Variable | description |
Human-readable description for documentation and help display. |
| Class Variable | signature |
Command signature string for registration and help text generation. |
| Class Variable | timestamps |
Enable timestamps in console output by default. |
orionis.console.base.BaseCommandRetrieve the value of a command-line argument by key, with optional default.
| Parameters | |
key:str | Argument name to retrieve. |
default:typing.Any, optional | Value to return if key is not found. Defaults to None. |
| Returns | |
typing.Any | Value of the argument if found, else the default value. |
| Raises | |
ValueError | If key is not a string or internal arguments are not a dictionary. |
orionis.console.base.BaseCommandReturn all parsed command-line arguments and options.
Provides direct access to the internal arguments dictionary for the command.
| Returns | |
typing.Dict[str, typing.Any] | The dictionary of all parsed arguments and options. |
orionis.console.base.BaseCommandRun 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 | |
None | No value is returned. Output should be handled via console methods. |
| Raises | |
NotImplementedError | Raised if not implemented in a subclass. |
orionis.console.base.BaseCommandSet the internal arguments dictionary with parsed command-line arguments.
| Parameters | |
args:typing.Dict[str, typing.Any] | Dictionary of parsed command-line arguments and options. |
| Returns | |
None | No return value. |
orionis.console.base.BaseCommandList of Argument instances defining command-line options and arguments.
orionis.console.base.BaseCommandHuman-readable description for documentation and help display.
orionis.console.base.BaseCommandCommand signature string for registration and help text generation.