Coverage for python/lsst/ctrl/mpexec/cli/script/run.py: 56%
Shortcuts on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
Shortcuts on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
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/>.
22import logging
23from types import SimpleNamespace
25from ... import CmdLineFwk, TaskFactory
27_log = logging.getLogger(__name__)
30def run(
31 do_raise,
32 graph_fixup,
33 init_only,
34 no_versions,
35 processes,
36 start_method,
37 profile,
38 qgraphObj,
39 register_dataset_types,
40 skip_init_writes,
41 timeout,
42 butler_config,
43 input,
44 output,
45 output_run,
46 extend_run,
47 replace_run,
48 prune_replaced,
49 data_query,
50 skip_existing_in,
51 skip_existing,
52 debug,
53 fail_fast,
54 clobber_outputs,
55 mock,
56 mock_configs,
57 **kwargs,
58):
59 """Implements the command line interface `pipetask run` subcommand, should
60 only be called by command line tools and unit test code that test this
61 function.
63 Parameters
64 ----------
65 do_raise : `bool`
66 Raise an exception in the case of an error.
67 graph_fixup : `str`
68 The name of the class or factory method which makes an instance used
69 for execution graph fixup.
70 init_only : `bool`
71 If true, do not actually run; just register dataset types and/or save
72 init outputs.
73 no_versions : `bool`
74 If true, do not save or check package versions.
75 processes : `int`
76 The number of processes to use.
77 start_method : `str` or `None`
78 Start method from `multiprocessing` module, `None` selects the best
79 one for current platform.
80 profile : `str`
81 File name to dump cProfile information to.
82 qgraphObj : `lsst.pipe.base.QuantumGraph`
83 A QuantumGraph generated by a previous subcommand.
84 register_dataset_types : `bool`
85 If true, register DatasetTypes that do not already exist in the
86 Registry.
87 skip_init_writes : `bool`
88 If true, do not write collection-wide 'init output' datasets (e.g.
89 schemas).
90 timeout : `int`
91 Timeout for multiprocessing; maximum wall time (sec).
92 butler_config : `str`, `dict`, or `lsst.daf.butler.Config`
93 If `str`, `butler_config` is the path location of the gen3
94 butler/registry config file. If `dict`, `butler_config` is key value
95 pairs used to init or update the `lsst.daf.butler.Config` instance. If
96 `Config`, it is the object used to configure a Butler.
97 input : `list` [ `str` ]
98 List of names of the input collection(s).
99 output : `str`
100 Name of the output CHAINED collection. This may either be an existing
101 CHAINED collection to use as both input and output (if `input` is
102 `None`), or a new CHAINED collection created to include all inputs
103 (if `input` is not `None`). In both cases, the collection's children
104 will start with an output RUN collection that directly holds all new
105 datasets (see `output_run`).
106 output_run : `str`
107 Name of the new output RUN collection. If not provided then `output`
108 must be provided and a new RUN collection will be created by appending
109 a timestamp to the value passed with `output`. If this collection
110 already exists then `extend_run` must be passed.
111 extend_run : `bool`
112 Instead of creating a new RUN collection, insert datasets into either
113 the one given by `output_run` (if provided) or the first child
114 collection of `output` (which must be of type RUN).
115 replace_run : `bool`
116 Before creating a new RUN collection in an existing CHAINED collection,
117 remove the first child collection (which must be of type RUN). This can
118 be used to repeatedly write to the same (parent) collection during
119 development, but it does not delete the datasets associated with the
120 replaced run unless `prune-replaced` is also True. Requires `output`,
121 and `extend_run` must be `None`.
122 prune_replaced : "unstore", "purge", or `None`.
123 If not `None`, delete the datasets in the collection replaced by
124 `replace_run`, either just from the datastore ("unstore") or by
125 removing them and the RUN completely ("purge"). Requires `replace_run`.
126 data_query : `str`
127 User query selection expression.
128 skip_existing_in : `list` [ `str` ]
129 Accepts list of collections, if all Quantum outputs already exist in
130 the specified list of collections then that Quantum will be excluded
131 from the QuantumGraph.
132 skip_existing : `bool`
133 Appends output RUN collection to the ``skip_existing_in`` list.
134 debug : `bool`
135 If true, enable debugging output using lsstDebug facility (imports
136 debug.py).
137 fail_fast : `bool`
138 If true then stop processing at first error, otherwise process as many
139 tasks as possible.
140 clobber_outputs : `bool`
141 Remove outputs from previous execution of the same quantum before new
142 execution. Only applies to failed quanta if skip_existing is also
143 given.
144 mock : `bool`, optional
145 If `True` then run mock pipeline instead of real one.
146 mock_configs : `list` [ `PipelineAction` ]
147 A list of config overrides for mock tasks.
148 kwargs : `dict` [`str`, `str`]
149 Ignored; click commands may accept options for more than one script
150 function and pass all the option kwargs to each of the script functions
151 which ingore these unused kwargs.
152 """
153 args = SimpleNamespace(
154 do_raise=do_raise,
155 graph_fixup=graph_fixup,
156 init_only=init_only,
157 no_versions=no_versions,
158 processes=processes,
159 start_method=start_method,
160 profile=profile,
161 skip_init_writes=skip_init_writes,
162 timeout=timeout,
163 register_dataset_types=register_dataset_types,
164 butler_config=butler_config,
165 input=input,
166 output=output,
167 output_run=output_run,
168 extend_run=extend_run,
169 replace_run=replace_run,
170 prune_replaced=prune_replaced,
171 data_query=data_query,
172 skip_existing_in=skip_existing_in,
173 skip_existing=skip_existing,
174 enableLsstDebug=debug,
175 fail_fast=fail_fast,
176 clobber_outputs=clobber_outputs,
177 mock=mock,
178 mock_configs=mock_configs,
179 )
181 f = CmdLineFwk()
182 taskFactory = TaskFactory()
183 f.runPipeline(qgraphObj, taskFactory, args)