|
def | __init__ (self, name, usage="%(prog)s input [options]", kwargs) |
|
def | add_id_argument (self, name, datasetType, help, level=None, doMakeDataRefList=True, ContainerClass=DataIdContainer) |
|
def | parse_args (self, config, args=None, log=None, override=None) |
|
def | handleCamera (self, namespace) |
|
def | convert_arg_line_to_args (self, arg_line) |
|
def | addReuseOption (self, choices) |
|
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`.
Notes
-----
Users may wish to add additional arguments before calling `parse_args`.
Definition at line 361 of file argumentParser.py.
def lsst.pipe.base.argumentParser.ArgumentParser.add_id_argument |
( |
|
self, |
|
|
|
name, |
|
|
|
datasetType, |
|
|
|
help, |
|
|
|
level = None , |
|
|
|
doMakeDataRefList = True , |
|
|
|
ContainerClass = DataIdContainer |
|
) |
| |
Add a data ID argument.
Parameters
----------
name : `str`
Data ID argument (including leading dashes, if wanted).
datasetType : `str` or `DynamicDatasetType`-type
Type of dataset. Supply a string for a fixed dataset type. For a dynamically determined dataset
type, supply a `DynamicDatasetType`, such a `DatasetArgument`.
help : `str`
Help string for the argument.
level : object, optional
Level of dataset, for the `~lsst.daf.persistence.Butler`.
doMakeDataRefList : bool, optional
If `True` (default), construct data references.
ContainerClass : class, optional
Data ID container class to use to contain results; override the default if you need a special
means of computing data references from data IDs
Notes
-----
If ``datasetType`` is an instance of `DatasetArgument`, then add a second argument to specify the
dataset type.
The associated data is put into ``namespace.<dataIdArgument.name>`` as an instance of ContainerClass;
the container includes fields:
- ``idList``: a list of data ID dicts.
- ``refList``: a list of `~lsst.daf.persistence.Butler` data references (empty if
``doMakeDataRefList`` is `False`).
Definition at line 457 of file argumentParser.py.
def lsst.pipe.base.argumentParser.ArgumentParser.addReuseOption |
( |
|
self, |
|
|
|
choices |
|
) |
| |
Add a "--reuse-outputs-from SUBTASK" option to the argument parser.
CmdLineTasks that can be restarted at an intermediate step using outputs
from earlier (but still internal) steps should use this method to allow
the user to control whether that happens when outputs from earlier steps
are present.
Parameters
----------
choices : sequence
A sequence of string names (by convention, top-level subtasks) that
identify the steps that could be skipped when their outputs are
already present. The list is ordered, so when the user specifies
one step on the command line, all previous steps may be skipped as
well. In addition to the choices provided, users may pass "all"
to indicate that all steps may be thus skipped.
When this method is called, the ``namespace`` object returned by
``parse_args`` will contain a ``reuse`` attribute containing a list of
all steps that should be skipped if their outputs are already present.
If no steps should be skipped, the ``reuse`` will be an empty list.
Definition at line 796 of file argumentParser.py.
def lsst.pipe.base.argumentParser.ArgumentParser.parse_args |
( |
|
self, |
|
|
|
config, |
|
|
|
args = None , |
|
|
|
log = None , |
|
|
|
override = None |
|
) |
| |
Parse arguments for a command-line task.
Parameters
----------
config : `lsst.pex.config.Config`
Config for the task being run.
args : `list`, optional
Argument list; if `None` then ``sys.argv[1:]`` is used.
log : `lsst.log.Log`, optional
`~lsst.log.Log` instance; if `None` use the default log.
override : callable, optional
A config override function. It must take the root config object as its only argument and must
modify the config in place. This function is called after camera-specific overrides files are
applied, and before command-line config overrides are applied (thus allowing the user the final
word).
Returns
-------
namespace : `argparse.Namespace`
A `~argparse.Namespace` instance containing fields:
- ``camera``: camera name.
- ``config``: the supplied config with all overrides applied, validated and frozen.
- ``butler``: a `lsst.daf.persistence.Butler` for the data.
- An entry for each of the data ID arguments registered by `add_id_argument`,
the value of which is a `~lsst.pipe.base.DataIdArgument` that includes public elements
``idList`` and ``refList``.
- ``log``: a `lsst.log` Log.
- An entry for each command-line argument, with the following exceptions:
- config is the supplied config, suitably updated.
- configfile, id and loglevel are all missing.
- ``obsPkg``: name of the ``obs_`` package for this camera.
Definition at line 513 of file argumentParser.py.