Coverage for python/lsst/daf/butler/script/configValidate.py: 31%
13 statements
« prev ^ index » next coverage.py v6.5.0, created at 2023-02-07 10:26 +0000
« prev ^ index » next coverage.py v6.5.0, created at 2023-02-07 10:26 +0000
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 __future__ import annotations
24from .._butler import Butler
25from ..core import ValidationError
28def configValidate(repo: str, quiet: bool, dataset_type: list[str], ignore: list[str]) -> bool:
29 """Validate the configuration files for a Gen3 Butler repository.
31 Parameters
32 ----------
33 repo : `str`
34 URI to the location to create the repo.
35 quiet : `bool`
36 Do not report individual failures if True.
37 dataset_type : `list`[`str`]
38 Specific DatasetTypes to validate.
39 ignore : `list`[`str`]
40 "DatasetTypes to ignore for validation."
42 Returns
43 -------
44 is_good : `bool`
45 `True` if validation was okay. `False` if there was a validation
46 error.
47 """
48 logFailures = not quiet
49 butler = Butler(config=repo)
50 is_good = True
51 try:
52 butler.validateConfiguration(logFailures=logFailures, datasetTypeNames=dataset_type, ignore=ignore)
53 except ValidationError:
54 is_good = False
55 else:
56 print("No problems encountered with configuration.")
57 return is_good