orionis.console.output.help_command.HelpCommand

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 documentation

class HelpCommand(IHelpCommand): (source)

Undocumented

Static Method	`parseActions`	Parse argparse actions and categorize them.
Static Method	`printActions`	Render CLI help information for a command or show error if parsing failed.

def parseActions(actions: list[argparse.Action]) -> dict[str, Any]: (source) ¶

overrides orionis.console.output.contracts.help_command.IHelpCommand.parseActions

Parse argparse actions and categorize them.

Parameters
actions:`list of argparse.Action`	List of argparse actions to parse.

Returns
`dict[str, Any]`	Dictionary containing categorized actions: help, positionals, optionals, and subcommands.

def printActions(command_name: str, actions: list[argparse.Action], *, is_error: bool = False): (source) ¶

overrides orionis.console.output.contracts.help_command.IHelpCommand.printActions

Render CLI help information for a command or show error if parsing failed.

Parameters
command_name:`str`	Name of the command to display help for.
actions:`list of argparse.Action`	List of argparse actions to render in the help output.
is_error:`bool, optional`	If True, indicates this is an error output (default: False).

Returns
`None`	This method does not return a value; it outputs to the console and exits.