ArgumentParser¶

class lsst.pipe.base.ArgumentParser(name, usage='%(prog)s input [options]', **kwargs)¶

Argument parser for command-line tasks that is based on: argparse.ArgumentParser.

Parameters:	name : `str` Name of top-level task; used to identify camera-specific override files. usage : `str`, optional Command-line usage signature. **kwargs Additional keyword arguments for `argparse.ArgumentParser`.

Deprecated since version v23.0: Gen2 ArgumentParser is no longer supported. This functionality has been disabled.

Methods Summary

`add_argument`(dest, …[, name, name])
`add_argument_group`(args, *kwargs)
`add_mutually_exclusive_group`(**kwargs)
`add_subparsers`(**kwargs)
`convert_arg_line_to_args`(arg_line)
`error`(message)	Prints a usage message incorporating the message to stderr and exits.
`exit`([status, message])
`format_help`()
`format_usage`()
`get_default`(dest)
`parse_args`([args, namespace])
`parse_intermixed_args`([args, namespace])
`parse_known_args`([args, namespace])
`parse_known_intermixed_args`([args, namespace])
`print_help`([file])
`print_usage`([file])
`register`(registry_name, value, object)
`set_defaults`(**kwargs)

Methods Documentation

add_argument(dest, ..., name=value, ...) add_argument(option_string, option_string, ..., name=value, ...)¶

error(message: string)¶

Prints a usage message incorporating the message to stderr and exits.

If you override this in a subclass, it should not return – it should either exit or raise an exception.