Coverage for python/lsst/daf/butler/script/configValidate.py: 31%

13 statements  

« prev     ^ index     » next       coverage.py v7.3.1, created at 2023-10-02 08:00 +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 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/>. 

27 

28from __future__ import annotations 

29 

30from .._butler import Butler 

31from ..core import ValidationError 

32 

33 

34def configValidate(repo: str, quiet: bool, dataset_type: list[str], ignore: list[str]) -> bool: 

35 """Validate the configuration files for a Gen3 Butler repository. 

36 

37 Parameters 

38 ---------- 

39 repo : `str` 

40 URI to the location to create the repo. 

41 quiet : `bool` 

42 Do not report individual failures if True. 

43 dataset_type : `list`[`str`] 

44 Specific DatasetTypes to validate. 

45 ignore : `list`[`str`] 

46 "DatasetTypes to ignore for validation." 

47 

48 Returns 

49 ------- 

50 is_good : `bool` 

51 `True` if validation was okay. `False` if there was a validation 

52 error. 

53 """ 

54 logFailures = not quiet 

55 butler = Butler(config=repo) 

56 is_good = True 

57 try: 

58 butler.validateConfiguration(logFailures=logFailures, datasetTypeNames=dataset_type, ignore=ignore) 

59 except ValidationError: 

60 is_good = False 

61 else: 

62 print("No problems encountered with configuration.") 

63 return is_good