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 ... import ButlerConfig 

25from ..opt import repo_option 

26 

27 

28@click.command() 

29@repo_option(required=True, help="filesystem path for an existing Butler repository or path to config " 

30 "file.") 

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

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

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

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

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

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

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

38 "by default.") 

39def config_dump(repo, subset, searchpath, outfile): 

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

41 config = ButlerConfig(repo, searchPaths=searchpath) 

42 

43 if subset is not None: 

44 try: 

45 config = config[subset] 

46 except KeyError: 

47 raise click.ClickException(f"{subset} not found in config at {repo}") 

48 

49 try: 

50 config.dump(outfile) 

51 except AttributeError: 

52 print(config, file=outfile)