Coverage for python/lsst/pipe/tasks/configurableActions/_configurableActionField.py: 33%

43 statements  

« prev     ^ index     » next       coverage.py v6.4.2, created at 2022-07-13 12:29 +0000

1# This file is part of pipe_tasks. 

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 ConfigField, FieldValidationError, Config 

28from lsst.pex.config.config import _typeStr, _joinNamePath 

29from lsst.pex.config.callStack import getCallStack 

30 

31from . import ConfigurableAction, ActionTypeVar 

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 of thus) to be 

37 assigned to it. The `ConfigurableAction` is then accessed through this 

38 field for further configuration. 

39 

40 Any configuration that is done prior to reasignment to a new 

41 `ConfigurableAction` is forgotten. 

42 """ 

43 # These attributes are dynamically assigned when constructing the base 

44 # classes 

45 name: str 

46 

47 def __set__( 

48 self, 

49 instance: Config, 

50 value: ActionTypeVar | type[ActionTypeVar], 

51 at: Any = None, 

52 label: str = "assignment" 

53 ) -> None: 

54 if instance._frozen: 

55 raise FieldValidationError(self, instance, 

56 "Cannot modify a frozen Config") 

57 name = _joinNamePath(prefix=instance._name, name=self.name) 

58 

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) 

62 

63 if at is None: 

64 at = getCallStack() 

65 

66 if isinstance(value, self.dtype): 

67 instance._storage[self.name] = type(value)(__name=name, __at=at, 

68 __label=label, **value._storage) 

69 else: 

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

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

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

73 

74 @overload 

75 def __get__( 

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

77 ) -> "ConfigurableActionField[ActionTypeVar]": 

78 ... 

79 

80 @overload 

81 def __get__( 

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

83 ) -> Any: 

84 ... 

85 

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

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

88 if instance is not None: 

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

90 # type checker not knowing this is not a Field 

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

92 return result 

93 

94 def save(self, outfile, instance): 

95 # docstring inherited from parent 

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

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

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

99 value = self.__get__(instance) 

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

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

102 super().save(outfile, instance) 

103 

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

105 if not issubclass(dtype, ConfigurableAction): 

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

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