lsst.pex.config gba4ed39666+d28a087814
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pex.config.configurableActions._configurableAction.ConfigurableAction Class Reference
Inheritance diagram for lsst.pex.config.configurableActions._configurableAction.ConfigurableAction:
lsst.pex.config.config.Config lsst.pex.config.config.ConfigMeta lsst.pex.config.configurableActions.tests.ActionTest1 lsst.pex.config.configurableActions.tests.ActionTest2 lsst.pex.config.configurableActions.tests.ActionTest3 lsst.pex.config.configurableActions.tests.TestDivideAction lsst.pex.config.configurableActions.tests.TestSingleColumnAction

Public Member Functions

 __setattr__ (self, attr, value, at=None, label="assignment")
 
Any __call__ (self, *Any args, **Any kwargs)
 
- Public Member Functions inherited from lsst.pex.config.config.Config
 __iter__ (self)
 
 keys (self)
 
 values (self)
 
 items (self)
 
 __contains__ (self, name)
 
 __new__ (cls, *args, **kw)
 
 __reduce__ (self)
 
 setDefaults (self)
 
 update (self, **kw)
 
 load (self, filename, root="config")
 
 loadFromStream (self, stream, root="config", filename=None, extraLocals=None)
 
 loadFromString (self, code, root="config", filename=None, extraLocals=None)
 
 save (self, filename, root="config")
 
 saveToString (self, skipImports=False)
 
 saveToStream (self, outfile, root="config", skipImports=False)
 
 freeze (self)
 
 toDict (self)
 
 names (self)
 
 validate (self)
 
 formatHistory (self, name, **kwargs)
 
 __delattr__ (self, attr, at=None, label="deletion")
 
 __eq__ (self, other)
 
 __ne__ (self, other)
 
 __str__ (self)
 
 __repr__ (self)
 
 compare (self, other, shortcut=True, rtol=1e-8, atol=1e-8, output=None)
 
 __init_subclass__ (cls, **kwargs)
 
- Public Member Functions inherited from lsst.pex.config.config.ConfigMeta
 __init__ (cls, name, bases, dict_)
 

Static Public Attributes

str identity = None
 

Additional Inherited Members

- Protected Member Functions inherited from lsst.pex.config.config.Config
 _save (self, outfile)
 
 _collectImports (self)
 
 _rename (self, name)
 
 _fromPython (cls, config_py)
 
- Protected Attributes inherited from lsst.pex.config.config.Config
 _imports
 
 _frozen
 
 _name
 
- Protected Attributes inherited from lsst.pex.config.config.ConfigMeta
 _fields
 
 _source
 
- Static Protected Attributes inherited from lsst.pex.config.config.Config
dict _storage [str, Any]
 
dict _fields [str, Field]
 
dict _history [str, list[Any]]
 
set _imports [Any]
 
- Properties inherited from lsst.pex.config.config.Config
 history = property(lambda x: x._history)
 

Detailed Description

A `ConfigurableAction` is an interface that extends a
`lsst.pex.config.Config` class to include a ``__call__`` method.

This interface is designed to create an action that can be used at
runtime with a state that is determined during the configuration stage. A
single action thus may be assigned multiple times, each with different
configurations.

This allows state to be set and recorded at configuration time,
making future reproduction of results easy.

This class is intended to be an interface only, but because of various
inheritance conflicts this class can not be implemented as an Abstract
Base Class. Instead, the ``__call__`` method is purely virtual, meaning
that it will raise a `NotImplementedError` when called. Subclasses that
represent concrete actions must provide an override.

Member Function Documentation

◆ __setattr__()

lsst.pex.config.configurableActions._configurableAction.ConfigurableAction.__setattr__ ( self,
attr,
value,
at = None,
label = "assignment" )
Set an attribute (such as a field's value).

Notes
-----
Unlike normal Python objects, `~lsst.pex.config.Config` objects are
locked such that no additional attributes nor properties may be added
to them dynamically.

Although this is not the standard Python behavior, it helps to protect
users from accidentally mispelling a field name, or trying to set a
non-existent field.

Reimplemented from lsst.pex.config.config.Config.


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