lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct Class Reference

Inheritance diagram for lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct:

Public Member Functions
	__init__ (self, Config config, ConfigurableActionStructField field, Mapping[str, ConfigurableAction] value, Any at, str label)
list[tuple]	history (self)
Iterable[str]	fieldNames (self)
None	__setattr__ (self, str attr, ActionTypeVar|type[ActionTypeVar] value, at=None, label="setattr", setHistory=False)
Any	__getattr__ (self, attr)
	__delattr__ (self, name)
Iterator[ActionTypeVar]	__iter__ (self)
Iterable[tuple[str, ActionTypeVar]]	items (self)
bool	__bool__ (self)

Public Attributes
	history
	fieldNames

Static Public Attributes
	update = ConfigurableActionStructUpdater()
	remove = ConfigurableActionStructRemover()

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

Protected Attributes
	_config
	_field = f"Cannot modify a frozen Config. Attempting to set item {attr} to value {value}"

Static Protected Attributes
weakref	_config_ .ref
dict	_attrs [str, ActionTypeVar]
list	_history [tuple]

Detailed Description

A ConfigurableActionStruct is the storage backend class that supports
the ConfigurableActionStructField. This class should not be created
directly.

This class allows managing a collection of `ConfigurableAction` with a
struct like interface, that is to say in an attribute like notation.

Parameters
----------
config : `~lsst.pex.config.Config`
    Config to use.
field : `ConfigurableActionStructField`
    Field to use.
value : `~collections.abc.Mapping` [`str`, `ConfigurableAction`]
    Value to assign.
at : `list` of `~lsst.pex.config.callStack.StackFrame` or `None`, optional
    Stack frames to use for history recording.
label : `str`, optional
    Label to use for history recording.

Notes
-----
Attributes can be dynamically added or removed as such:

.. code-block:: python

    ConfigurableActionStructInstance.variable1 = a_configurable_action
    del ConfigurableActionStructInstance.variable1

Each action is then available to be individually configured as a normal
`lsst.pex.config.Config` object.

`ConfigurableActionStruct` supports two special convenience attributes.

The first is ``update``. You may assign a dict of `ConfigurableAction` or a
`ConfigurableActionStruct` to this attribute which will update the
`ConfigurableActionStruct` on which the attribute is invoked such that it
will be updated to contain the entries specified by the structure on the
right hand side of the equals sign.

The second convenience attribute is named ``remove``. You may assign an
iterable of strings which correspond to attribute names on the
`ConfigurableActionStruct`. All of the corresponding attributes will then
be removed. If any attribute does not exist, an `AttributeError` will be
raised. Any attributes in the Iterable prior to the name which raises will
have been removed from the `ConfigurableActionStruct`

Definition at line 96 of file _configurableActionStructField.py.

Constructor & Destructor Documentation

__init__()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.__init__	(		self,
		Config	config,
		ConfigurableActionStructField	field,
		Mapping[str, ConfigurableAction]	value,
		Any	at,
		str	label )

Definition at line 155 of file _configurableActionStructField.py.

    ):
        object.__setattr__(self, "_config_", weakref.ref(config))
        object.__setattr__(self, "_attrs", {})
        object.__setattr__(self, "_field", field)
        object.__setattr__(self, "_history", [])
 
        if at is not None:
            self.history.append(("Struct initialized", at, label))
 
        if value is not None:
            for k, v in value.items():
                setattr(self, k, v)
 

Member Function Documentation

__bool__()

bool lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.__bool__

(

self

)

Definition at line 248 of file _configurableActionStructField.py.

    def __bool__(self) -> bool:
        return bool(self._attrs)
 
 

__delattr__()

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.__delattr__	(		self,
			name )

Definition at line 234 of file _configurableActionStructField.py.

    def __delattr__(self, name):
        if name in self._attrs:
            del self._attrs[name]
        else:
            super().__delattr__(name)
 

__getattr__()

Any lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.__getattr__	(		self,
			attr )

