argclz.commands.parse_command_args#

argclz.commands.parse_command_args(parsers, args=None, usage=None, description=None, parse_only=False, system_exit=<class 'SystemExit'>)[source]#

A convenient way to run an ArgumentParser with sub-commands.

Parameters:

  • parsers (ArgumentParser | dict[str, AbstractParser | Type[AbstractParser]]) – dict of command to AbstractParser.

  • args (list[str] | None) – List of strings representing the command-line input (e.g. sys.argv[1:]). If None, defaults to current process args

  • usage (str | None) – Optional usage string to override the auto-generated help

  • description (str | None) – Optional description for the main parser

  • system_exit (Type[BaseException]) – exit when commandline parsed fail.

Returns:

The parser instance that handled the command (or an ArgumentParsingResult if parse_only or system_exit=False)

Return type:

AbstractParser | None