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 Attributes
	dtype

Static Public Attributes
str	name

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.

Definition at line 34 of file _configurableActionField.py.

Constructor & Destructor Documentation

__init__()

lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField.__init__	(		self,
			doc,
			dtype = ConfigurableAction,
			default = None,
			check = None,
			deprecated = None )

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

Definition at line 121 of file _configurableActionField.py.

    def __init__(self, doc, dtype=ConfigurableAction, default=None, check=None, deprecated=None):
        if not issubclass(dtype, ConfigurableAction):
            raise ValueError("dtype must be a subclass of ConfigurableAction")
        super().__init__(doc=doc, dtype=dtype, default=default, check=check, deprecated=deprecated)

Member Function Documentation

__get__() [1/3]

Any lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField.__get__	(		self,
		Config	instance,
		Any	owner = None,
		Any	at = None,
		str	label = "default" )

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

Definition at line 100 of file _configurableActionField.py.

    def __get__(self, instance: Config, owner: Any = None, at: Any = None, label: str = "default") -> Any:
        ...
 

__get__() [2/3]

lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField.__get__	(		self,
			instance,
			owner = None,
			at = None,
			label = "default" )

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

Definition at line 103 of file _configurableActionField.py.

    def __get__(self, instance, owner=None, at=None, label="default"):
        result = super().__get__(instance, owner)
        if instance is not None:
            # ignore is due to typing resolved in overloads not translating to
            # type checker not knowing this is not a Field
            result.identity = self.name  # type: ignore
        return result
 

__get__() [3/3]

ConfigurableActionField[ActionTypeVar] lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField.__get__	(		self,
		None	instance,
		Any	owner = None,
		Any	at = None,
		str	label = "default" )

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

Definition at line 94 of file _configurableActionField.py.

    ) -> ConfigurableActionField[ActionTypeVar]:
        ...
 

__set__()

None lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField.__set__	(		self,
		Config	instance,
		ActionTypeVar | type[ActionTypeVar]	value,
		Any	at = None,
		str	label = "assignment" )

Set an attribute on the config instance.

Parameters
----------
instance : `lsst.pex.config.Config`
    The config instance that contains this field.
value : obj
    Value to set on this field.
at : `list` of `~lsst.pex.config.callStack.StackFrame` or `None`,\
        optional
    The call stack (created by
    `lsst.pex.config.callStack.getCallStack`).
label : `str`, optional
    Event label for the history.

Notes
-----
This method is invoked by the owning `lsst.pex.config.Config` object
and should not be called directly.

Derived `~lsst.pex.config.Field` classes may need to override the
behavior. When overriding ``__set__``, `~lsst.pex.config.Field` authors
should follow the following rules:

- Do not allow modification of frozen configs.
- Validate the new value **before** modifying the field. Except if the
  new value is `None`. `None` is special and no attempt should be made
  to validate it until `lsst.pex.config.Config.validate` is called.
- Do not modify the `~lsst.pex.config.Config` instance to contain
  invalid values.
- If the field is modified, update the history of the
  `lsst.pex.config.field.Field` to reflect the changes.

In order to decrease the need to implement this method in derived
`~lsst.pex.config.Field` types, value validation is performed in the
`lsst.pex.config.Field._validateValue`. If only the validation step
differs in the derived `~lsst.pex.config.Field`, it is simpler to
implement `lsst.pex.config.Field._validateValue` than to reimplement
``__set__``. More complicated behavior, however, may require
reimplementation.

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

Definition at line 68 of file _configurableActionField.py.

    ) -> None:
        if instance._frozen:
            raise FieldValidationError(self, instance, "Cannot modify a frozen Config")
        name = _joinNamePath(prefix=instance._name, name=self.name)
 
        if not isinstance(value, self.dtype) and not issubclass(value, self.dtype):
            msg = f"Value {value} is of incorrect type {_typeStr(value)}. Expected {_typeStr(self.dtype)}"
            raise FieldValidationError(self, instance, msg)
 
        if at is None:
            at = getCallStack()
 
        if isinstance(value, self.dtype):
            instance._storage[self.name] = type(value)(__name=name, __at=at, __label=label, **value._storage)
        else:
            instance._storage[self.name] = value(__name=name, __at=at, __label=label)
        history = instance._history.setdefault(self.name, [])
        history.append(("config value set", at, label))
 

save()

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

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

Parameters
----------
outfile : file-like object
    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.

Definition at line 111 of file _configurableActionField.py.

    def save(self, outfile, instance):
        # docstring inherited from parent
        # This is different that the parent class in that this field must
        # serialize which config class is assigned to this field prior to
        # serializing any assignments to that config class's fields.
        value = self.__get__(instance)
        fullname = _joinNamePath(instance._name, self.name)
        outfile.write(f"{fullname}={_typeStr(value)}\n")
        super().save(outfile, instance)
 

Member Data Documentation

dtype

lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField.dtype

Definition at line 79 of file _configurableActionField.py.

name

str lsst.pex.config.configurableActions._configurableActionField.ConfigurableActionField.name

static

Definition at line 66 of file _configurableActionField.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+9664299f35/python/lsst/pex/config/configurableActions/_configurableActionField.py