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

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

# 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/>. 

 

"""Code relating to constraints based on `DatasetRef`, `DatasetType`, or 

`StorageClass`.""" 

 

__all__ = ("Constraints", "ConstraintsValidationError", "ConstraintsConfig") 

 

import logging 

from .config import Config 

from .configSupport import LookupKey, processLookupConfigList 

from .exceptions import ValidationError 

 

log = logging.getLogger(__name__) 

 

 

class ConstraintsValidationError(ValidationError): 

"""Exception thrown when a constraints list has mutually exclusive 

definitions.""" 

pass 

 

 

class ConstraintsConfig(Config): 

"""Configuration information for `Constraints`""" 

pass 

 

 

class Constraints: 

"""Determine whether a `DatasetRef`, `DatasetType`, or `StorageClass` 

is allowed to be handled. 

 

Parameters 

---------- 

config : `ConstraintsConfig` or `str` 

Load configuration. If `None` then this is equivalent to having 

no restrictions. 

universe : `DimensionUniverse` 

The set of all known dimensions, used to normalize any lookup keys 

involving dimensions. 

""" 

 

matchAllKey = LookupKey("all") 

"""Configuration key associated with matching everything.""" 

 

def __init__(self, config, *, universe): 

# Default is to accept all and reject nothing 

self._accept = set() 

self._reject = set() 

 

if config is not None: 

self.config = ConstraintsConfig(config) 

 

if "accept" in self.config: 

self._accept = processLookupConfigList(self.config["accept"], universe=universe) 

if "reject" in self.config: 

self._reject = processLookupConfigList(self.config["reject"], universe=universe) 

 

if self.matchAllKey in self._accept and self.matchAllKey in self._reject: 

raise ConstraintsValidationError("Can not explicitly accept 'all' and reject 'all'" 

" in one configuration") 

 

def __str__(self): 

# Standard stringification 

if not self._accept and not self._reject: 

return "Accepts: all" 

 

accepts = ", ".join(str(k) for k in self._accept) 

rejects = ", ".join(str(k) for k in self._reject) 

return f"Accepts: {accepts}; Rejects: {rejects}" 

 

def isAcceptable(self, entity): 

"""Check whether the supplied entity will be acceptable to whatever 

this `Constraints` class is associated with. 

 

Parameters 

---------- 

entity : `DatasetType`, `DatasetRef`, or `StorageClass` 

Instance to use to look in constraints table. 

The entity itself reports the `LookupKey` that is relevant. 

 

Returns 

------- 

allowed : `bool` 

`True` if the entity is allowed. 

""" 

# Get the names to use for lookup 

names = set(entity._lookupNames()) 

 

# Test if this entity is explicitly mentioned for accept/reject 

isExplicitlyAccepted = bool(names & self._accept) 

 

if isExplicitlyAccepted: 

return True 

 

isExplicitlyRejected = bool(names & self._reject) 

 

if isExplicitlyRejected: 

return False 

 

# Now look for wildcard match -- we have to also check for dataId 

# overrides 

 

# Generate a new set of lookup keys that use the wildcard name 

# but the supplied dimensions 

wildcards = {k.clone(name=self.matchAllKey.name) for k in names} 

 

isWildcardAccepted = bool(wildcards & self._accept) 

isWildcardRejected = bool(wildcards & self._reject) 

 

if isWildcardRejected: 

return False 

 

# If all the wildcard and explicit rejections have failed then 

# if the accept list is empty, or if a wildcard acceptance worked 

# we can accept, else reject 

if isWildcardAccepted or not self._accept: 

return True 

 

return False 

 

def getLookupKeys(self): 

"""Retrieve the look up keys for all the constraints entries. 

 

Returns 

------- 

keys : `set` of `LookupKey` 

The keys available for determining constraints. Does not include 

the special "all" lookup key. 

""" 

all = self._accept | self._accept 

return set(a for a in all if a.name != self.matchAllKey.name)