orionis.console.fluent.Command

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 Command(ICommand): (source)

Constructor: Command(signature, concrete, method)

View In Hierarchy

Undocumented

Method	`__init__`	Initialize Command instance with signature, concrete class, and method.
Method	`arguments`	Set CLI arguments for the command.
Method	`description`	Set description for the command.
Method	`get`	Retrieve configured Command entity.
Method	`timestamp`	Configure timestamp display for command output.
Instance Variable	`__arguments`	Undocumented
Instance Variable	`__concrete`	Undocumented
Instance Variable	`__description`	Undocumented
Instance Variable	`__method`	Undocumented
Instance Variable	`__signature`	Undocumented
Instance Variable	`__timestamp`	Undocumented

def __init__(self, signature: str, concrete: Callable[..., Any], method: str = 'handle'): (source) ¶

Initialize Command instance with signature, concrete class, and method.

Validate input parameters and set up internal state for command execution.

Parameters
signature:`str`	Command signature for CLI invocation.
concrete:`Callable[..., Any]`	Class implementing command logic.
method:`str, default 'handle'`	Method name to execute in concrete class.

Returns
`None`	This constructor does not return a value.

Raises
`TypeError`	If concrete is not a class or method is not a string.
`AttributeError`	If method does not exist or is not callable in concrete class.

def arguments(self, args: list[Argument]) -> Self: (source) ¶

overrides orionis.console.fluent.contracts.command.ICommand.arguments

Set CLI arguments for the command.

Configure accepted command-line arguments.

Parameters
args:`list`	List of Argument instances.

Returns
`Command`	Returns self for method chaining.

Raises
`TypeError`	If args is not a list or contains non-Argument elements.

def description(self, desc: str) -> Self: (source) ¶

overrides orionis.console.fluent.contracts.command.ICommand.description

Set description for the command.

Assign a descriptive text for help and documentation.

Parameters
desc:`str`	Description text for the command.

Returns
`Command`	Returns self for method chaining.

Raises
`TypeError`	If desc is not a string.

def get(self) -> tuple[str, CommandEntity]: (source) ¶

overrides orionis.console.fluent.contracts.command.ICommand.get

Retrieve configured Command entity.

Construct and return CommandEntity with all configuration.

Returns
`tuple of (str, CommandEntity)`	Command signature and CommandEntity instance.

def timestamp(self, *, enabled: bool = True) -> Self: (source) ¶

overrides orionis.console.fluent.contracts.command.ICommand.timestamp

Configure timestamp display for command output.

Enable or disable timestamps in command results.

Parameters
enabled:`bool, default True`	Enable or disable timestamp display.

Returns
`Command`	Returns self for method chaining.

Raises
`TypeError`	If enabled is not a boolean.

__arguments = (source) ¶

Undocumented

__concrete = (source) ¶

Undocumented

__description = (source) ¶

Undocumented

__method = (source) ¶

Undocumented

__signature = (source) ¶

Undocumented

__timestamp = (source) ¶

Undocumented