Coverage for python/lsst/daf/butler/script/configDump.py: 13%
11 statements
« prev ^ index » next coverage.py v6.5.0, created at 2022-10-21 02:03 -0700
« prev ^ index » next coverage.py v6.5.0, created at 2022-10-21 02:03 -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/>.
22from .._butlerConfig import ButlerConfig
25def configDump(repo, subset, searchpath, outfile):
26 """Dump either a subset or full Butler configuration to standard output.
28 Parameters
29 ----------
30 repo : `str`
31 URI to the location to create the repo.
32 subset : `str`
33 Subset of a configuration to report. This can be any key in the
34 hierarchy such as '.datastore.root' where the leading '.' specified the
35 delimiter for the hierarchy.
36 searchpath : `str`
37 Additional search paths to use for configuration overrides
38 outfile : file-like object
39 File to which the configuration should be printed.
41 Raises
42 ------
43 KeyError
44 If a subset is specified but does not exist in the configuration.
45 AttributeError
46 If there is an issue dumping the configuration.
47 """
48 config = ButlerConfig(repo, searchPaths=searchpath)
49 if subset is not None:
50 try:
51 config = config[subset]
52 except KeyError:
53 raise KeyError(f"{subset} not found in config at {repo} (has {config.names()})")
54 if hasattr(config, "dump"):
55 config.dump(outfile)
56 else:
57 print(f"{subset}: {config}", file=outfile)