lsst.pex.config.dictField.DictField Class Reference

Inheritance diagram for lsst.pex.config.dictField.DictField:

Public Member Functions
def	__init__
def	validate
def	__set__
def	toDict

Public Attributes
	keytype
	itemtype
	dictCheck
	itemCheck

Static Public Attributes
	DictClass = Dict

Private Member Functions
def	_compare

Detailed Description

Defines a field which is a mapping of values

Both key and item types are restricted to builtin POD types:
    (int, float, complex, bool, str)

Users can provide two check functions:
    dictCheck: used to validate the dict as a whole, and
    itemCheck: used to validate each item individually

For example to define a field which is a mapping from names to int values:

class MyConfig(Config):
    field = DictField(
            doc="example string-to-int mapping field", 
            keytype=str, itemtype=int, 
            default= {})

Definition at line 133 of file dictField.py.

Constructor & Destructor Documentation

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

Definition at line 154 of file dictField.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=Dict, 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 itemtype is not None and itemtype not in self.supportedTypes:
            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