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

15 statements  

« prev     ^ index     » next       coverage.py v7.2.7, created at 2023-06-02 02:16 -0700

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 

27from .._butlerRepoIndex import ButlerRepoIndex 

28 

29 

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

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

32 

33 Parameters 

34 ---------- 

35 repo : `str` 

36 URI to the location to create the repo. 

37 subset : `str` 

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

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

40 delimiter for the hierarchy. 

41 searchpath : `str` 

42 Additional search paths to use for configuration overrides 

43 outfile : file-like object 

44 File to which the configuration should be printed. 

45 

46 Raises 

47 ------ 

48 KeyError 

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

50 AttributeError 

51 If there is an issue dumping the configuration. 

52 """ 

53 repo_path = ButlerRepoIndex.get_repo_uri(repo, True) 

54 config = ButlerConfig(repo_path, searchPaths=searchpath) 

55 if subset is not None: 

56 try: 

57 config = config[subset] 

58 except KeyError: 

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

60 if hasattr(config, "dump"): 

61 config.dump(outfile) 

62 else: 

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