Coverage for python/lsst/ctrl/mpexec/cli/opt/optionGroups.py : 64%

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/>.
23__all__ = ("butler_options", "execution_options", "meta_info_options", "pipeline_build_options",
24 "qgraph_options")
27from lsst.daf.butler.cli.utils import option_section, unwrap
28import lsst.obs.base.cli.opt as obsBaseOpts
29import lsst.daf.butler.cli.opt as dafButlerOpts
30from . import options as ctrlMpExecOpts
32instrumentOptionHelp = ("Add an instrument which will be used to load config overrides when defining a "
33 "pipeline. This must be the fully qualified class name.")
36class OptionGroup:
37 """Base class for an option group decorator. Requires the option group
38 subclass to have a property called `decorator`."""
40 def __call__(self, f):
41 for decorator in reversed(self.decorators):
42 f = decorator(f)
43 return f
46class pipeline_build_options(OptionGroup): # noqa: N801
47 """Decorator to add options to a command function for building a pipeline.
48 """
50 def __init__(self):
51 self.decorators = [
52 option_section(sectionText="Pipeline build options:"),
53 ctrlMpExecOpts.pipeline_option(),
54 ctrlMpExecOpts.task_option(),
55 ctrlMpExecOpts.delete_option(metavar="LABEL"),
56 dafButlerOpts.config_option(metavar="LABEL:NAME=VALUE", multiple=True),
57 dafButlerOpts.config_file_option(help=unwrap("""Configuration override file(s), applies to a task
58 with a given label."""),
59 metavar="LABEL:FILE",
60 multiple=True),
61 ctrlMpExecOpts.order_pipeline_option(),
62 ctrlMpExecOpts.save_pipeline_option(),
63 ctrlMpExecOpts.pipeline_dot_option(),
64 obsBaseOpts.instrument_option(help=instrumentOptionHelp, metavar="instrument", multiple=True)]
67class qgraph_options(OptionGroup): # noqa: N801
68 """Decorator to add options to a command function for creating a quantum
69 graph."""
71 def __init__(self):
72 self.decorators = [
73 option_section(sectionText="Quantum graph building options:"),
74 ctrlMpExecOpts.qgraph_option(),
75 ctrlMpExecOpts.skip_existing_option(),
76 ctrlMpExecOpts.save_qgraph_option(),
77 ctrlMpExecOpts.save_single_quanta_option(),
78 ctrlMpExecOpts.qgraph_dot_option()]
81class butler_options(OptionGroup): # noqa: N801
82 """Decorator to add options to a command function for configuring a butler.
83 """
85 def __init__(self):
86 self.decorators = [
87 option_section(sectionText="Data repository and selection options:"),
88 ctrlMpExecOpts.butler_config_option(),
89 ctrlMpExecOpts.input_option(),
90 ctrlMpExecOpts.output_option(),
91 ctrlMpExecOpts.output_run_option(),
92 ctrlMpExecOpts.extend_run_option(),
93 ctrlMpExecOpts.replace_run_option(),
94 ctrlMpExecOpts.prune_replaced_option(),
95 ctrlMpExecOpts.data_query_option()]
98class execution_options(OptionGroup): # noqa: N801
99 """Decorator to add options to a command function for executing a pipeline.
100 """
102 def __init__(self):
103 self.decorators = [
104 option_section(sectionText="Execution options:"),
105 ctrlMpExecOpts.clobber_partial_outputs_option(),
106 ctrlMpExecOpts.do_raise_option(),
107 ctrlMpExecOpts.profile_option(),
108 dafButlerOpts.processes_option(),
109 ctrlMpExecOpts.timeout_option(),
110 ctrlMpExecOpts.fail_fast_option(),
111 ctrlMpExecOpts.graph_fixup_option()]
114class meta_info_options(OptionGroup): # noqa: N801
115 """Decorator to add options to a command function for managing pipeline
116 meta information."""
118 def __init__(self):
119 self.decorators = [
120 option_section(sectionText="Meta-information output options:"),
121 ctrlMpExecOpts.skip_init_writes_option(),
122 ctrlMpExecOpts.init_only_option(),
123 ctrlMpExecOpts.register_dataset_types_option(),
124 ctrlMpExecOpts.no_versions_option()]