Coverage for python/lsst/ctrl/mpexec/cli/opt/optionGroups.py: 76%
29 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-25 10:28 -0700
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-25 10:28 -0700
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 software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <http://www.gnu.org/licenses/>.
29__all__ = (
30 "butler_options",
31 "coverage_options",
32 "execution_options",
33 "meta_info_options",
34 "pipeline_build_options",
35 "qgraph_options",
36 "run_options",
37)
40import click
41import lsst.daf.butler.cli.opt as dafButlerOpts
42import lsst.pipe.base.cli.opt as pipeBaseOpts
43from lsst.daf.butler.cli.opt import transfer_option_no_short
44from lsst.daf.butler.cli.utils import OptionGroup, option_section, unwrap
46from . import options as ctrlMpExecOpts
48instrumentOptionHelp = (
49 "Add an instrument which will be used to load config overrides when "
50 "defining a pipeline. This must be the fully qualified class name."
51)
54class pipeline_build_options(OptionGroup): # noqa: N801
55 """Decorator to add options to the command function for building a
56 pipeline.
57 """
59 def __init__(self) -> None:
60 self.decorators = [
61 option_section(sectionText="Pipeline build options:"),
62 ctrlMpExecOpts.pipeline_option(),
63 ctrlMpExecOpts.task_option(),
64 ctrlMpExecOpts.delete_option(metavar="LABEL"),
65 dafButlerOpts.config_option(metavar="LABEL:NAME=VALUE", multiple=True),
66 dafButlerOpts.config_file_option(
67 help=unwrap(
68 """Configuration override file(s), applies to a task
69 with a given label."""
70 ),
71 metavar="LABEL:FILE",
72 multiple=True,
73 ),
74 ctrlMpExecOpts.order_pipeline_option(),
75 ctrlMpExecOpts.save_pipeline_option(),
76 ctrlMpExecOpts.pipeline_dot_option(),
77 pipeBaseOpts.instrument_option(help=instrumentOptionHelp, metavar="instrument", multiple=True),
78 ctrlMpExecOpts.butler_config_option(required=False),
79 ]
82class coverage_options(OptionGroup): # noqa: N801
83 """Decorator to add options to the command function for test coverage."""
85 def __init__(self) -> None:
86 self.decorators = [
87 option_section(sectionText="Coverage options:"),
88 ctrlMpExecOpts.coverage_option(),
89 ctrlMpExecOpts.coverage_report_option(),
90 ctrlMpExecOpts.coverage_packages_option(),
91 ]
94class qgraph_options(OptionGroup): # noqa: N801
95 """Decorator to add options to a command function for creating a quantum
96 graph.
97 """
99 def __init__(self) -> None:
100 self.decorators = [
101 option_section(sectionText="Quantum graph building options:"),
102 ctrlMpExecOpts.qgraph_option(),
103 ctrlMpExecOpts.qgraph_id_option(),
104 ctrlMpExecOpts.qgraph_node_id_option(),
105 ctrlMpExecOpts.qgraph_datastore_records_option(),
106 ctrlMpExecOpts.skip_existing_in_option(),
107 ctrlMpExecOpts.skip_existing_option(),
108 ctrlMpExecOpts.clobber_outputs_option(),
109 ctrlMpExecOpts.save_qgraph_option(),
110 ctrlMpExecOpts.save_single_quanta_option(),
111 ctrlMpExecOpts.qgraph_dot_option(),
112 ctrlMpExecOpts.summary_option(),
113 ctrlMpExecOpts.save_execution_butler_option(),
114 ctrlMpExecOpts.clobber_execution_butler_option(),
115 ctrlMpExecOpts.target_datastore_root_option(),
116 transfer_option_no_short(
117 help=unwrap(
118 """Data transfer mode for the execution butler datastore.
119 Defaults to "copy" if --target-datastore-root is provided.
120 """
121 ),
122 ),
123 ctrlMpExecOpts.dataset_query_constraint(),
124 ctrlMpExecOpts.qgraph_header_data_option(),
125 ctrlMpExecOpts.mock_option(),
126 ctrlMpExecOpts.mock_failure_option(),
127 ctrlMpExecOpts.unmocked_dataset_types_option(),
128 coverage_options(),
129 ]
132class butler_options(OptionGroup): # noqa: N801
133 """Decorator to add options to a command function for configuring a
134 butler.
135 """
137 def __init__(self) -> None:
138 self.decorators = [
139 option_section(sectionText="Data repository and selection options:"),
140 ctrlMpExecOpts.butler_config_option(required=True),
141 ctrlMpExecOpts.input_option(),
142 ctrlMpExecOpts.output_option(),
143 ctrlMpExecOpts.output_run_option(),
144 ctrlMpExecOpts.extend_run_option(),
145 ctrlMpExecOpts.replace_run_option(),
146 ctrlMpExecOpts.prune_replaced_option(),
147 ctrlMpExecOpts.data_query_option(),
148 ctrlMpExecOpts.rebase_option(),
149 ]
152class execution_options(OptionGroup): # noqa: N801
153 """Decorator to add options to a command function for executing a
154 pipeline.
155 """
157 def __init__(self) -> None:
158 self.decorators = [
159 option_section(sectionText="Execution options:"),
160 ctrlMpExecOpts.clobber_outputs_option(),
161 ctrlMpExecOpts.pdb_option(),
162 ctrlMpExecOpts.profile_option(),
163 dafButlerOpts.processes_option(),
164 ctrlMpExecOpts.start_method_option(),
165 ctrlMpExecOpts.timeout_option(),
166 ctrlMpExecOpts.fail_fast_option(),
167 ctrlMpExecOpts.graph_fixup_option(),
168 ctrlMpExecOpts.summary_option(),
169 ctrlMpExecOpts.enable_implicit_threading_option(),
170 ctrlMpExecOpts.cores_per_quantum_option(),
171 ctrlMpExecOpts.memory_per_quantum_option(),
172 ]
175class meta_info_options(OptionGroup): # noqa: N801
176 """Decorator to add options to a command function for managing pipeline
177 meta information.
178 """
180 def __init__(self) -> None:
181 self.decorators = [
182 option_section(sectionText="Meta-information output options:"),
183 ctrlMpExecOpts.skip_init_writes_option(),
184 ctrlMpExecOpts.init_only_option(),
185 dafButlerOpts.register_dataset_types_option(),
186 ctrlMpExecOpts.no_versions_option(),
187 ]
190class run_options(OptionGroup): # noqa: N801
191 """Decorator to add the run options to the run command."""
193 def __init__(self) -> None:
194 self.decorators = [
195 click.pass_context,
196 ctrlMpExecOpts.debug_option(),
197 ctrlMpExecOpts.show_option(),
198 pipeline_build_options(),
199 qgraph_options(),
200 butler_options(),
201 execution_options(),
202 meta_info_options(),
203 coverage_options(),
204 option_section(sectionText=""),
205 dafButlerOpts.options_file_option(),
206 ]