Coverage for python/lsst/pex/config/configurableActions/_configurableActionField.py: 41%

43 statements  

« prev     ^ index     » next       coverage.py v7.4.2, created at 2024-02-23 11:29 +0000

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 

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. 

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 

68 def __set__( 

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.name) 

78 

79 if not isinstance(value, self.dtype) and not issubclass(value, self.dtype): 

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.dtype): 

87 instance._storage[self.name] = type(value)(__name=name, __at=at, __label=label, **value._storage) 

88 else: 

89 instance._storage[self.name] = value(__name=name, __at=at, __label=label) 

90 history = instance._history.setdefault(self.name, []) 

91 history.append(("config value set", at, label)) 

92 

93 @overload 

94 def __get__( 

95 self, instance: None, owner: Any = None, at: Any = None, label: str = "default" 

96 ) -> ConfigurableActionField[ActionTypeVar]: 

97 ... 

98 

99 @overload 

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

101 ... 

102 

103 def __get__(self, instance, owner=None, at=None, label="default"): 

104 result = super().__get__(instance, owner) 

105 if instance is not None: 

106 # ignore is due to typing resolved in overloads not translating to 

107 # type checker not knowing this is not a Field 

108 result.identity = self.name # type: ignore 

109 return result 

110 

111 def save(self, outfile, instance): 

112 # docstring inherited from parent 

113 # This is different that the parent class in that this field must 

114 # serialize which config class is assigned to this field prior to 

115 # serializing any assignments to that config class's fields. 

116 value = self.__get__(instance) 

117 fullname = _joinNamePath(instance._name, self.name) 

118 outfile.write(f"{fullname}={_typeStr(value)}\n") 

119 super().save(outfile, instance) 

120 

121 def __init__(self, doc, dtype=ConfigurableAction, default=None, check=None, deprecated=None): 

122 if not issubclass(dtype, ConfigurableAction): 122 ↛ 123line 122 didn't jump to line 123, because the condition on line 122 was never true

123 raise ValueError("dtype must be a subclass of ConfigurableAction") 

124 super().__init__(doc=doc, dtype=dtype, default=default, check=check, deprecated=deprecated)