Coverage for python/lsst/ctrl/mpexec/taskFactory.py: 21%
26 statements
« prev ^ index » next coverage.py v7.2.1, created at 2023-03-12 01:56 -0800
« prev ^ index » next coverage.py v7.2.1, created at 2023-03-12 01:56 -0800
1# This file is part of ctrl_mpexec.
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/>.
22"""Module which defines TaskFactory class and related methods.
23"""
25__all__ = ["TaskFactory"]
27import logging
29from lsst.pipe.base import TaskFactory as BaseTaskFactory
30from lsst.daf.butler import DatasetType
32_LOG = logging.getLogger(__name__.partition(".")[2])
35class TaskFactory(BaseTaskFactory):
36 """Class instantiating PipelineTasks.
37 """
38 def makeTask(self, taskClass, label, config, overrides, butler):
39 """Create new PipelineTask instance from its class.
41 Parameters
42 ----------
43 taskClass : type
44 PipelineTask class.
45 label : `str` or `None`
46 The label of the new task; if `None` then use
47 ``taskClass._DefaultName``.
48 config : `pex.Config` or None
49 Configuration object, if ``None`` then use task-defined
50 configuration class to create new instance.
51 overrides : `ConfigOverrides` or None
52 Configuration overrides, this should contain all overrides to be
53 applied to a default task config, including instrument-specific,
54 obs-package specific, and possibly command-line overrides.
55 butler : `lsst.daf.butler.Butler` or None
56 Butler instance used to obtain initialization inputs for
57 PipelineTasks. If None, some PipelineTasks will not be usable
59 Returns
60 -------
61 Instance of a PipelineTask class or None on errors.
63 Raises
64 ------
65 Any exceptions that are raised by PipelineTask constructor or its
66 configuration class are propagated back to caller.
67 """
69 # configuration
70 if config is None:
71 config = taskClass.ConfigClass()
72 if overrides:
73 overrides.applyTo(config)
74 elif overrides is not None:
75 _LOG.warning("Both config and overrides are specified for task %s, overrides are ignored",
76 taskClass.__name__)
78 # if we don't have a butler, try to construct without initInputs;
79 # let PipelineTasks raise if that's impossible
80 if butler is None:
81 initInputs = None
82 else:
83 connections = config.connections.ConnectionsClass(config=config)
84 descriptorMap = {}
85 for name in connections.initInputs:
86 attribute = getattr(connections, name)
87 dsType = DatasetType(attribute.name, butler.registry.dimensions.extract(set()),
88 attribute.storageClass)
89 descriptorMap[name] = dsType
90 initInputs = {k: butler.get(v) for k, v in descriptorMap.items()}
92 # Freeze the config
93 config.freeze()
95 # make task instance
96 task = taskClass(config=config, initInputs=initInputs, name=label)
98 return task