Coverage for python/lsst/pipe/base/taskFactory.py: 100%
9 statements
« prev ^ index » next coverage.py v7.3.2, created at 2023-11-18 10:49 +0000
« prev ^ index » next coverage.py v7.3.2, created at 2023-11-18 10:49 +0000
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/>.
28"""Module defining TaskFactory interface.
29"""
31from __future__ import annotations
33__all__ = ["TaskFactory"]
35from abc import ABCMeta, abstractmethod
36from collections.abc import Iterable
37from typing import TYPE_CHECKING
39if TYPE_CHECKING:
40 from lsst.daf.butler import DatasetRef, LimitedButler
42 from .pipeline import TaskDef
43 from .pipelineTask import PipelineTask
46class TaskFactory(metaclass=ABCMeta):
47 """Abstract base class for task factory.
49 Task factory is responsible for creating instances of PipelineTask
50 subclasses.
51 """
53 @abstractmethod
54 def makeTask(
55 self, taskDef: TaskDef, butler: LimitedButler, initInputRefs: Iterable[DatasetRef] | None
56 ) -> PipelineTask:
57 """Create new PipelineTask instance from its `~lsst.pipe.base.TaskDef`.
59 Parameters
60 ----------
61 taskDef : `~lsst.pipe.base.TaskDef`
62 Task definition structure.
63 butler : `lsst.daf.butler.LimitedButler`
64 Butler instance used to obtain initialization inputs for task.
65 initInputRefs : `~collections.abc.Iterable` of \
66 `~lsst.daf.butler.DatasetRef` or `None`
67 List of resolved dataset references for init inputs for this task.
69 Returns
70 -------
71 task : `PipelineTask`
72 Instance of a PipelineTask class.
74 Raises
75 ------
76 Any exceptions that are raised by PipelineTask constructor or its
77 configuration class are propagated back to caller.
78 """
79 raise NotImplementedError()