lsst.pex.config.configurableActions._configurableAction.ConfigurableAction Class Reference

Inheritance diagram for lsst.pex.config.configurableActions._configurableAction.ConfigurableAction:

Public Member Functions
	__setattr__ (self, attr, value, at=None, label="assignment")
Any	__call__ (self, *Any args, **Any kwargs)
ConfigurableAction	copy (self)
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)
	__setattr__ (self, attr, value, at=None, label="assignment")
	__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_)
	__setattr__ (cls, name, value)

Static Public Attributes
str	identity = None

Additional Inherited Members
Protected Member Functions inherited from lsst.pex.config.config.Config
tuple[ResourcePath|None, str]	_filename_to_resource (self, ResourcePathExpression|None filename=None)
	_loadFromString (self, code, root="config", filename=None, extraLocals=None)
	_save (self, outfile)
	_collectImports (self)
	_rename (self, name)
	_fromPython (cls, config_py)
Protected Attributes inherited from lsst.pex.config.config.Config
bool	_frozen = True
	_name = name
Protected Attributes inherited from lsst.pex.config.config.ConfigMeta
dict	_fields = {}
	_source = getStackFrame()
Static Protected Attributes inherited from lsst.pex.config.config.Config
dict	_storage [str, Any]
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

copy()

ConfigurableAction lsst.pex.config.configurableActions._configurableAction.ConfigurableAction.copy

(

self

)

Return a deep copy of this config.

Notes
-----
The returned config object is not frozen, even if the original was.
If a nested config object is copied, it retains the name from its
original hierarchy.

Nested objects are only shared between the new and old configs if they
are not possible to modify via the config's interfaces (e.g. entries
in the the history list are not copied, but the lists themselves are,
so modifications to one copy do not modify the other).

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

---

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

• python/lsst/pex/config/configurableActions/_configurableAction.py