lsst.pex.config.configDictField.ConfigDict Class Reference

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

Public Member Functions
	__init__ (self, config, field, value, at, label)
	__setitem__ (self, k, x, at=None, label="setitem", setHistory=True)
	__delitem__ (self, k, at=None, label="delitem")

Protected Attributes
	_field
	_config

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.

Parameters
----------
config : `~lsst.pex.config.Config`
    Config to use.
field : `~lsst.pex.config.ConfigDictField`
    Field to use.
value : `~typing.Any`
    Value to store in dict.
at : `list` of `~lsst.pex.config.callStack.StackFrame` or `None`, optional
    Stack frame for history recording. Will be calculated if `None`.
label : `str`, optional
    Label to use for history recording.

Definition at line 36 of file configDictField.py.

Constructor & Destructor Documentation

__init__()

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

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

Definition at line 56 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

__delitem__()

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

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

Definition at line 102 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))
 
 

__setitem__()

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 60 of file configDictField.py.

    def __setitem__(self, k, x, at=None, label="setitem", setHistory=True):
        if self._config._frozen:
            msg = f"Cannot modify a frozen Config. Attempting to set item at key {k!r} to value {x}"
            raise FieldValidationError(self._field, self._config, msg)
 
        # validate keytype
        k = _autocast(k, self._field.keytype)
        if type(k) is not self._field.keytype:
            msg = "Key {!r} is of type {}, expected type {}".format(
                k, _typeStr(k), _typeStr(self._field.keytype)
            )
            raise FieldValidationError(self._field, self._config, msg)
 
        # validate itemtype
        dtype = self._field.itemtype
        if type(x) is not self._field.itemtype and x != self._field.itemtype:
            msg = "Value {} at key {!r} is of incorrect type {}. Expected type {}".format(
                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))
 

Member Data Documentation

_config

lsst.pex.config.configDictField.ConfigDict._config

protected

Definition at line 63 of file configDictField.py.

_field

lsst.pex.config.configDictField.ConfigDict._field

protected

Definition at line 63 of file configDictField.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pex_config/gfbcc870c63+9a11dc8c8f/python/lsst/pex/config/configDictField.py