augur.argparse_ module

Custom helpers for the argparse standard library.

class augur.argparse_.ExtendOverwriteDefault(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: Action

Similar to the core argparse extend action, but overwrites the argument default, if any, instead of appending to it.

Thus, the default value is not included when the option is given and may be a non-list value if desired.

class augur.argparse_.HelpFormatter(prog, indent_increment=2, max_help_position=24, width=None)

Bases: ArgumentDefaultsHelpFormatter

add_arguments(actions)
class augur.argparse_.HideAsFalseAction(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: Action

Custom argparse Action that stores False for arguments passed as --hide* and stores True for all other argument patterns.

augur.argparse_.add_command_subparsers(subparsers, commands, command_attribute='__command__')

Add subparsers for each command module.

Parameters:

  • subparsers (argparse._SubParsersAction) -- The special subparsers action object created by the parent parser via parser.add_subparsers().

  • commands (list[types.ModuleType]) -- A list of modules that are commands that require their own subparser. Each module is required to have a register_parser function to add its own subparser and arguments.

  • command_attribute (str, optional) -- Optional attribute name for the commands. The default is __command__, which allows top level augur to run commands directly via args.__command__.run().

augur.argparse_.add_default_command(parser)

Sets the default command to run when none is provided.

augur.argparse_.add_subparser(parent_subparsers, *args, **kwargs)

Add a subparser to a parent subparser.

Return type:

ArgumentParser

augur.argparse_.add_validation_arguments(parser)

Add arguments to configure validation mode of node data JSON files.

augur.argparse_.walk_commands(parser, command=None)
Return type:

Iterable[Tuple[Tuple[str, ...], ArgumentParser]]