Coverage for python/lsst/ctrl/mpexec/cli/opt/options.py : 100%

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# (https://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 click
24from lsst.daf.butler.cli.utils import MWOptionDecorator, MWPath, split_commas, unwrap
27butler_config_option = MWOptionDecorator("-b", "--butler-config",
28 help="Location of the gen3 butler/registry config file.")
31data_query_option = MWOptionDecorator("-d", "--data-query",
32 help="User data selection expression.",
33 metavar="QUERY")
36debug_option = MWOptionDecorator("--debug",
37 help="Enable debugging output using lsstDebug facility (imports debug.py).",
38 is_flag=True)
41delete_option = MWOptionDecorator("--delete",
42 callback=split_commas,
43 help="Delete task with given label from pipeline.",
44 multiple=True)
47do_raise_option = MWOptionDecorator("--do-raise",
48 help="Raise an exception on error. (else log a message and continue?)",
49 is_flag=True)
52extend_run_option = MWOptionDecorator("--extend-run",
53 help=unwrap("""Instead of creating a new RUN collection, insert datasets
54 into either the one given by --output-run (if provided) or
55 the first child collection of - -output(which must be of
56 type RUN)."""),
57 is_flag=True)
60graph_fixup_option = MWOptionDecorator("--graph-fixup",
61 help=unwrap("""Name of the class or factory method which makes an
62 instance used for execution graph fixup."""))
65init_only_option = MWOptionDecorator("--init-only",
66 help=unwrap("""Do not actually run; just register dataset types and/or
67 save init outputs. """),
68 is_flag=True)
71input_option = MWOptionDecorator("-i", "--input",
72 callback=split_commas,
73 default=list(),
74 help=unwrap("""Comma-separated names of the input collection(s)."""),
75 metavar="COLLECTION",
76 multiple=True)
78no_versions_option = MWOptionDecorator("--no-versions",
79 help="Do not save or check package versions.",
80 is_flag=True)
83order_pipeline_option = MWOptionDecorator("--order-pipeline",
84 help=unwrap("""Order tasks in pipeline based on their data
85 dependencies, ordering is performed as last step before saving or
86 executing pipeline."""),
87 is_flag=True)
90output_option = MWOptionDecorator("-o", "--output",
91 help=unwrap("""Name of the output CHAINED collection. This may either be an
92 existing CHAINED collection to use as both input and output
93 (incompatible with --input), or a new CHAINED collection created
94 to include all inputs (requires --input). In both cases, the
95 collection's children will start with an output RUN collection
96 that directly holds all new datasets (see --output-run)."""),
97 metavar="COLL")
100output_run_option = MWOptionDecorator("--output-run",
101 help=unwrap("""Name of the new output RUN collection. If not provided
102 then --output must be provided and a new RUN collection will
103 be created by appending a timestamp to the value passed with
104 --output. If this collection already exists then
105 --extend-run must be passed."""),
106 metavar="COLL")
109pipeline_option = MWOptionDecorator("-p", "--pipeline",
110 help="Location of a pipeline definition file in YAML format.",
111 type=MWPath(file_okay=True, dir_okay=False, readable=True))
114pipeline_dot_option = MWOptionDecorator("--pipeline-dot",
115 help=unwrap(""""Location for storing GraphViz DOT representation of a
116 pipeline."""),
117 type=MWPath(writable=True, file_okay=True, dir_okay=False))
120profile_option = MWOptionDecorator("--profile",
121 help="Dump cProfile statistics to file name.",
122 type=MWPath(file_okay=True, dir_okay=False))
125prune_replaced_option = MWOptionDecorator("--prune-replaced",
126 help=unwrap("""Delete the datasets in the collection replaced by
127 --replace-run, either just from the datastore
128 ('unstore') or by removing them and the RUN completely
129 ('purge'). Requires --replace-run."""),
130 type=click.Choice(("unstore", "purge"), case_sensitive=False))
133qgraph_option = MWOptionDecorator("-g", "--qgraph",
134 help=unwrap("""Location for a serialized quantum graph definition (pickle
135 file). If this option is given then all input data options and
136 pipeline-building options cannot be used. Can be a URI."""))
139qgraph_dot_option = MWOptionDecorator("--qgraph-dot",
140 help=unwrap("""Location for storing GraphViz DOT representation of a
141 quantum graph."""),
142 type=MWPath(writable=True, file_okay=True, dir_okay=False))
145register_dataset_types_option = MWOptionDecorator("--register-dataset-types",
146 help=unwrap("""Register DatasetTypes that do not already
147 exist in the Registry."""),
148 is_flag=True)
151replace_run_option = MWOptionDecorator("--replace-run",
152 help=unwrap("""Before creating a new RUN collection in an existing
153 CHAINED collection, remove the first child collection
154 (which must be of type RUN). This can be used to repeatedly
155 write to the same (parent) collection during development,
156 but it does not delete the datasets associated with the
157 replaced run unless --prune-replaced is also passed.
158 Requires --output, and incompatible with --extend-run."""),
159 is_flag=True)
162save_pipeline_option = MWOptionDecorator("-s", "--save-pipeline",
163 help=unwrap("""Location for storing resulting pipeline definition in
164 YAML format."""),
165 type=MWPath(dir_okay=False, file_okay=True, writable=True))
167save_qgraph_option = MWOptionDecorator("-q", "--save-qgraph",
168 help=unwrap("""URI location for storing a serialized quantum graph
169 definition (pickle file)."""))
172save_single_quanta_option = MWOptionDecorator("--save-single-quanta",
173 help=unwrap("""Format string of locations for storing individual
174 quantum graph definition (pickle files). The curly
175 brace {} in the input string will be replaced by a
176 quantum number. Can be a URI."""))
179show_option = MWOptionDecorator("--show",
180 callback=split_commas,
181 help=unwrap("""Dump various info to standard output. Possible items are:
182 `config`, `config=[Task::]<PATTERN>` or
183 `config=[Task::]<PATTERN>:NOIGNORECASE` to dump configuration
184 fields possibly matching given pattern and/or task label;
185 `history=<FIELD>` to dump configuration history for a field, field
186 name is specified as [Task::]<PATTERN>; `dump-config`,
187 `dump-config=Task` to dump complete configuration for a task given
188 its label or all tasks; `pipeline` to show pipeline composition;
189 `graph` to show information about quanta; `workflow` to show
190 information about quanta and their dependency; `tasks` to show
191 task composition; `uri` to show predicted dataset URIs of
192 quanta"""),
193 metavar="ITEM|ITEM=VALUE",
194 multiple=True)
197skip_existing_option = MWOptionDecorator("--skip-existing",
198 help=unwrap("""If all Quantum outputs already exist in the output RUN
199 collection then that Quantum will be excluded from the
200 QuantumGraph. Requires the 'run` command's `--extend-run`
201 flag to be set."""),
202 is_flag=True)
205clobber_partial_outputs_option = MWOptionDecorator("--clobber-partial-outputs",
206 help=unwrap("""Remove incomplete outputs from previous
207 execution of the same quantum before new
208 execution."""),
209 is_flag=True)
212skip_init_writes_option = MWOptionDecorator("--skip-init-writes",
213 help=unwrap("""Do not write collection-wide 'init output' datasets
214 (e.g.schemas)."""),
215 is_flag=True)
218task_option = MWOptionDecorator("-t", "--task",
219 callback=split_commas,
220 help=unwrap("""Task name to add to pipeline, must be a fully qualified task
221 name. Task name can be followed by colon and label name, if label
222 is not given then task base name (class name) is used as
223 label."""),
224 metavar="TASK[:LABEL]",
225 multiple=True)
228timeout_option = MWOptionDecorator("--timeout",
229 type=click.IntRange(min=0),
230 help="Timeout for multiprocessing; maximum wall time (sec).")
233start_method_option = MWOptionDecorator("--start-method",
234 default=None,
235 type=click.Choice(["spawn", "fork", "forkserver"]),
236 help="Multiprocessing start method, default is platform-specific.")
239fail_fast_option = MWOptionDecorator("--fail-fast",
240 help=unwrap("""Stop processing at first error, default is to process
241 as many tasks as possible."""),
242 is_flag=True)