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

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://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 

23import click 

24from functools import partial 

25 

26from ..utils import MWOptionDecorator, split_commas, split_kv, unwrap, yaml_presets 

27from lsst.daf.butler.registry import CollectionType 

28 

29 

30class CollectionTypeCallback: 

31 

32 collectionTypes = tuple(collectionType.name for collectionType in CollectionType.all()) 

33 

34 @staticmethod 

35 def makeCollectionTypes(context, param, value): 

36 if not value: 

37 # Click seems to demand that the default be an empty tuple, rather 

38 # than a sentinal like None. The behavior that we want is that 

39 # not passing this option at all passes all collection types, while 

40 # passing it uses only the passed collection types. That works 

41 # fine for now, since there's no command-line option to subtract 

42 # collection types, and hence the only way to get an empty tuple 

43 # is as the default. 

44 return tuple(CollectionType.all()) 

45 

46 return tuple(CollectionType.from_name(item) for item in split_commas(context, param, value)) 

47 

48 

49collection_type_option = MWOptionDecorator("--collection-type", 

50 callback=CollectionTypeCallback.makeCollectionTypes, 

51 multiple=True, 

52 help="If provided, only list collections of this type.", 

53 type=click.Choice(CollectionTypeCallback.collectionTypes, 

54 case_sensitive=False)) 

55 

56 

57collections_option = MWOptionDecorator("--collections", 

58 help=unwrap("""One or more expressions that fully or partially identify 

59 the collections to search for datasets. If not provided all 

60 datasets are returned."""), 

61 multiple=True, 

62 callback=split_commas) 

63 

64 

65components_option = MWOptionDecorator("--components/--no-components", 

66 default=None, 

67 help=unwrap("""For --components, apply all expression patterns to 

68 component dataset type names as well. For --no-components, 

69 never apply patterns to components. Default (where neither 

70 is specified) is to apply patterns to components only if 

71 their parent datasets were not matched by the expression. 

72 Fully-specified component datasets (`str` or `DatasetType` 

73 instances) are always included.""")) 

74 

75 

76config_option = MWOptionDecorator("-c", "--config", 

77 callback=split_kv, 

78 help="Config override, as a key-value pair.", 

79 metavar="TEXT=TEXT", 

80 multiple=True) 

81 

82 

83config_file_option = MWOptionDecorator("-C", "--config-file", 

84 help=unwrap("""Path to a pex config override to be included after the 

85 Instrument config overrides are applied.""")) 

86 

87 

88dataset_type_option = MWOptionDecorator("-d", "--dataset-type", 

89 callback=split_commas, 

90 help="Specific DatasetType(s) to validate.", 

91 multiple=True) 

92 

93 

94datasets_option = MWOptionDecorator("--datasets") 

95 

96 

97logLevelChoices = ["CRITICAL", "ERROR", "WARNING", "INFO", "VERBOSE", "DEBUG"] 

98log_level_option = MWOptionDecorator("--log-level", 

99 callback=partial(split_kv, 

100 choice=click.Choice(logLevelChoices, 

101 case_sensitive=False), 

102 normalize=True, 

103 unseparated_okay=True, 

104 add_to_default=True), 

105 help="The logging level. " 

106 f"Supported levels are [{'|'.join(logLevelChoices)}]", 

107 is_eager=True, 

108 metavar="LEVEL|COMPONENT=LEVEL", 

109 multiple=True) 

110 

111 

112long_log_option = MWOptionDecorator("--long-log", 

113 help="Make log messages appear in long format.", 

114 is_flag=True) 

115 

116 

117options_file_option = MWOptionDecorator("--options-file", "-@", 

118 expose_value=False, # This option should not be forwarded 

119 help=unwrap("""URI to YAML file containing overrides 

120 of command line options. The YAML should be organized 

121 as a hierarchy with subcommand names at the top 

122 level options for that subcommand below."""), 

123 callback=yaml_presets) 

124 

125 

126processes_option = MWOptionDecorator("-j", "--processes", 

127 default=1, 

128 help="Number of processes to use.", 

129 type=click.IntRange(min=1)) 

130 

131 

132regex_option = MWOptionDecorator("--regex") 

133 

134 

135run_option = MWOptionDecorator("--output-run", 

136 help="The name of the run datasets should be output to.") 

137 

138 

139transfer_option = MWOptionDecorator("-t", "--transfer", 

140 default="auto", # set to `None` if using `required=True` 

141 help="The external data transfer mode.", 

142 type=click.Choice(["auto", "link", "symlink", "hardlink", "copy", "move", 

143 "relsymlink", "direct"], 

144 case_sensitive=False)) 

145 

146 

147verbose_option = MWOptionDecorator("-v", "--verbose", 

148 help="Increase verbosity.", 

149 is_flag=True) 

150 

151 

152where_option = MWOptionDecorator("--where", 

153 help="A string expression similar to a SQL WHERE clause.")