lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct Class Reference

Public Member Functions
def	__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, Union[ConfigurableAction, Type[ConfigurableAction]] value, at=None, label='setattr', setHistory=False)
def	__getattr__ (self, attr)
def	__delattr__ (self, name)
Iterable[ConfigurableAction]	__iter__ (self)
Iterable[Tuple[str, ConfigurableAction]]	items (self)

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

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 `ConfigurableActions` with a
struct like interface, that is to say in an attribute like notation.

Attributes can be dynamically added or removed as such:

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 convenance attributes.

The first is `update`. You may assign a dict of `ConfigurableActions` 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 88 of file _configurableActionStructField.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 129 of file _configurableActionStructField.py.

                 value: Mapping[str, ConfigurableAction], at: Any, label: str):
        object.__setattr__(self, '_config_', weakref.ref(config))
        object.__setattr__(self, '_attrs', {})
        object.__setattr__(self, '_field', field)
        object.__setattr__(self, '_history', [])
 
        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

__delattr__()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.__delattr__	(		self,
			name
	)

Definition at line 183 of file _configurableActionStructField.py.

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

__getattr__()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.__getattr__	(		self,
			attr
	)

Definition at line 177 of file _configurableActionStructField.py.

    def __getattr__(self, attr):
        if attr in object.__getattribute__(self, '_attrs'):
            return self._attrs[attr]
        else:
            super().__getattribute__(attr)
 

__iter__()

Iterable[ConfigurableAction] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.__iter__

(

self

)

Definition at line 189 of file _configurableActionStructField.py.

    def __iter__(self) -> Iterable[ConfigurableAction]:
        return iter(self._attrs.values())
 

__setattr__()

None lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.__setattr__	(		self,
		str	attr,
		Union[ConfigurableAction, Type[ConfigurableAction]]	value,
			at = None,
			label = 'setattr',
			setHistory = False
	)

Definition at line 157 of file _configurableActionStructField.py.

                    at=None, label='setattr', setHistory=False) -> None:
 
        if hasattr(self._config, '_frozen') and self._config._frozen:
            msg = "Cannot modify a frozen Config. "\
                  f"Attempting to set item {attr} to value {value}"
            raise FieldValidationError(self._field, self._config, msg)
 
        if attr not in (self.__dict__.keys() | type(self).__dict__.keys()):
            name = _joinNamePath(self._config._name, self._field.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)
 

fieldNames()

Iterable[str] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.fieldNames

(

self

)

Definition at line 154 of file _configurableActionStructField.py.

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

history()

List[tuple] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.history

(

self

)

Definition at line 150 of file _configurableActionStructField.py.

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

items()

Iterable[Tuple[str, ConfigurableAction]] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.items

(

self

)

Definition at line 192 of file _configurableActionStructField.py.

    def items(self) -> Iterable[Tuple[str, ConfigurableAction]]:
        return iter(self._attrs.items())
 
 

Member Data Documentation

remove

lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.remove = ConfigurableActionStructRemover()

static

Definition at line 127 of file _configurableActionStructField.py.

update

lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.update = ConfigurableActionStructUpdater()

static

Definition at line 126 of file _configurableActionStructField.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/configurableActions/_configurableActionStructField.py