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

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/>. 

27 

28 

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) 

38 

39 

40import click 

41 

42import lsst.daf.butler.cli.opt as dafButlerOpts 

43import lsst.pipe.base.cli.opt as pipeBaseOpts 

44from lsst.daf.butler.cli.utils import OptionGroup, option_section, unwrap 

45 

46from . import options as ctrlMpExecOpts 

47 

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) 

52 

53 

54class pipeline_build_options(OptionGroup): # noqa: N801 

55 """Decorator to add options to the command function for building a 

56 pipeline. 

57 """ 

58 

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.save_pipeline_option(), 

75 ctrlMpExecOpts.select_tasks_option(), 

76 ctrlMpExecOpts.pipeline_dot_option(), 

77 ctrlMpExecOpts.pipeline_mermaid_option(), 

78 pipeBaseOpts.instrument_option(help=instrumentOptionHelp, metavar="instrument", multiple=True), 

79 ctrlMpExecOpts.butler_config_option(required=False), 

80 ] 

81 

82 

83class coverage_options(OptionGroup): # noqa: N801 

84 """Decorator to add options to the command function for test coverage.""" 

85 

86 def __init__(self) -> None: 

87 self.decorators = [ 

88 option_section(sectionText="Coverage options:"), 

89 ctrlMpExecOpts.coverage_option(), 

90 ctrlMpExecOpts.coverage_report_option(), 

91 ctrlMpExecOpts.coverage_packages_option(), 

92 ] 

93 

94 

95class qgraph_options(OptionGroup): # noqa: N801 

96 """Decorator to add options to a command function for creating a quantum 

97 graph. 

98 """ 

99 

100 def __init__(self) -> None: 

101 self.decorators = [ 

102 option_section(sectionText="Quantum graph building options:"), 

103 ctrlMpExecOpts.qgraph_option(), 

104 ctrlMpExecOpts.qgraph_id_option(), 

105 ctrlMpExecOpts.qgraph_node_id_option(), 

106 ctrlMpExecOpts.qgraph_datastore_records_option(), 

107 ctrlMpExecOpts.skip_existing_in_option(), 

108 ctrlMpExecOpts.skip_existing_option(), 

109 ctrlMpExecOpts.clobber_outputs_option(), 

110 ctrlMpExecOpts.save_qgraph_option(), 

111 ctrlMpExecOpts.qgraph_dot_option(), 

112 ctrlMpExecOpts.qgraph_mermaid_option(), 

113 ctrlMpExecOpts.summary_option(), 

114 ctrlMpExecOpts.dataset_query_constraint(), 

115 ctrlMpExecOpts.data_id_table_option(), 

116 ctrlMpExecOpts.mock_option(), 

117 ctrlMpExecOpts.mock_failure_option(), 

118 ctrlMpExecOpts.unmocked_dataset_types_option(), 

119 coverage_options(), 

120 ] 

121 

122 

123class butler_options(OptionGroup): # noqa: N801 

124 """Decorator to add options to a command function for configuring a 

125 butler. 

126 """ 

127 

128 def __init__(self) -> None: 

129 self.decorators = [ 

130 option_section(sectionText="Data repository and selection options:"), 

131 ctrlMpExecOpts.butler_config_option(required=True), 

132 ctrlMpExecOpts.input_option(), 

133 ctrlMpExecOpts.output_option(), 

134 ctrlMpExecOpts.output_run_option(), 

135 ctrlMpExecOpts.extend_run_option(), 

136 ctrlMpExecOpts.replace_run_option(), 

137 ctrlMpExecOpts.prune_replaced_option(), 

138 ctrlMpExecOpts.data_query_option(), 

139 ctrlMpExecOpts.rebase_option(), 

140 ] 

141 

142 

143class execution_options(OptionGroup): # noqa: N801 

144 """Decorator to add options to a command function for executing a 

145 pipeline. 

146 """ 

147 

148 def __init__(self) -> None: 

149 self.decorators = [ 

150 option_section(sectionText="Execution options:"), 

151 ctrlMpExecOpts.clobber_outputs_option(), 

152 ctrlMpExecOpts.pdb_option(), 

153 ctrlMpExecOpts.profile_option(), 

154 dafButlerOpts.processes_option(), 

155 ctrlMpExecOpts.start_method_option(), 

156 ctrlMpExecOpts.timeout_option(), 

157 ctrlMpExecOpts.fail_fast_option(), 

158 ctrlMpExecOpts.raise_on_partial_outputs_option(), 

159 ctrlMpExecOpts.graph_fixup_option(), 

160 ctrlMpExecOpts.summary_option(), 

161 ctrlMpExecOpts.enable_implicit_threading_option(), 

162 ctrlMpExecOpts.cores_per_quantum_option(), 

163 ctrlMpExecOpts.memory_per_quantum_option(), 

164 ] 

165 

166 

167class meta_info_options(OptionGroup): # noqa: N801 

168 """Decorator to add options to a command function for managing pipeline 

169 meta information. 

170 """ 

171 

172 def __init__(self) -> None: 

173 self.decorators = [ 

174 option_section(sectionText="Meta-information output options:"), 

175 ctrlMpExecOpts.skip_init_writes_option(), 

176 ctrlMpExecOpts.init_only_option(), 

177 dafButlerOpts.register_dataset_types_option(), 

178 ctrlMpExecOpts.no_versions_option(), 

179 ] 

180 

181 

182class run_options(OptionGroup): # noqa: N801 

183 """Decorator to add the run options to the run command.""" 

184 

185 def __init__(self) -> None: 

186 self.decorators = [ 

187 click.pass_context, 

188 ctrlMpExecOpts.debug_option(), 

189 ctrlMpExecOpts.show_option(), 

190 pipeline_build_options(), 

191 qgraph_options(), 

192 butler_options(), 

193 execution_options(), 

194 meta_info_options(), 

195 coverage_options(), 

196 option_section(sectionText=""), 

197 dafButlerOpts.options_file_option(), 

198 ]