lsst.pipe.base.argumentParser Namespace Reference

Classes
class	DataIdContainer
	A container for data IDs and associated data references. More...
class	DataIdArgument
	Glorified struct for data about id arguments, used by ArgumentParser.add_id_argument. More...
class	DatasetArgument
	Specify that the dataset type should be a command-line option. More...
class	ArgumentParser
	An argument parser for pipeline tasks that is based on argparse.ArgumentParser. More...
class	ConfigValueAction
	argparse action callback to override config parameters using name=value pairs from the command line More...
class	ConfigFileAction
	argparse action to load config overrides from one or more files More...
class	IdValueAction
	argparse action callback to process a data ID into a dict More...
class	TraceLevelAction
	argparse action to set trace level More...

Functions
def	_fixPath
	Apply environment variable as default root, if present, and abspath. More...
def	getTaskDict
	Get a dictionary of task info for all subtasks in a config. More...
def	obeyShowArgument
	Process arguments specified with –show (but ignores "data") More...
def	showTaskHierarchy
	Print task hierarchy to stdout. More...
def	setDottedAttr
	Like setattr, but accepts hierarchical names, e.g. More...
def	getDottedAttr
	Like getattr, but accepts hierarchical names, e.g. More...
def	dataExists
	Return True if data exists at the current level or any data exists at a deeper level, False otherwise. More...

Variables
list	__all__ = ["ArgumentParser", "ConfigFileAction", "ConfigValueAction", "DataIdContainer", "DatasetArgument"]
string	DEFAULT_INPUT_NAME = "PIPE_INPUT_ROOT"
string	DEFAULT_CALIB_NAME = "PIPE_CALIB_ROOT"
string	DEFAULT_OUTPUT_NAME = "PIPE_OUTPUT_ROOT"
	_pattern

Function Documentation

def lsst.pipe.base.argumentParser._fixPath (   defName,   path  )

private

Apply environment variable as default root, if present, and abspath.

Parameters

[in]	defName	name of environment variable containing default root path; if the environment variable does not exist then the path is relative to the current working directory
[in]	path	path relative to default root path

Returns

abspath: path that has been expanded, or None if the environment variable does not exist and path is None

Definition at line 44 of file argumentParser.py.

def _fixPath(defName, path):
    """!Apply environment variable as default root, if present, and abspath
    
    @param[in] defName  name of environment variable containing default root path;
        if the environment variable does not exist then the path is relative
        to the current working directory
    @param[in] path     path relative to default root path
    @return abspath: path that has been expanded, or None if the environment variable does not exist
        and path is None
    """
    defRoot = os.environ.get(defName)
    if defRoot is None:
        if path is None:
            return None
        return os.path.abspath(path)
    return os.path.abspath(os.path.join(defRoot, path or ""))