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

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 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 <http://www.gnu.org/licenses/>. 

21 

22"""Module defining TaskFactory interface. 

23""" 

24 

25from __future__ import annotations 

26 

27__all__ = ["TaskFactory"] 

28 

29from abc import ABCMeta, abstractmethod 

30from typing import TYPE_CHECKING, Optional, Type 

31 

32if TYPE_CHECKING: 

33 from lsst.daf.butler import Butler 

34 

35 from .config import PipelineTaskConfig 

36 from .configOverrides import ConfigOverrides 

37 from .pipelineTask import PipelineTask 

38 

39 

40class TaskFactory(metaclass=ABCMeta): 

41 """Abstract base class for task factory. 

42 

43 Task factory is responsible for creating instances of PipelineTask 

44 subclasses. 

45 """ 

46 

47 @abstractmethod 

48 def makeTask( 

49 self, 

50 taskClass: Type[PipelineTask], 

51 name: Optional[str], 

52 config: Optional[PipelineTaskConfig], 

53 overrides: Optional[ConfigOverrides], 

54 butler: Optional[Butler], 

55 ) -> PipelineTask: 

56 """Create new PipelineTask instance from its class. 

57 

58 Parameters 

59 ---------- 

60 taskClass : `type` 

61 `PipelineTask` sub-class. 

62 name : `str` or `None` 

63 The name of the new task; if `None` then use 

64 ``taskClass._DefaultName``. 

65 config : `pex.Config` or `None` 

66 Configuration object, if `None` then use task-defined 

67 configuration class (``taskClass.ConfigClass``) to create new 

68 instance. 

69 overrides : `ConfigOverrides` or `None` 

70 Configuration overrides, this should contain all overrides to be 

71 applied to a default task config, including instrument-specific, 

72 obs-package specific, and possibly command-line overrides. This 

73 parameter is exclusive with ``config``, only one of the two can be 

74 specified as not-`None`. 

75 butler : `~lsst.daf.butler.Butler` or None 

76 Butler instance used to obtain initialization inputs for 

77 PipelineTasks. If `None`, some PipelineTasks will not be usable 

78 

79 Returns 

80 ------- 

81 task : `PipelineTask` 

82 Instance of a `PipelineTask` class or `None` on errors. 

83 

84 Raises 

85 ------ 

86 Any exceptions that are raised by PipelineTask constructor or its 

87 configuration class are propagated back to caller. 

88 """