lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField Class Reference

Inheritance diagram for lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField:

Public Member Functions
None	__set__ (self, Config instance, ActionTypeVar|type[ActionTypeVar] value, Any at=None, str label="assignment")
ConfigurableActionField[ActionTypeVar]	__get__ (self, None instance, Any owner=None, Any at=None, str label="default")
Any	__get__ (self, Config instance, Any owner=None, Any at=None, str label="default")
	__get__ (self, instance, owner=None, at=None, label="default")
	save (self, outfile, instance)
	__init__ (self, doc, dtype=ConfigurableAction, default=None, check=None, deprecated=None)
Public Member Functions inherited from lsst.pex.config.configField.ConfigField
	__init__ (self, doc, dtype=None, default=None, check=None, deprecated=None)
"ConfigField[FieldTypeVar]"	__get__ (self, None instance, Any owner=None, Any at=None, str label="default")
FieldTypeVar	__get__ (self, Config instance, Any owner=None, Any at=None, str label="default")
	__get__ (self, instance, owner=None, at=None, label="default")
None	__set__ (self, Config instance, FieldTypeVar|None value, Any at=None, str label="assignment")
	rename (self, instance)
	freeze (self, instance)
	toDict (self, instance)
	validate (self, instance)
Public Member Functions inherited from lsst.pex.config.config.Field
	__class_getitem__ (cls, tuple[type,...]|type|ForwardRef params)
	__init__ (self, doc, dtype=None, default=None, check=None, optional=False, deprecated=None)
Field[FieldTypeVar]	__get__ (self, None instance, Any owner=None, Any at=None, str label="default")
FieldTypeVar	__get__ (self, Config instance, Any owner=None, Any at=None, str label="default")
	__get__ (self, instance, owner=None, at=None, label="default")
None	__set__ (self, Config instance, FieldTypeVar|None value, Any at=None, str label="assignment")
	__delete__ (self, instance, at=None, label="deletion")

Additional Inherited Members
Public Attributes inherited from lsst.pex.config.configField.ConfigField
	name
Public Attributes inherited from lsst.pex.config.config.Field
	dtype = dtype
	doc = doc
	deprecated = deprecated
	default = default
	check = check
	optional = optional
	source = source
Static Public Attributes inherited from lsst.pex.config.config.Field
dict	supportedTypes = {str, bool, float, int, complex}
Protected Member Functions inherited from lsst.pex.config.configField.ConfigField
	_collectImports (self, instance, imports)
Any	_copy_storage (self, Config old, Config new)
	_compare (self, instance1, instance2, shortcut, rtol, atol, output)
Protected Member Functions inherited from lsst.pex.config.config.Field
	_setup (self, doc, dtype, default, check, optional, source, deprecated)
	_validateValue (self, value)
Static Protected Member Functions inherited from lsst.pex.config.config.Field
Mapping[str, Any]	_parseTypingArgs (tuple[type,...]|tuple[str,...] params, Mapping[str, Any] kwds)

Detailed Description

`ConfigurableActionField` is a subclass of `~lsst.pex.config.Field` that
allows a single `ConfigurableAction` (or a subclass) to be assigned to it.
The `ConfigurableAction` is then accessed through this field for further
configuration.

Any configuration of this field that is done prior to having a new
`ConfigurableAction` assigned to it is forgotten.

Parameters
----------
doc : `str`
    Documentation string.
dtype : `ConfigurableAction`
    Data type to use for this field.
default : `lsst.pex.config.Config`, optional
    If default is `None`, the field will default to a default-constructed
    instance of ``dtype``. Additionally, to allow for fewer deep-copies,
    assigning an instance of ``ConfigField`` to ``dtype`` itself is
    considered equivalent to assigning a default-constructed sub-config.
    This means that the argument default can be ``dtype``, as well as an
    instance of ``dtype``.
check : `~collections.abc.Callable`, optional
    A callback function that validates the field's value, returning `True`
    if the value is valid, and `False` otherwise.
deprecated : `bool` or `None`, optional
    A description of why this Field is deprecated, including removal date.
    If not `None`, the string is appended to the docstring for this Field.

Member Function Documentation

save()

lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField.save	(		self,
			outfile,
			instance )

Save this field to a file (for internal use only).

Parameters
----------
outfile : `typing.IO`
    A writeable field handle.
instance : `~lsst.pex.config.Config`
    The `~lsst.pex.config.Config` instance that contains this field.

Notes
-----
This method is invoked by the `~lsst.pex.config.Config` object that
contains this field and should not be called directly.

The output consists of the documentation string
(`lsst.pex.config.Field.doc`) formatted as a Python comment. The second
line is formatted as an assignment: ``{fullname}={value}``.

This output can be executed with Python.

Reimplemented from lsst.pex.config.configField.ConfigField.

---

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

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