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

26 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2022-12-01 21:12 +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 lsst.pex.config import ConfigField, FieldValidationError 

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

27from lsst.pex.config.callStack import getCallStack 

28 

29from . import ConfigurableAction 

30 

31 

32class ConfigurableActionField(ConfigField): 

33 """`ConfigurableActionField` is a subclass of `~lsst.pex.config.Field` that 

34 allows a single `ConfigurableAction` (or a subclass of thus) to be 

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

36 field for further configuration. 

37 

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

39 `ConfigurableAction` is forgotten. 

40 """ 

41 # These attributes are dynamically assigned when constructing the base 

42 # classes 

43 name: str 

44 

45 def __set__(self, instance, value, at=None, label="assignment"): 

46 if instance._frozen: 

47 raise FieldValidationError(self, instance, 

48 "Cannot modify a frozen Config") 

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

50 

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

52 msg = f"Value {value} is of incorrect type {_typeStr(value)}. Expected {_typeStr(self.dtype)}" 

53 raise FieldValidationError(self, instance, msg) 

54 

55 if at is None: 

56 at = getCallStack() 

57 

58 if isinstance(value, self.dtype): 

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

60 __label=label, **value._storage) 

61 else: 

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

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

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

65 

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

67 if not issubclass(dtype, ConfigurableAction): 

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

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