Coverage for python/lsst/daf/butler/script/configDump.py: 24%

13 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2022-11-19 01:58 -0800

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 

22from __future__ import annotations 

23 

24from typing import IO 

25 

26from .._butlerConfig import ButlerConfig 

27 

28 

29def configDump(repo: str, subset: str, searchpath: str, outfile: IO) -> None: 

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

31 

32 Parameters 

33 ---------- 

34 repo : `str` 

35 URI to the location to create the repo. 

36 subset : `str` 

37 Subset of a configuration to report. This can be any key in the 

38 hierarchy such as '.datastore.root' where the leading '.' specified the 

39 delimiter for the hierarchy. 

40 searchpath : `str` 

41 Additional search paths to use for configuration overrides 

42 outfile : file-like object 

43 File to which the configuration should be printed. 

44 

45 Raises 

46 ------ 

47 KeyError 

48 If a subset is specified but does not exist in the configuration. 

49 AttributeError 

50 If there is an issue dumping the configuration. 

51 """ 

52 config = ButlerConfig(repo, searchPaths=searchpath) 

53 if subset is not None: 

54 try: 

55 config = config[subset] 

56 except KeyError: 

57 raise KeyError(f"{subset} not found in config at {repo} (has {config.names()})") 

58 if hasattr(config, "dump"): 

59 config.dump(outfile) 

60 else: 

61 print(f"{subset}: {config}", file=outfile)