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)

Static Public Attributes
str	identity = None

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.

Definition at line 32 of file _configurableAction.py.

Member Function Documentation

__call__()

Any lsst.pex.config.configurableActions._configurableAction.ConfigurableAction.__call__	(		self,
		*Any	args,
		**Any	kwargs )

Reimplemented in 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, lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction, lsst.pipe.tasks.dataFrameActions._actions.CoordColumn, lsst.pipe.tasks.dataFrameActions._actions.SingleColumnAction, lsst.pipe.tasks.dataFrameActions._actions.NanoJansky, lsst.pipe.tasks.dataFrameActions._actions.AddColumn, lsst.pipe.tasks.dataFrameActions._actions.NanoJanskyErr, lsst.pipe.tasks.dataFrameActions._actions.MagColumnDN, and lsst.pipe.tasks.dataFrameActions._actions.MagColumnNanoJansky.

Definition at line 63 of file _configurableAction.py.

    def __call__(self, *args: Any, **kwargs: Any) -> Any:
        raise NotImplementedError("This method should be overloaded in subclasses")

__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.

Definition at line 58 of file _configurableAction.py.

    def __setattr__(self, attr, value, at=None, label="assignment"):
        if attr == "identity":
            return object.__setattr__(self, attr, value)
        return super().__setattr__(attr, value, at, label)
 

Member Data Documentation

identity

str lsst.pex.config.configurableActions._configurableAction.ConfigurableAction.identity = None

static

Definition at line 51 of file _configurableAction.py.

---

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/_configurableAction.py