lsst.pex.config.configDictField.ConfigDictField Class Reference

Inheritance diagram for lsst.pex.config.configDictField.ConfigDictField:

Public Member Functions
def	__init__
def	rename
def	validate
def	toDict
def	save
def	freeze

Public Attributes
	keytype
	itemtype
	dictCheck
	itemCheck

Static Public Attributes
	DictClass = ConfigDict

Private Member Functions
def	_compare

Detailed Description

Defines a field which is a mapping between a POD and a config class.

This behaves exactly like a DictField with the slight difference that
    itemtype must be an subclass of Config.

This allows config writters to create name-to-config mappings. One use case
is for configuring mappings for dataset types in a butler. In this case,
the dataset type names are arbitrary and user-selected; the mapping 
configurations are known and fixed.

Definition at line 85 of file configDictField.py.

Constructor & Destructor Documentation

def lsst.pex.config.configDictField.ConfigDictField.__init__	(		self,
			doc,
			keytype,
			itemtype,
			default = None,
			optional = False,
			dictCheck = None,
			itemCheck = None
	)

Definition at line 99 of file configDictField.py.

    def __init__(self, doc, keytype, itemtype, default=None, optional=False, dictCheck=None, itemCheck=None):
        source = traceback.extract_stack(limit=2)[0]
        self._setup( doc=doc, dtype=ConfigDict, default=default, check=None, 
                optional=optional, source=source)
        if keytype not in self.supportedTypes:
            raise ValueError("'keytype' %s is not a supported type"%\
                    _typeStr(keytype))
        elif not issubclass(itemtype, Config):
            raise ValueError("'itemtype' %s is not a supported type"%\
                    _typeStr(itemtype))
        if dictCheck is not None and not hasattr(dictCheck, "__call__"):
            raise ValueError("'dictCheck' must be callable")
        if itemCheck is not None and not hasattr(itemCheck, "__call__"):
            raise ValueError("'itemCheck' must be callable")

        self.keytype = keytype
        self.itemtype = itemtype
        self.dictCheck = dictCheck
        self.itemCheck = itemCheck