Definition at line 226 of file _configurableActionStructField.py.

    def __getattr__(self, attr) -> Any:
        if attr in object.__getattribute__(self, "_attrs"):
            result = self._attrs[attr]
            result.identity = attr
            return result
        else:
            super().__getattribute__(attr)
 

__iter__()

Iterator[ActionTypeVar] lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.__iter__

(

self

)

Definition at line 240 of file _configurableActionStructField.py.

    def __iter__(self) -> Iterator[ActionTypeVar]:
        for name in self.fieldNames:
            yield getattr(self, name)
 

__setattr__()

None lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.__setattr__	(		self,
		str	attr,
		ActionTypeVar | type[ActionTypeVar]	value,
			at = None,
			label = "setattr",
			setHistory = False )

Definition at line 196 of file _configurableActionStructField.py.

    ) -> None:
        if hasattr(self._config, "_frozen") and self._config._frozen:
            msg = f"Cannot modify a frozen Config. Attempting to set item {attr} to value {value}"
            raise FieldValidationError(self._field, self._config, msg)
 
        # verify that someone has not passed a string with a space or leading
        # number or something through the dict assignment update interface
        if not attr.isidentifier():
            raise ValueError("Names used in ConfigurableStructs must be valid as python variable names")
 
        if attr not in (self.__dict__.keys() | type(self).__dict__.keys()):
            base_name = _joinNamePath(self._config._name, self._field.name)
            name = _joinNamePath(base_name, attr)
            if at is None:
                at = getCallStack()
            if isinstance(value, ConfigurableAction):
                valueInst = type(value)(__name=name, __at=at, __label=label, **value._storage)
            else:
                valueInst = value(__name=name, __at=at, __label=label)
            self._attrs[attr] = valueInst
        else:
            super().__setattr__(attr, value)
 

_config()

Config lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct._config ( self )

protected

Definition at line 181 of file _configurableActionStructField.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()

ConfigurableActionStruct lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct._copy ( self, Config config )

protected

Definition at line 175 of file _configurableActionStructField.py.

    def _copy(self, config: Config) -> ConfigurableActionStruct:
        result = ConfigurableActionStruct(config, self._field, self._attrs, at=None, label="copy")
        result.history.extend(self.history)
        return result
 

fieldNames()

Iterable[str] lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.fieldNames

(

self

)

Definition at line 193 of file _configurableActionStructField.py.

    def fieldNames(self) -> Iterable[str]:
        return self._attrs.keys()
 

history()

list[tuple] lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.history

(

self

)

Definition at line 189 of file _configurableActionStructField.py.

    def history(self) -> list[tuple]:
        return self._history
 

items()

Iterable[tuple[str, ActionTypeVar]] lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.items

(

self

)

Definition at line 244 of file _configurableActionStructField.py.

    def items(self) -> Iterable[tuple[str, ActionTypeVar]]:
        for name in self.fieldNames:
            yield name, getattr(self, name)
 

Member Data Documentation

_attrs

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct._attrs [str, ActionTypeVar]

staticprotected

Definition at line 147 of file _configurableActionStructField.py.

_config

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct._config

protected

Definition at line 204 of file _configurableActionStructField.py.

_config_

weakref lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct._config_ .ref

staticprotected

Definition at line 146 of file _configurableActionStructField.py.

_field

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct._field = f"Cannot modify a frozen Config. Attempting to set item {attr} to value {value}"

protected

Definition at line 206 of file _configurableActionStructField.py.

_history

list lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct._history [tuple]

staticprotected

Definition at line 149 of file _configurableActionStructField.py.

fieldNames

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.fieldNames

Definition at line 241 of file _configurableActionStructField.py.

history

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.history

Definition at line 177 of file _configurableActionStructField.py.

remove

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.remove = ConfigurableActionStructRemover()

static

Definition at line 153 of file _configurableActionStructField.py.

update

lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStruct.update = ConfigurableActionStructUpdater()

static

Definition at line 152 of file _configurableActionStructField.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/configurableActions/_configurableActionStructField.py