Coverage for python/lsst/daf/butler/script/configDump.py: 24%
13 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-26 02:47 -0700
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-26 02:47 -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 software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <http://www.gnu.org/licenses/>.
28from __future__ import annotations
30from typing import IO
32from .._butler_config import ButlerConfig
35def configDump(repo: str, subset: str, searchpath: str, outfile: IO) -> None:
36 """Dump either a subset or full Butler configuration to standard output.
38 Parameters
39 ----------
40 repo : `str`
41 URI to the location to create the repo.
42 subset : `str`
43 Subset of a configuration to report. This can be any key in the
44 hierarchy such as '.datastore.root' where the leading '.' specified the
45 delimiter for the hierarchy.
46 searchpath : `str`
47 Additional search paths to use for configuration overrides.
48 outfile : file-like object
49 File to which the configuration should be printed.
51 Raises
52 ------
53 KeyError
54 If a subset is specified but does not exist in the configuration.
55 AttributeError
56 If there is an issue dumping the configuration.
57 """
58 config = ButlerConfig(repo, searchPaths=searchpath)
59 if subset is not None:
60 try:
61 config = config[subset]
62 except KeyError:
63 raise KeyError(f"{subset} not found in config at {repo} (has {config.names()})") from None
64 if hasattr(config, "dump"):
65 config.dump(outfile)
66 else:
67 print(f"{subset}: {config}", file=outfile)