lsst.pipe.tasks g8b9e2231ea+fa07cb600e
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Attributes | List of all members
lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct Class Reference
Inheritance diagram for lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct:

Public Member Functions

def __init__ (self, Config config, ConfigurableActionStructField field, Mapping[str, ConfigurableAction] value, Any at, str label)
 
List[tuple] history (self)
 
Iterable[strfieldNames (self)
 
None __setattr__ (self, str attr, Union[ActionTypeVar, Type[ActionTypeVar]] value, at=None, label='setattr', setHistory=False)
 
Any __getattr__ (self, attr)
 
def __delattr__ (self, name)
 
Iterator[ActionTypeVar] __iter__ (self)
 
Iterable[Tuple[str, ActionTypeVar]] items (self)
 
bool __bool__ (self)
 

Static Public Attributes

ConfigurableActionStructUpdater update = ConfigurableActionStructUpdater()
 
ConfigurableActionStructRemover remove = ConfigurableActionStructRemover()
 

Protected Member Functions

Config _config (self)
 

Static Protected Attributes

weakref _config_ .ref
 
Dict _attrs [str, ActionTypeVar]
 
ConfigurableActionStructField _field
 
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 `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 105 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 146 of file _configurableActionStructField.py.

Member Function Documentation

◆ __bool__()

bool lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.__bool__ (   self)

Definition at line 223 of file _configurableActionStructField.py.

◆ __delattr__()

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

Definition at line 209 of file _configurableActionStructField.py.

◆ __getattr__()

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

Definition at line 201 of file _configurableActionStructField.py.

◆ __iter__()

Iterator[ActionTypeVar] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.__iter__ (   self)

Definition at line 215 of file _configurableActionStructField.py.

◆ __setattr__()

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

Definition at line 175 of file _configurableActionStructField.py.

◆ _config()

Config lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct._config (   self)
protected

Definition at line 160 of file _configurableActionStructField.py.

◆ fieldNames()

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

Definition at line 172 of file _configurableActionStructField.py.

◆ history()

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

Definition at line 168 of file _configurableActionStructField.py.

◆ items()

Iterable[Tuple[str, ActionTypeVar]] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct.items (   self)

Definition at line 219 of file _configurableActionStructField.py.

Member Data Documentation

◆ _attrs

Dict lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct._attrs [str, ActionTypeVar]
staticprotected

Definition at line 138 of file _configurableActionStructField.py.

◆ _config_

weakref lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct._config_ .ref
staticprotected

Definition at line 137 of file _configurableActionStructField.py.

◆ _field

ConfigurableActionStructField lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct._field
staticprotected

Definition at line 139 of file _configurableActionStructField.py.

◆ _history

List lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStruct._history [tuple]
staticprotected

Definition at line 140 of file _configurableActionStructField.py.

◆ remove

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

Definition at line 144 of file _configurableActionStructField.py.

◆ update

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

Definition at line 143 of file _configurableActionStructField.py.


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