Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

#!/usr/bin/env python 

 

# This file is part of daf_butler. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program. If not, see <http://www.gnu.org/licenses/>. 

 

__all__ = ("main",) 

 

import argparse 

 

from lsst.daf.butler import Butler, ValidationError 

 

 

def processCommas(arg): 

"""Given a list that might contain strings with commas, return expanded 

list. 

 

Parameters 

---------- 

arg : iterable of `str` 

Values read from command line. 

 

Returns 

------- 

expanded : `list` of `str` 

List where any items with commas are expanded into multiple entries. 

""" 

expanded = [] 

if arg is None: 

return expanded 

for item in arg: 

expanded.extend(item.split(",")) 

return expanded 

 

 

def build_argparser(): 

"""Construct an argument parser for the ``validateButlerConfiguration`` 

script. 

 

Returns 

------- 

argparser : `argparse.ArgumentParser` 

The argument parser that defines the script 

command-line interface. 

""" 

parser = argparse.ArgumentParser(description="Validate the configuration files for a " 

"Gen3 Butler repository.") 

parser.add_argument("root", 

help="Filesystem path for an existing Butler repository.") 

parser.add_argument("--collection", "-c", default="validate", type=str, 

help="Collection to refer to in this repository.") 

parser.add_argument("--quiet", "-q", action="store_true", 

help="Do not report individual failures.") 

parser.add_argument("--datasettype", "-d", action="append", type=str, 

help="Specific DatasetType(s) to validate (can be comma-separated)") 

parser.add_argument("--ignore", "-i", action="append", type=str, 

help="DatasetType(s) to ignore for validation (can be comma-separated)") 

 

return parser 

 

 

def validateButlerConfiguration(root, datasetTypes=None, ignore=None, quiet=False, collection="validate"): 

"""Validate a bulter configuration. 

 

Parameters 

---------- 

root : `str` 

Butler root to validate. 

datasetTypes : `list` of `str` 

Dataset types to specifically check. 

ignore : `list` of `str` 

Dataset types to ignore. 

quiet : `bool`, optional 

If `True` report pass/fail but not details. 

collection : `str`, optional 

Collection to use. Sometimes this is needed to ensure that butler 

can be instantiated properly. 

 

Returns 

------- 

validates : `bool` 

`True` if everything looks okay, `False` if there is a problem. 

""" 

logFailures = not quiet 

 

# The collection does not matter for validation but if a run is specified 

# in the configuration then it must be consistent with this collection 

butler = Butler(config=root, collection=collection) 

try: 

butler.validateConfiguration(logFailures=logFailures, datasetTypeNames=datasetTypes, 

ignore=ignore) 

except ValidationError: 

return False 

 

return True 

 

 

def main(): 

args = build_argparser().parse_args() 

 

# Process any commas in dataset type or ignore list 

ignore = processCommas(args.ignore) 

datasetTypes = processCommas(args.datasettype) 

 

valid = validateButlerConfiguration(args.root, datasetTypes, ignore, args.quiet, args.collection) 

 

if valid: 

print("No problems encountered with configuration.") 

return 0 

else: 

return 1