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

Public Member Functions
def	__init__ (self, name)

def	getDatasetType (self, namespace)

def	addArgument (self, parser, idName)

Public Attributes
	name

Detailed Description

Dataset type specified by a config parameter.

Parameters
----------
name : `str`
    Name of config option whose value is the dataset type.

Definition at line 374 of file argumentParser.py.

Constructor & Destructor Documentation

◆ init()

def lsst.pipe.base.argumentParser.ConfigDatasetType.__init__	(	self,
		name
	)

Definition at line 383 of file argumentParser.py.

     def __init__(self, name):
         DynamicDatasetType.__init__(self)
         self.name = name
  

Member Function Documentation

◆ addArgument()

def lsst.pipe.base.argumentParser.DynamicDatasetType.addArgument	(	self,
		parser,
		idName
	)

inherited

Add a command-line argument to specify dataset type name,
if wanted.

Parameters
----------
parser : `ArgumentParser`
    Argument parser to add the argument to.
idName : `str`
    Name of data ID argument, without the leading ``"--"``,
    e.g. ``"id"``.

Notes
-----
The default implementation does nothing

Reimplemented in lsst.pipe.base.argumentParser.DatasetArgument.

Definition at line 270 of file argumentParser.py.

     def addArgument(self, parser, idName):
         """Add a command-line argument to specify dataset type name,
         if wanted.
  
         Parameters
         ----------
         parser : `ArgumentParser`
             Argument parser to add the argument to.
         idName : `str`
             Name of data ID argument, without the leading ``"--"``,
             e.g. ``"id"``.
  
         Notes
         -----
         The default implementation does nothing
         """
         pass
  

◆ getDatasetType()

def lsst.pipe.base.argumentParser.ConfigDatasetType.getDatasetType	(	self,
		namespace
	)

Return the dataset type as a string, from the appropriate
config field.

Parameters
----------
namespace : `argparse.Namespace`
    Parsed command.

Reimplemented from lsst.pipe.base.argumentParser.DynamicDatasetType.

Definition at line 387 of file argumentParser.py.

     def getDatasetType(self, namespace):
         """Return the dataset type as a string, from the appropriate
         config field.
  
         Parameters
         ----------
         namespace : `argparse.Namespace`
             Parsed command.
         """
         # getattr does not work reliably if the config field name is
         # dotted, so step through one level at a time
         keyList = self.name.split(".")
         value = namespace.config
         for key in keyList:
             try:
                 value = getattr(value, key)
             except KeyError:
                 raise RuntimeError(f"Cannot find config parameter {self.name!r}")
         return value
  
  

Member Data Documentation

◆ name

lsst.pipe.base.argumentParser.ConfigDatasetType.name

Definition at line 385 of file argumentParser.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.4.3/Linux64/pipe_base/22.0.1+94e66cc9ed/python/lsst/pipe/base/argumentParser.py

Public Member Functions

Public Attributes