lsst.pex.config.dictField.Dict Class Reference

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

Public Member Functions
	__init__ (self, Config config, DictField field, Mapping[KeyTypeVar, ItemTypeVar] value, *, list[StackFrame]|None at, str label, bool setHistory=True)
ItemTypeVar	__getitem__ (self, KeyTypeVar k)
int	__len__ (self)
Iterator[KeyTypeVar]	__iter__ (self)
bool	__contains__ (self, Any k)
None	__setitem__ (self, KeyTypeVar k, ItemTypeVar x, Any at=None, str label="setitem", bool setHistory=True)
None	__delitem__ (self, KeyTypeVar k, Any at=None, str label="delitem", bool setHistory=True)
	__repr__ (self)
	__str__ (self)
	__setattr__ (self, attr, value, at=None, label="assignment")
	__reduce__ (self)

Protected Member Functions
Config	_config (self)
Dict	_copy (self, Config config)

Protected Attributes
	_field = field
	_config_ = weakref.ref(config)
dict	_dict = {}
Config	_history = self._config._history.setdefault(self._field.name, [])
	_config

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

Detailed Description

An internal mapping container.

This class emulates a `dict`, but adds validation and provenance.

Parameters
----------
config : `~lsst.pex.config.Config`
    Config to proxy.
field : `~lsst.pex.config.DictField`
    Field to use.
value : `~typing.Any`
    Value to store.
at : `list` of `~lsst.pex.config.callStack.StackFrame`
    Stack frame for history recording. Will be calculated if `None`.
label : `str`, optional
    Label to use for history recording.
setHistory : `bool`, optional
    Whether to append to the history record.

Definition at line 53 of file dictField.py.

Constructor & Destructor Documentation

__init__()

lsst.pex.config.dictField.Dict.__init__	(		self,
		Config	config,
		DictField	field,
		Mapping[KeyTypeVar, ItemTypeVar]	value,
		*	,
		list[StackFrame] | None	at,
		str	label,
		bool	setHistory = True )

Definition at line 74 of file dictField.py.

    ):
        self._field = field
        self._config_ = weakref.ref(config)
        self._dict = {}
        self._history = self._config._history.setdefault(self._field.name, [])
        self.__doc__ = field.doc
        if value is not None:
            try:
                for k in value:
                    # do not set history per-item
                    self.__setitem__(k, value[k], at=at, label=label, setHistory=False)
            except TypeError as e:
                msg = f"Value {value} is of incorrect type {_typeStr(value)}. Mapping type expected."
                raise FieldValidationError(self._field, self._config, msg) from e
        if setHistory:
            self._history.append((dict(self._dict), at, label))
 

Member Function Documentation

__contains__()

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

Definition at line 124 of file dictField.py.

    def __contains__(self, k: Any) -> bool:
        return k in self._dict
 

__delitem__()

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

Definition at line 171 of file dictField.py.

    ) -> None:
        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__()

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

Definition at line 115 of file dictField.py.

    def __getitem__(self, k: KeyTypeVar) -> ItemTypeVar:
        return self._dict[k]
 

__iter__()

Iterator[KeyTypeVar] lsst.pex.config.dictField.Dict.__iter__

(

self

)

Definition at line 121 of file dictField.py.

    def __iter__(self) -> Iterator[KeyTypeVar]:
        return iter(self._dict)
 

__len__()

int lsst.pex.config.dictField.Dict.__len__

(

self

)

Definition at line 118 of file dictField.py.

    def __len__(self) -> int:
        return len(self._dict)
 

__reduce__()

lsst.pex.config.dictField.Dict.__reduce__

(

self

)

Definition at line 201 of file dictField.py.

    def __reduce__(self):
        raise UnexpectedProxyUsageError(
            f"Proxy container for config field {self._field.name} cannot "
            "be pickled; it should be converted to a built-in container before "
            "being assigned to other objects or variables."
        )
 
 

__repr__()

lsst.pex.config.dictField.Dict.__repr__

(

self

)

Definition at line 183 of file dictField.py.

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

__setattr__()

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

Definition at line 189 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 = f"{_typeStr(self._field)} has no attribute {attr}"
            raise FieldValidationError(self._field, self._config, msg)
 

__setitem__()

None lsst.pex.config.dictField.Dict.__setitem__	(		self,
		KeyTypeVar	k,
		ItemTypeVar	x,
		Any	at = None,
		str	label = "setitem",
		bool	setHistory = True )

Definition at line 127 of file dictField.py.

    ) -> None:
        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 = f"Key {k!r} is of type {_typeStr(k)}, expected type {_typeStr(self._field.keytype)}"
            raise FieldValidationError(self._field, self._config, msg)
 
        # validate itemtype
        x = _autocast(x, self._field.itemtype)
        if self._field.itemtype is None:
            if type(x) not in self._field.supportedTypes and x is not None:
                msg = f"Value {x} at key {k!r} is of invalid type {_typeStr(x)}"
                raise FieldValidationError(self._field, self._config, msg)
        else:
            if type(x) is not self._field.itemtype and x is not None:
                msg = (
                    f"Value {x} at key {k!r} is of incorrect type {_typeStr(x)}. "
                    f"Expected type {_typeStr(self._field.itemtype)}"
                )
                raise FieldValidationError(self._field, self._config, msg)
 
        # validate key using keycheck
        if self._field.keyCheck is not None and not self._field.keyCheck(k):
            msg = f"Key {k!r} is not a valid key"
            raise FieldValidationError(self._field, self._config, msg)
 
        # validate item using itemcheck
        if self._field.itemCheck is not None and not self._field.itemCheck(x):
            msg = f"Item at key {k!r} is not a valid value: {x}"
            raise FieldValidationError(self._field, self._config, msg)
 
        if at is None:
            at = getCallStack()
 
        self._dict[k] = x
        if setHistory:
            self._history.append((dict(self._dict), at, label))
 

__str__()

lsst.pex.config.dictField.Dict.__str__

(

self

)

Definition at line 186 of file dictField.py.

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

_config()

Config lsst.pex.config.dictField.Dict._config ( self )

protected

Definition at line 101 of file dictField.py.

    def _config(self) -> Config:
        # Config Fields should never outlive their config class instance
        # assert that as such here
        value = self._config_()
        assert value is not None
        return value
 

_copy()

Dict lsst.pex.config.dictField.Dict._copy ( self, Config config )

protected

Reimplemented in lsst.pex.config.configDictField.ConfigDict.

Definition at line 112 of file dictField.py.

    def _copy(self, config: Config) -> Dict:
        return type(self)(config, self._field, self._dict.copy(), at=None, label="copy", setHistory=False)
 

Member Data Documentation

_config

lsst.pex.config.dictField.Dict._config

protected

Definition at line 96 of file dictField.py.

_config_

lsst.pex.config.dictField.Dict._config_ = weakref.ref(config)

protected

Definition at line 85 of file dictField.py.

_dict

lsst.pex.config.dictField.Dict._dict = {}

protected

Definition at line 86 of file dictField.py.

_field

lsst.pex.config.dictField.Dict._field = field

protected

Definition at line 84 of file dictField.py.

_history

Config lsst.pex.config.dictField.Dict._history = self._config._history.setdefault(self._field.name, [])

protected

Definition at line 87 of file dictField.py.

Property Documentation

history

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

static

Definition at line 108 of file dictField.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/pex_config/gbaa8f7a6c5+38b34f4976/python/lsst/pex/config/dictField.py