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 

22import click 

23import yaml 

24 

25from ..opt import (collection_type_option, dataset_type_option, directory_argument, glob_parameter, 

26 repo_argument, run_option, transfer_option, verbose_option) 

27from ..utils import split_commas, cli_handle_exception, ParameterType, typeStrAcceptsMultiple 

28from ...script import (butlerImport, createRepo, configDump, configValidate, queryCollections, 

29 queryDatasetTypes) 

30 

31 

32# The conversion from the import command name to the butler_import function 

33# name for subcommand lookup is implemented in the cli/butler.py, in 

34# funcNameToCmdName and cmdNameToFuncName. If name changes are made here they 

35# must be reflected in that location. If this becomes a common pattern a better 

36# mechanism should be implemented. 

37@click.command("import") 

38@repo_argument(required=True, help=repo_argument.will_create_repo) 

39@directory_argument(required=True) 

40@transfer_option() 

41@run_option(required=True) 

42@click.option("--export-file", 

43 help="Name for the file that contains database information associated with the exported " 

44 "datasets. If this is not an absolute path, does not exist in the current working " 

45 "directory, and --dir is provided, it is assumed to be in that directory. Defaults " 

46 "to \"export.yaml\".", 

47 type=click.File("r")) 

48@click.option("--skip-dimensions", "-s", type=str, multiple=True, callback=split_commas, 

49 metavar=typeStrAcceptsMultiple, 

50 help="Dimensions that should be skipped during import") 

51def butler_import(*args, **kwargs): 

52 """Import data into a butler repository.""" 

53 cli_handle_exception(butlerImport, *args, **kwargs) 

54 

55 

56@click.command() 

57@repo_argument(required=True, help=repo_argument.will_create_repo) 

58@click.option("--seed-config", help="Path to an existing YAML config file to apply (on top of defaults).") 

59@click.option("--standalone", is_flag=True, help="Include all defaults in the config file in the repo, " 

60 "insulating the repo from changes in package defaults.") 

61@click.option("--override", is_flag=True, help="Allow values in the supplied config to override all " 

62 "repo settings.") 

63@click.option("--outfile", "-f", default=None, type=str, help="Name of output file to receive repository " 

64 "configuration. Default is to write butler.yaml into the specified repo.") 

65def create(*args, **kwargs): 

66 """Create an empty Gen3 Butler repository.""" 

67 cli_handle_exception(createRepo, *args, **kwargs) 

68 

69 

70@click.command(short_help="Dump butler config to stdout.") 

71@repo_argument(required=True) 

72@click.option("--subset", "-s", type=str, 

73 help="Subset of a configuration to report. This can be any key in the hierarchy such as " 

74 "'.datastore.root' where the leading '.' specified the delimiter for the hierarchy.") 

75@click.option("--searchpath", "-p", type=str, multiple=True, callback=split_commas, 

76 metavar=typeStrAcceptsMultiple, 

77 help="Additional search paths to use for configuration overrides") 

78@click.option("--file", "outfile", type=click.File("w"), default="-", 

79 help="Print the (possibly-expanded) configuration for a repository to a file, or to stdout " 

80 "by default.") 

81def config_dump(*args, **kwargs): 

82 """Dump either a subset or full Butler configuration to standard output.""" 

83 cli_handle_exception(configDump, *args, **kwargs) 

84 

85 

86@click.command(short_help="Validate the configuration files.") 

87@repo_argument(required=True) 

88@click.option("--quiet", "-q", is_flag=True, help="Do not report individual failures.") 

89@dataset_type_option(help="Specific DatasetType(s) to validate.", multiple=True) 

90@click.option("--ignore", "-i", type=str, multiple=True, callback=split_commas, 

91 metavar=typeStrAcceptsMultiple, 

92 help="DatasetType(s) to ignore for validation.") 

93def config_validate(*args, **kwargs): 

94 """Validate the configuration files for a Gen3 Butler repository.""" 

95 is_good = cli_handle_exception(configValidate, *args, **kwargs) 

96 if not is_good: 

97 raise click.exceptions.Exit(1) 

98 

99 

100@click.command(short_help="Search for collections.") 

101@repo_argument(required=True) 

102@collection_type_option() 

103@click.option("--flatten-chains/--no-flatten-chains", 

104 help="Recursively get the child collections of matching CHAINED collections. Default is " 

105 "--no-flatten-chains.") 

106@click.option("--include-chains/--no-include-chains", 

107 default=None, 

108 help="For --include-chains, return records for matching CHAINED collections. For " 

109 "--no-include-chains do not return records for CHAINED collections. Default is the " 

110 "opposite of --flatten-chains: include either CHAINED collections or their children, but " 

111 "not both.") 

112def query_collections(*args, **kwargs): 

113 """Get the collections whose names match an expression.""" 

114 print(yaml.dump(cli_handle_exception(queryCollections, *args, **kwargs))) 

115 

116 

117@click.command() 

118@repo_argument(required=True) 

119@glob_parameter(parameterType=ParameterType.ARGUMENT, multiple=True) 

120@verbose_option(help="Include dataset type name, dimensions, and storage class in output.") 

121@click.option("--components/--no-components", 

122 default=None, 

123 help="For --components, apply all expression patterns to component dataset type names as well. " 

124 "For --no-components, never apply patterns to components. Default (where neither is " 

125 "specified) is to apply patterns to components only if their parent datasets were not " 

126 "matched by the expression. Fully-specified component datasets (`str` or `DatasetType` " 

127 "instances) are always included.") 

128def query_dataset_types(*args, **kwargs): 

129 """Get the dataset types in a repository.""" 

130 print(yaml.dump(cli_handle_exception(queryDatasetTypes, *args, **kwargs), sort_keys=False))