Coverage for python/lsst/pipe/base/taskFactory.py: 100%

9 statements  

« prev     ^ index     » next       coverage.py v7.5.1, created at 2024-05-11 03:31 -0700

1# This file is part of pipe_base. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://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 software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27 

28"""Module defining TaskFactory interface. 

29""" 

30 

31from __future__ import annotations 

32 

33__all__ = ["TaskFactory"] 

34 

35from abc import ABCMeta, abstractmethod 

36from collections.abc import Iterable 

37from typing import TYPE_CHECKING 

38 

39if TYPE_CHECKING: 

40 from lsst.daf.butler import DatasetRef, LimitedButler 

41 

42 from .pipeline import TaskDef 

43 from .pipeline_graph import TaskNode 

44 from .pipelineTask import PipelineTask 

45 

46 

47class TaskFactory(metaclass=ABCMeta): 

48 """Abstract base class for task factory. 

49 

50 Task factory is responsible for creating instances of PipelineTask 

51 subclasses. 

52 """ 

53 

54 @abstractmethod 

55 def makeTask( 

56 self, 

57 task_node: TaskDef | TaskNode, # TODO: remove TaskDef on DM-40443. 

58 /, 

59 butler: LimitedButler, 

60 initInputRefs: Iterable[DatasetRef] | None, 

61 ) -> PipelineTask: 

62 """Create new PipelineTask instance from its `~lsst.pipe.base.TaskDef`. 

63 

64 Parameters 

65 ---------- 

66 task_node : `~pipeline_graph.TaskNode` or `TaskDef` 

67 Task definition structure. `TaskDef` support is deprecated and 

68 will be removed after v27. 

69 butler : `lsst.daf.butler.LimitedButler` 

70 Butler instance used to obtain initialization inputs for task. 

71 initInputRefs : `~collections.abc.Iterable` of \ 

72 `~lsst.daf.butler.DatasetRef` or `None` 

73 List of resolved dataset references for init inputs for this task. 

74 

75 Returns 

76 ------- 

77 task : `PipelineTask` 

78 Instance of a PipelineTask class. 

79 

80 Raises 

81 ------ 

82 Any exceptions that are raised by PipelineTask constructor or its 

83 configuration class are propagated back to caller. 

84 """ 

85 raise NotImplementedError()