LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
lsst.pex.config.configDictField.ConfigDict Class Reference
Inheritance diagram for lsst.pex.config.configDictField.ConfigDict:
lsst.pex.config.dictField.Dict lsst.pex.config.config.Config lsst.pex.config.config.ConfigMeta

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.

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

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.

102 def __delitem__(self, k, at=None, label="delitem"):
103 if at is None:
104 at = getCallStack()
105 Dict.__delitem__(self, k, at, label, False)
106 self.history.append(("Removed item at key %s" % k, at, label))
107
108

◆ __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.

60 def __setitem__(self, k, x, at=None, label="setitem", setHistory=True):
61 if self._config._frozen:
62 msg = f"Cannot modify a frozen Config. Attempting to set item at key {k!r} to value {x}"
63 raise FieldValidationError(self._field, self._config, msg)
64
65 # validate keytype
66 k = _autocast(k, self._field.keytype)
67 if type(k) is not self._field.keytype:
68 msg = "Key {!r} is of type {}, expected type {}".format(
69 k, _typeStr(k), _typeStr(self._field.keytype)
70 )
71 raise FieldValidationError(self._field, self._config, msg)
72
73 # validate itemtype
74 dtype = self._field.itemtype
75 if type(x) is not self._field.itemtype and x != self._field.itemtype:
76 msg = "Value {} at key {!r} is of incorrect type {}. Expected type {}".format(
77 x,
78 k,
79 _typeStr(x),
80 _typeStr(self._field.itemtype),
81 )
82 raise FieldValidationError(self._field, self._config, msg)
83
84 if at is None:
85 at = getCallStack()
86 name = _joinNamePath(self._config._name, self._field.name, k)
87 oldValue = self._dict.get(k, None)
88 if oldValue is None:
89 if x == dtype:
90 self._dict[k] = dtype(__name=name, __at=at, __label=label)
91 else:
92 self._dict[k] = dtype(__name=name, __at=at, __label=label, **x._storage)
93 if setHistory:
94 self.history.append(("Added item at key %s" % k, at, label))
95 else:
96 if x == dtype:
97 x = dtype()
98 oldValue.update(__at=at, __label=label, **x._storage)
99 if setHistory:
100 self.history.append(("Modified item at key %s" % k, at, label))
101

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: