Coverage for python/lsst/ctrl/mpexec/cli/script/run.py : 56%

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