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 

23 

24from ..opt import config_file_option, dataset_type_option, repo_argument 

25from ..utils import split_commas, cli_handle_exception 

26from ...script import createRepo, configDump, configValidate 

27 

28 

29@click.command() 

30@repo_argument(help=repo_argument.will_create_repo) 

31@config_file_option(help="Path to an existing YAML config file to apply (on top of defaults).") 

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

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

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

35 "repo settings.") 

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

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

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

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

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

41 

42 

43@click.command() 

44@repo_argument(required=True) 

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

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

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

48@click.option("--searchpath", "-p", type=str, multiple=True, 

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

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

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

52 "by default.") 

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

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

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

56 

57 

58@click.command() 

59@repo_argument(required=True) 

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

61@dataset_type_option(help="Specific DatasetType(s) to validate.") 

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

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

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

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

66 cli_handle_exception(configValidate, *args, **kwargs)