lsst.pipe.base.argumentParser.ArgumentParser Class Reference

An argument parser for pipeline tasks that is based on argparse.ArgumentParser. More...

Inheritance diagram for lsst.pipe.base.argumentParser.ArgumentParser:

Public Member Functions
def	__init__
	Construct an ArgumentParser. More...
def	add_id_argument
	Add a data ID argument. More...
def	parse_args
	Parse arguments for a pipeline task. More...
def	handleCamera
	Perform camera-specific operations before parsing the command line. More...
def	convert_arg_line_to_args
	Allow files of arguments referenced by @<path> to contain multiple values on each line. More...

Private Member Functions
def	_processDataIds
	Process the parsed data for each data ID argument. More...
def	_applyInitialOverrides
	Apply obs-package-specific and camera-specific config override files, if found. More...

Private Attributes
	_name
	_dataIdArgDict

Detailed Description

An argument parser for pipeline tasks that is based on argparse.ArgumentParser.

Users may wish to add additional arguments before calling parse_args.

Note

• I would prefer to check data ID keys and values as they are parsed, but the required information comes from the butler, so I have to construct a butler before I do this checking. Constructing a butler is slow, so I only want do it once, after parsing the command line, so as to catch syntax errors quickly.

Definition at line 196 of file argumentParser.py.

Constructor & Destructor Documentation

def lsst.pipe.base.argumentParser.ArgumentParser.__init__	(		self,
			name,
			usage = "%(prog)s input [options]",
			kwargs
	)

Construct an ArgumentParser.

Parameters

[in]	name	name of top-level task; used to identify camera-specific override files
[in]	usage	usage string
[in]	**kwargs	additional keyword arguments for argparse.ArgumentParser

Definition at line 207 of file argumentParser.py.

    def __init__(self, name, usage = "%(prog)s input [options]", **kwargs):
        """!Construct an ArgumentParser
        
        @param[in] name     name of top-level task; used to identify camera-specific override files
        @param[in] usage    usage string
        @param[in] **kwargs additional keyword arguments for argparse.ArgumentParser
        """
        self._name = name
        self._dataIdArgDict = {} # Dict of data identifier specifications, by argument name
        argparse.ArgumentParser.__init__(self,
            usage = usage,
            fromfile_prefix_chars = '@',
            epilog = """Notes:
* --config, --configfile, --id, --loglevel and @file may appear multiple times;
    all values are used, in order left to right
* @file reads command-line options from the specified file:
    * data may be distributed among multiple lines (e.g. one option per line)
    * data after # is treated as a comment and ignored
    * blank lines and lines starting with # are ignored
* To specify multiple values for an option, do not use = after the option name:
    * right: --configfile foo bar
    * wrong: --configfile=foo bar
""",
            formatter_class = argparse.RawDescriptionHelpFormatter,
        **kwargs)
        self.add_argument("input",
            help="path to input data repository, relative to $%s" % (DEFAULT_INPUT_NAME,))
        self.add_argument("--calib",
            help="path to input calibration repository, relative to $%s" % (DEFAULT_CALIB_NAME,))
        self.add_argument("--output",
            help="path to output data repository (need not exist), relative to $%s" % (DEFAULT_OUTPUT_NAME,))
        self.add_argument("-c", "--config", nargs="*", action=ConfigValueAction,
            help="config override(s), e.g. -c foo=newfoo bar.baz=3", metavar="NAME=VALUE")
        self.add_argument("-C", "--configfile", dest="configfile", nargs="*", action=ConfigFileAction,
            help="config override file(s)")
        self.add_argument("-L", "--loglevel", nargs="*", action=LogLevelAction,
            help="logging level; supported levels are [debug|warn|info|fatal] or an integer; "
                "trace level is negative log level, e.g. use level -3 for trace level 3",
            metavar="LEVEL|COMPONENT=LEVEL")
        self.add_argument("--debug", action="store_true", help="enable debugging output?")
        self.add_argument("--doraise", action="store_true",
            help="raise an exception on error (else log a message and continue)?")
        self.add_argument("--profile", help="Dump cProfile statistics to filename")
        self.add_argument("--logdest", help="logging destination")
        self.add_argument("--show", nargs="+", default=(),
            help="display the specified information to stdout and quit (unless run is specified).")
        self.add_argument("-j", "--processes", type=int, default=1, help="Number of processes to use")
        self.add_argument("-t", "--timeout", type=float,
                          help="Timeout for multiprocessing; maximum wall time (sec)")
        self.add_argument("--clobber-output", action="store_true", dest="clobberOutput", default=False,
                          help=("remove and re-create the output directory if it already exists "
                                "(safe with -j, but not all other forms of parallel execution)"))
        self.add_argument("--clobber-config", action="store_true", dest="clobberConfig", default=False,
                          help=("backup and then overwrite existing config files instead of checking them "
                                "(safe with -j, but not all other forms of parallel execution)"))