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

Public Member Functions
None	__set__ (self, ConfigurableActionStruct instance, str|Iterable[str] value)
None	__get__ (self, instance, objtype=None)

Detailed Description

Abstract the logic of removing an iterable of action names from a
`ConfigurableActionStruct` at one time using attribute assignment.

This is useful in the context of setting configuration through pipelines
or on the command line.

Raises
------
AttributeError
    Raised if an attribute specified for removal does not exist in the
    ConfigurableActionStruct

Definition at line 68 of file _configurableActionStructField.py.

Member Function Documentation

__get__()

None lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructRemover.__get__	(		self,
			instance,
			objtype = None )

Definition at line 91 of file _configurableActionStructField.py.

    def __get__(self, instance, objtype=None) -> None:
        # This descriptor does not support fetching any value
        return None
 
 

__set__()

None lsst.pex.config.configurableActions._configurableActionStructField.ConfigurableActionStructRemover.__set__	(		self,
		ConfigurableActionStruct	instance,
		str | Iterable[str]	value )

Definition at line 82 of file _configurableActionStructField.py.

    def __set__(self, instance: ConfigurableActionStruct, value: str | Iterable[str]) -> None:
        # strings are iterable, but not in the way that is intended. If a
        # single name is specified, turn it into a tuple before attempting
        # to remove the attribute
        if isinstance(value, str):
            value = (value,)
        for name in value:
            delattr(instance, name)
 

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pex_config/gba4ed39666+c2a2e4ac27/python/lsst/pex/config/configurableActions/_configurableActionStructField.py