Coverage for python/lsst/pex/config/configurableActions/_configurableActionField.py: 36%
43 statements
« prev ^ index » next coverage.py v7.2.5, created at 2023-05-17 02:32 -0700
« prev ^ index » next coverage.py v7.2.5, created at 2023-05-17 02:32 -0700
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
23__all__ = ("ConfigurableActionField",)
25from typing import Any, overload
27from lsst.pex.config import Config, ConfigField, FieldValidationError
28from lsst.pex.config.callStack import getCallStack
29from lsst.pex.config.config import _joinNamePath, _typeStr
31from . import ActionTypeVar, ConfigurableAction
34class ConfigurableActionField(ConfigField[ActionTypeVar]):
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.
40 Any configuration of this field that is done prior to having a new
41 `ConfigurableAction` assigned to it is forgotten.
42 """
44 # These attributes are dynamically assigned when constructing the base
45 # classes
46 name: str
48 def __set__(
49 self,
50 instance: Config,
51 value: ActionTypeVar | type[ActionTypeVar],
52 at: Any = None,
53 label: str = "assignment",
54 ) -> None:
55 if instance._frozen:
56 raise FieldValidationError(self, instance, "Cannot modify a frozen Config")
57 name = _joinNamePath(prefix=instance._name, name=self.name)
59 if not isinstance(value, self.dtype) and not issubclass(value, self.dtype):
60 msg = f"Value {value} is of incorrect type {_typeStr(value)}. Expected {_typeStr(self.dtype)}"
61 raise FieldValidationError(self, instance, msg)
63 if at is None:
64 at = getCallStack()
66 if isinstance(value, self.dtype):
67 instance._storage[self.name] = type(value)(__name=name, __at=at, __label=label, **value._storage)
68 else:
69 instance._storage[self.name] = value(__name=name, __at=at, __label=label)
70 history = instance._history.setdefault(self.name, [])
71 history.append(("config value set", at, label))
73 @overload
74 def __get__(
75 self, instance: None, owner: Any = None, at: Any = None, label: str = "default"
76 ) -> "ConfigurableActionField[ActionTypeVar]":
77 ...
79 @overload
80 def __get__(self, instance: "Config", owner: Any = None, at: Any = None, label: str = "default") -> Any:
81 ...
83 def __get__(self, instance, owner=None, at=None, label="default"):
84 result = super().__get__(instance, owner)
85 if instance is not None:
86 # ignore is due to typing resolved in overloads not translating to
87 # type checker not knowing this is not a Field
88 result.identity = self.name # type: ignore
89 return result
91 def save(self, outfile, instance):
92 # docstring inherited from parent
93 # This is different that the parent class in that this field must
94 # serialize which config class is assigned to this field prior to
95 # serializing any assignments to that config class's fields.
96 value = self.__get__(instance)
97 fullname = _joinNamePath(instance._name, self.name)
98 outfile.write(f"{fullname}={_typeStr(value)}\n")
99 super().save(outfile, instance)
101 def __init__(self, doc, dtype=ConfigurableAction, default=None, check=None, deprecated=None):
102 if not issubclass(dtype, ConfigurableAction): 102 ↛ 103line 102 didn't jump to line 103, because the condition on line 102 was never true
103 raise ValueError("dtype must be a subclass of ConfigurableAction")
104 super().__init__(doc=doc, dtype=dtype, default=default, check=check, deprecated=deprecated)