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