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

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

Detailed Description

This descriptor exists to abstract the logic of removing an interable
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 78 of file _configurableActionStructField.py.

Member Function Documentation

__get__()

None lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructRemover.__get__	(		self,
			instance,
			objtype = None
	)

Definition at line 100 of file _configurableActionStructField.py.

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

__set__()

None lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructRemover.__set__	(		self,
		ConfigurableActionStruct	instance,
		Union[str, Iterable[str]]	value
	)

Definition at line 90 of file _configurableActionStructField.py.

                value: Union[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-5.0.1/Linux64/pipe_tasks/g91fc1fa0cf+82a115f028/python/lsst/pipe/tasks/configurableActions/_configurableActionStructField.py