Hide keyboard shortcuts

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

21 

22 

23__all__ = ("butler_options", "execution_options", "meta_info_options", "pipeline_build_options", 

24 "qgraph_options", "run_options") 

25 

26 

27import click 

28 

29from lsst.daf.butler.cli.utils import option_section, unwrap 

30import lsst.obs.base.cli.opt as obsBaseOpts 

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

32from lsst.daf.butler.cli.utils import OptionGroup 

33from . import options as ctrlMpExecOpts 

34 

35instrumentOptionHelp = ("Add an instrument which will be used to load config overrides when defining a " 

36 "pipeline. This must be the fully qualified class name.") 

37 

38 

39class pipeline_build_options(OptionGroup): # noqa: N801 

40 """Decorator to add options to a command function for building a pipeline. 

41 """ 

42 

43 def __init__(self): 

44 self.decorators = [ 

45 option_section(sectionText="Pipeline build options:"), 

46 ctrlMpExecOpts.pipeline_option(), 

47 ctrlMpExecOpts.task_option(), 

48 ctrlMpExecOpts.delete_option(metavar="LABEL"), 

49 dafButlerOpts.config_option(metavar="LABEL:NAME=VALUE", multiple=True), 

50 dafButlerOpts.config_file_option(help=unwrap("""Configuration override file(s), applies to a task 

51 with a given label."""), 

52 metavar="LABEL:FILE", 

53 multiple=True), 

54 ctrlMpExecOpts.order_pipeline_option(), 

55 ctrlMpExecOpts.save_pipeline_option(), 

56 ctrlMpExecOpts.pipeline_dot_option(), 

57 obsBaseOpts.instrument_option(help=instrumentOptionHelp, metavar="instrument", multiple=True)] 

58 

59 

60class qgraph_options(OptionGroup): # noqa: N801 

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

62 graph.""" 

63 

64 def __init__(self): 

65 self.decorators = [ 

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

67 ctrlMpExecOpts.qgraph_option(), 

68 ctrlMpExecOpts.qgraph_id_option(), 

69 ctrlMpExecOpts.qgraph_node_id_option(), 

70 ctrlMpExecOpts.skip_existing_option(), 

71 ctrlMpExecOpts.save_qgraph_option(), 

72 ctrlMpExecOpts.save_single_quanta_option(), 

73 ctrlMpExecOpts.qgraph_dot_option()] 

74 

75 

76class butler_options(OptionGroup): # noqa: N801 

77 """Decorator to add options to a command function for configuring a butler. 

78 """ 

79 

80 def __init__(self): 

81 self.decorators = [ 

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

83 ctrlMpExecOpts.butler_config_option(), 

84 ctrlMpExecOpts.input_option(), 

85 ctrlMpExecOpts.output_option(), 

86 ctrlMpExecOpts.output_run_option(), 

87 ctrlMpExecOpts.extend_run_option(), 

88 ctrlMpExecOpts.replace_run_option(), 

89 ctrlMpExecOpts.prune_replaced_option(), 

90 ctrlMpExecOpts.data_query_option()] 

91 

92 

93class execution_options(OptionGroup): # noqa: N801 

94 """Decorator to add options to a command function for executing a pipeline. 

95 """ 

96 

97 def __init__(self): 

98 self.decorators = [ 

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

100 ctrlMpExecOpts.clobber_partial_outputs_option(), 

101 ctrlMpExecOpts.do_raise_option(), 

102 ctrlMpExecOpts.profile_option(), 

103 dafButlerOpts.processes_option(), 

104 ctrlMpExecOpts.start_method_option(), 

105 ctrlMpExecOpts.timeout_option(), 

106 ctrlMpExecOpts.fail_fast_option(), 

107 ctrlMpExecOpts.graph_fixup_option()] 

108 

109 

110class meta_info_options(OptionGroup): # noqa: N801 

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

112 meta information.""" 

113 

114 def __init__(self): 

115 self.decorators = [ 

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

117 ctrlMpExecOpts.skip_init_writes_option(), 

118 ctrlMpExecOpts.init_only_option(), 

119 ctrlMpExecOpts.register_dataset_types_option(), 

120 ctrlMpExecOpts.no_versions_option()] 

121 

122 

123class run_options(OptionGroup): # noqa: N801 

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

125 

126 def __init__(self): 

127 self.decorators = [ 

128 click.pass_context, 

129 ctrlMpExecOpts.debug_option(), 

130 ctrlMpExecOpts.show_option(), 

131 pipeline_build_options(), 

132 qgraph_options(), 

133 butler_options(), 

134 execution_options(), 

135 meta_info_options(), 

136 option_section(sectionText=""), 

137 dafButlerOpts.options_file_option(), 

138 ]