Coverage for python/lsst/pipe/tasks/configurableActions/_configurableAction.py: 62%

14 statements  

« prev     ^ index     » next       coverage.py v7.5.0, created at 2024-04-25 00:51 -0700

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__ = ["ConfigurableAction", "ActionTypeVar"] 

24 

25from typing import Any, TypeVar 

26 

27from lsst.pex.config.config import Config 

28 

29 

30ActionTypeVar = TypeVar("ActionTypeVar", bound='ConfigurableAction') 

31 

32 

33class ConfigurableAction(Config): 

34 """A `ConfigurableAction` is an interface that extends a 

35 `lsst.pex.config.Config` class to include a `__call__` method. 

36 

37 This interface is designed to create an action that can be used at 

38 runtime with state that is determined during the configuration stage. A 

39 single action thus may be assigned multiple times, each with different 

40 configurations. 

41 

42 This allows state to be set and recorded at configuration time, 

43 making future reproduction of results easy. 

44 

45 This class is intended to be an interface only, but because of various 

46 inheritance conflicts this class can not be implemented as an Abstract 

47 Base Class. Instead, the `__call__` method is purely virtual, meaning that 

48 it will raise a `NotImplementedError` when called. Subclasses that 

49 represent concrete actions must provide an override. 

50 """ 

51 

52 identity: str | None = None 

53 """If a configurable action is assigned to a `ConfigurableActionField`, or a 

54 `ConfigurableActionStructField` the name of the field will be bound to this 

55 variable when it is retrieved. 

56 """ 

57 

58 def __setattr__(self, attr, value, at=None, label="assignment"): 

59 if attr == 'identity': 

60 return object.__setattr__(self, attr, value) 

61 return super().__setattr__(attr, value, at, label) 

62 

63 def __call__(self, *args: Any, **kwargs: Any) -> Any: 

64 raise NotImplementedError("This method should be overloaded in subclasses")