argparsing#

conditional_help(arg: str, suppress: bool = True) → str#

class HelpFormatter(*args, **kwargs)#: Bases: RawTextHelpFormatter

class Parser(*args, **kwargs)#

Bases: ArgumentParser

convert_arg_line_to_args(arg_line: str) → list[str]#

preparse(args: list[str], addopts: bool = False)#

add_opts_from_environment(argv: list[str]) → None#

parse_known_args(args=None, namespace=None)#

add_command(command: CanarySubcommand, add_help_override: bool = False) → None#: Add one subcommand to this parser.

get_command(cmdname: str) → CanarySubcommand | None#

remove_argument(opt_string)#

get_group(group_name: str)#

add_plugin_argument_group(*args, **kwargs)#

add_plugin_argument(*args, **kwargs)#

static add_main_epilog(parser: Parser) → None#

identity(arg)#

known_commands() → list[str]#

class EnvironmentModification(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)#: Bases: Action

class RegisterPlugin(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)#: Bases: Action

class ConfigMods(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)#: Bases: Action

make_argument_parser(**kwargs)#: Create an basic argument parser without any subcommands added.

safe_loads(arg)#

add_parser_help(p: ArgumentParser) → None#: So we can use consistent capitalization and periods in the help. You must use the add_help=False argument to ArgumentParser or add_parser to use this. Add this first to be consistent with the default argparse output.