lsst.pex.config.configDictField.ConfigDict Class Reference

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

Public Member Functions
def	__init__ (self, config, field, value, at, label)
def	__setitem__ (self, k, x, at=None, label="setitem", setHistory=True)
def	__delitem__ (self, k, at=None, label="delitem")
def	__getitem__ (self, k)
def	__len__ (self)
def	__iter__ (self)
def	__contains__ (self, k)
def	__delitem__ (self, k, at=None, label="delitem", setHistory=True)
def	__repr__ (self)
def	__str__ (self)
def	__setattr__ (self, attr, value, at=None, label="assignment")

Properties
	history = property(lambda x: x._history)

Detailed Description

Internal representation of a dictionary of configuration classes.

Much like `Dict`, `ConfigDict` is a custom `MutableMapper` which tracks
the history of changes to any of its items.

Definition at line 36 of file configDictField.py.

Constructor & Destructor Documentation

__init__()

def lsst.pex.config.configDictField.ConfigDict.__init__	(		self,
			config,
			field,
			value,
			at,
			label
	)

Definition at line 43 of file configDictField.py.

    def __init__(self, config, field, value, at, label):
        Dict.__init__(self, config, field, value, at, label, setHistory=False)
        self.history.append(("Dict initialized", at, label))
 

Member Function Documentation

__contains__()

def lsst.pex.config.dictField.Dict.__contains__ (   self,   k  )

inherited

Definition at line 83 of file dictField.py.

    def __contains__(self, k):
        return k in self._dict
 

__delitem__() [1/2]

def lsst.pex.config.configDictField.ConfigDict.__delitem__	(		self,
			k,
			at = None,
			label = "delitem"
	)

Definition at line 85 of file configDictField.py.

    def __delitem__(self, k, at=None, label="delitem"):
        if at is None:
            at = getCallStack()
        Dict.__delitem__(self, k, at, label, False)
        self.history.append(("Removed item at key %s" % k, at, label))
 
 

__delitem__() [2/2]

def lsst.pex.config.dictField.Dict.__delitem__ (   self,   k,   at = None,   label = "delitem",   setHistory = True  )

inherited

Definition at line 123 of file dictField.py.

    def __delitem__(self, k, at=None, label="delitem", setHistory=True):
        if self._config._frozen:
            raise FieldValidationError(self._field, self._config,
                                       "Cannot modify a frozen Config")
 
        del self._dict[k]
        if setHistory:
            if at is None:
                at = getCallStack()
            self._history.append((dict(self._dict), at, label))
 

__getitem__()

def lsst.pex.config.dictField.Dict.__getitem__ (   self,   k  )

inherited

Definition at line 74 of file dictField.py.

    def __getitem__(self, k):
        return self._dict[k]
 

__iter__()

def lsst.pex.config.dictField.Dict.__iter__ (   self )

inherited

Definition at line 80 of file dictField.py.

    def __iter__(self):
        return iter(self._dict)
 

__len__()

def lsst.pex.config.dictField.Dict.__len__ (   self )

inherited

Definition at line 77 of file dictField.py.

    def __len__(self):
        return len(self._dict)
 

__repr__()

def lsst.pex.config.dictField.Dict.__repr__ (   self )

inherited

Definition at line 134 of file dictField.py.

    def __repr__(self):
        return repr(self._dict)
 

__setattr__()

def lsst.pex.config.dictField.Dict.__setattr__ (   self,   attr,   value,   at = None,   label = "assignment"  )

inherited

Definition at line 140 of file dictField.py.

    def __setattr__(self, attr, value, at=None, label="assignment"):
        if hasattr(getattr(self.__class__, attr, None), '__set__'):
            # This allows properties to work.
            object.__setattr__(self, attr, value)
        elif attr in self.__dict__ or attr in ["_field", "_config_", "_history", "_dict", "__doc__"]:
            # This allows specific private attributes to work.
            object.__setattr__(self, attr, value)
        else:
            # We throw everything else.
            msg = "%s has no attribute %s" % (_typeStr(self._field), attr)
            raise FieldValidationError(self._field, self._config, msg)
 
 

__setitem__()

def lsst.pex.config.configDictField.ConfigDict.__setitem__	(		self,
			k,
			x,
			at = None,
			label = "setitem",
			setHistory = True
	)

Reimplemented from lsst.pex.config.dictField.Dict.

Definition at line 47 of file configDictField.py.

    def __setitem__(self, k, x, at=None, label="setitem", setHistory=True):
        if self._config._frozen:
            msg = "Cannot modify a frozen Config. "\
                  "Attempting to set item at key %r to value %s" % (k, x)
            raise FieldValidationError(self._field, self._config, msg)
 
        # validate keytype
        k = _autocast(k, self._field.keytype)
        if type(k) != self._field.keytype:
            msg = "Key %r is of type %s, expected type %s" % \
                (k, _typeStr(k), _typeStr(self._field.keytype))
            raise FieldValidationError(self._field, self._config, msg)
 
        # validate itemtype
        dtype = self._field.itemtype
        if type(x) != self._field.itemtype and x != self._field.itemtype:
            msg = "Value %s at key %r is of incorrect type %s. Expected type %s" % \
                (x, k, _typeStr(x), _typeStr(self._field.itemtype))
            raise FieldValidationError(self._field, self._config, msg)
 
        if at is None:
            at = getCallStack()
        name = _joinNamePath(self._config._name, self._field.name, k)
        oldValue = self._dict.get(k, None)
        if oldValue is None:
            if x == dtype:
                self._dict[k] = dtype(__name=name, __at=at, __label=label)
            else:
                self._dict[k] = dtype(__name=name, __at=at, __label=label, **x._storage)
            if setHistory:
                self.history.append(("Added item at key %s" % k, at, label))
        else:
            if x == dtype:
                x = dtype()
            oldValue.update(__at=at, __label=label, **x._storage)
            if setHistory:
                self.history.append(("Modified item at key %s" % k, at, label))
 

__str__()

def lsst.pex.config.dictField.Dict.__str__ (   self )

inherited

Definition at line 137 of file dictField.py.

    def __str__(self):
        return str(self._dict)
 

Property Documentation

history

lsst.pex.config.dictField.Dict.history = property(lambda x: x._history)

staticinherited

Definition at line 70 of file dictField.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pex_config/22.0.1-1-g87000a6+536b1ee016/python/lsst/pex/config/configDictField.py