LSST Applications g063fba187b+fee0456c91,g0f08755f38+ea96e5a5a3,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+90257ff92a,g20f6ffc8e0+ea96e5a5a3,g217e2c1bcf+937a289c59,g28da252d5a+daa7da44eb,g2bbee38e9b+253935c60e,g2bc492864f+253935c60e,g3156d2b45e+6e55a43351,g32e5bea42b+31359a2a7a,g347aa1857d+253935c60e,g35bb328faa+a8ce1bb630,g3a166c0a6a+253935c60e,g3b1af351f3+a8ce1bb630,g3e281a1b8c+c5dd892a6c,g414038480c+416496e02f,g41af890bb2+afe91b1188,g599934f4f4+0db33f7991,g7af13505b9+e36de7bce6,g80478fca09+da231ba887,g82479be7b0+a4516e59e3,g858d7b2824+ea96e5a5a3,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,ga5288a1d22+bc6ab8dfbd,gb58c049af0+d64f4d3760,gc28159a63d+253935c60e,gcab2d0539d+3f2b72788c,gcf0d15dbbd+4ea9c45075,gda6a2b7d83+4ea9c45075,gdaeeff99f8+1711a396fd,ge79ae78c31+253935c60e,gef2f8181fd+3031e3cf99,gf0baf85859+c1f95f4921,gfa517265be+ea96e5a5a3,gfa999e8aa5+17cd334064,w.2024.50
LSST Data Management Base Package
Loading...
Searching...
No Matches
_configurableActionField.py
Go to the documentation of this file.
1# This file is part of pex_config.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21from __future__ import annotations
22
23__all__ = ("ConfigurableActionField",)
24
25from typing import Any, overload
26
27from lsst.pex.config import Config, ConfigField, FieldValidationError
28from lsst.pex.config.callStack import getCallStack
29from lsst.pex.config.config import _joinNamePath, _typeStr
30
31from . import ActionTypeVar, ConfigurableAction
32
33
35 """`ConfigurableActionField` is a subclass of `~lsst.pex.config.Field` that
36 allows a single `ConfigurableAction` (or a subclass) to be assigned to it.
37 The `ConfigurableAction` is then accessed through this field for further
38 configuration.
39
40 Any configuration of this field that is done prior to having a new
41 `ConfigurableAction` assigned to it is forgotten.
42
43 Parameters
44 ----------
45 doc : `str`
46 Documentation string.
47 dtype : `ConfigurableAction`
48 Data type to use for this field.
49 default : `lsst.pex.config.Config`, optional
50 If default is `None`, the field will default to a default-constructed
51 instance of ``dtype``. Additionally, to allow for fewer deep-copies,
52 assigning an instance of ``ConfigField`` to ``dtype`` itself is
53 considered equivalent to assigning a default-constructed sub-config.
54 This means that the argument default can be ``dtype``, as well as an
55 instance of ``dtype``.
56 check : `~collections.abc.Callable`, optional
57 A callback function that validates the field's value, returning `True`
58 if the value is valid, and `False` otherwise.
59 deprecated : `bool` or `None`, optional
60 A description of why this Field is deprecated, including removal date.
61 If not `None`, the string is appended to the docstring for this Field.
62 """
63
64 # These attributes are dynamically assigned when constructing the base
65 # classes
66 name: str
67
69 self,
70 instance: Config,
71 value: ActionTypeVar | type[ActionTypeVar],
72 at: Any = None,
73 label: str = "assignment",
74 ) -> None:
75 if instance._frozen:
76 raise FieldValidationError(self, instance, "Cannot modify a frozen Config")
77 name = _joinNamePath(prefix=instance._name, name=self.namenamenamename)
78
79 if not isinstance(value, self.dtypedtype) and not issubclass(value, self.dtypedtype):
80 msg = f"Value {value} is of incorrect type {_typeStr(value)}. Expected {_typeStr(self.dtype)}"
81 raise FieldValidationError(self, instance, msg)
82
83 if at is None:
84 at = getCallStack()
85
86 if isinstance(value, self.dtypedtype):
87 instance._storage[self.namenamenamename] = type(value)(__name=name, __at=at, __label=label, **value._storage)
88 else:
89 instance._storage[self.namenamenamename] = value(__name=name, __at=at, __label=label)
90 history = instance._history.setdefault(self.namenamenamename, [])
91 history.append(("config value set", at, label))
92
93 @overload
95 self, instance: None, owner: Any = None, at: Any = None, label: str = "default"
96 ) -> ConfigurableActionField[ActionTypeVar]: ...
97
98 @overload
99 def __get__(self, instance: Config, owner: Any = None, at: Any = None, label: str = "default") -> Any: ...
100
101 def __get__(self, instance, owner=None, at=None, label="default"):
102 result = super().__get__(instance, owner)
103 if instance is not None:
104 # ignore is due to typing resolved in overloads not translating to
105 # type checker not knowing this is not a Field
106 result.identity = self.namenamenamename # type: ignore
107 return result
108
109 def save(self, outfile, instance):
110 # docstring inherited from parent
111 # This is different that the parent class in that this field must
112 # serialize which config class is assigned to this field prior to
113 # serializing any assignments to that config class's fields.
115 fullname = _joinNamePath(instance._name, self.namenamenamename)
116 outfile.write(f"{fullname}={_typeStr(value)}\n")
117 super().save(outfile, instance)
118
119 def __init__(self, doc, dtype=ConfigurableAction, default=None, check=None, deprecated=None):
120 if not issubclass(dtype, ConfigurableAction):
121 raise ValueError("dtype must be a subclass of ConfigurableAction")
122 super().__init__(doc=doc, dtype=dtype, default=default, check=check, deprecated=deprecated)
__get__(self, instance, owner=None, at=None, label="default")
Definition config.py:707
FieldTypeVar __get__(self, Config instance, Any owner=None, Any at=None, str label="default")
Definition config.py:705
Field[FieldTypeVar] __get__(self, None instance, Any owner=None, Any at=None, str label="default")
Definition config.py:700
__get__(self, instance, owner=None, at=None, label="default")
"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")
ConfigurableActionField[ActionTypeVar] __get__(self, None instance, Any owner=None, Any at=None, str label="default")
None __set__(self, Config instance, ActionTypeVar|type[ActionTypeVar] value, Any at=None, str label="assignment")
__init__(self, doc, dtype=ConfigurableAction, default=None, check=None, deprecated=None)
Any __get__(self, Config instance, Any owner=None, Any at=None, str label="default")