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

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

# 

# LSST Data Management System 

# Copyright 2008, 2009, 2010 LSST Corporation. 

# 

# This product includes software developed by the 

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

# 

# 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 LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <http://www.lsstcorp.org/LegalNotices/>. 

# 

 

__all__ = ["DictField"] 

 

import collections 

 

from .config import Field, FieldValidationError, _typeStr, _autocast, _joinNamePath 

from .comparison import getComparisonName, compareScalars 

from .callStack import getCallStack, getStackFrame 

 

 

class Dict(collections.MutableMapping): 

""" 

Config-Internal mapping container 

Emulates a dict, but adds validation and provenance. 

""" 

 

def __init__(self, config, field, value, at, label, setHistory=True): 

self._field = field 

self._config = config 

self._dict = {} 

self._history = self._config._history.setdefault(self._field.name, []) 

self.__doc__ = field.doc 

44 ↛ 53line 44 didn't jump to line 53, because the condition on line 44 was never false if value is not None: 

try: 

for k in value: 

# do not set history per-item 

self.__setitem__(k, value[k], at=at, label=label, setHistory=False) 

except TypeError: 

msg = "Value %s is of incorrect type %s. Mapping type expected." % \ 

(value, _typeStr(value)) 

raise FieldValidationError(self._field, self._config, msg) 

if setHistory: 

self._history.append((dict(self._dict), at, label)) 

 

""" 

Read-only history 

""" 

history = property(lambda x: x._history) 

 

def __getitem__(self, k): 

return self._dict[k] 

 

def __len__(self): 

return len(self._dict) 

 

def __iter__(self): 

return iter(self._dict) 

 

def __contains__(self, k): 

return k in self._dict 

 

def __setitem__(self, k, x, at=None, label="setitem", setHistory=True): 

74 ↛ 75line 74 didn't jump to line 75, because the condition on line 74 was never true if self._config._frozen: 

msg = "Cannot modify a frozen Config. "\ 

"Attempting to set item at key %r to value %s" % (k, x) 

raise FieldValidationError(self._field, self._config, msg) 

 

# validate keytype 

k = _autocast(k, self._field.keytype) 

if type(k) != self._field.keytype: 

msg = "Key %r is of type %s, expected type %s" % \ 

(k, _typeStr(k), _typeStr(self._field.keytype)) 

raise FieldValidationError(self._field, self._config, msg) 

 

# validate itemtype 

x = _autocast(x, self._field.itemtype) 

if self._field.itemtype is None: 

if type(x) not in self._field.supportedTypes and x is not None: 

msg = "Value %s at key %r is of invalid type %s" % (x, k, _typeStr(x)) 

raise FieldValidationError(self._field, self._config, msg) 

else: 

93 ↛ 94line 93 didn't jump to line 94, because the condition on line 93 was never true if type(x) != self._field.itemtype and x is not None: 

msg = "Value %s at key %r is of incorrect type %s. Expected type %s" % \ 

(x, k, _typeStr(x), _typeStr(self._field.itemtype)) 

raise FieldValidationError(self._field, self._config, msg) 

 

# validate item using itemcheck 

if self._field.itemCheck is not None and not self._field.itemCheck(x): 

msg = "Item at key %r is not a valid value: %s" % (k, x) 

raise FieldValidationError(self._field, self._config, msg) 

 

if at is None: 

at = getCallStack() 

 

self._dict[k] = x 

if setHistory: 

self._history.append((dict(self._dict), at, label)) 

 

def __delitem__(self, k, at=None, label="delitem", setHistory=True): 

if self._config._frozen: 

raise FieldValidationError(self._field, self._config, 

"Cannot modify a frozen Config") 

 

del self._dict[k] 

if setHistory: 

if at is None: 

at = getCallStack() 

self._history.append((dict(self._dict), at, label)) 

 

def __repr__(self): 

return repr(self._dict) 

 

def __str__(self): 

return str(self._dict) 

 

def __setattr__(self, attr, value, at=None, label="assignment"): 

128 ↛ 130line 128 didn't jump to line 130, because the condition on line 128 was never true if hasattr(getattr(self.__class__, attr, None), '__set__'): 

# This allows properties to work. 

object.__setattr__(self, attr, value) 

elif attr in self.__dict__ or attr in ["_field", "_config", "_history", "_dict", "__doc__"]: 

# This allows specific private attributes to work. 

object.__setattr__(self, attr, value) 

else: 

# We throw everything else. 

msg = "%s has no attribute %s" % (_typeStr(self._field), attr) 

raise FieldValidationError(self._field, self._config, msg) 

 

 

class DictField(Field): 

""" 

Defines a field which is a mapping of values 

 

Both key and item types are restricted to builtin POD types: 

(int, float, complex, bool, str) 

 

Users can provide two check functions: 

dictCheck: used to validate the dict as a whole, and 

itemCheck: used to validate each item individually 

 

For example to define a field which is a mapping from names to int values: 

 

class MyConfig(Config): 

field = DictField( 

doc="example string-to-int mapping field", 

keytype=str, itemtype=int, 

default= {}) 

""" 

DictClass = Dict 

 

def __init__(self, doc, keytype, itemtype, default=None, optional=False, dictCheck=None, itemCheck=None): 

source = getStackFrame() 

self._setup(doc=doc, dtype=Dict, default=default, check=None, 

optional=optional, source=source) 

if keytype not in self.supportedTypes: 

raise ValueError("'keytype' %s is not a supported type" % 

_typeStr(keytype)) 

elif itemtype is not None and itemtype not in self.supportedTypes: 

raise ValueError("'itemtype' %s is not a supported type" % 

_typeStr(itemtype)) 

if dictCheck is not None and not hasattr(dictCheck, "__call__"): 

raise ValueError("'dictCheck' must be callable") 

if itemCheck is not None and not hasattr(itemCheck, "__call__"): 

raise ValueError("'itemCheck' must be callable") 

 

self.keytype = keytype 

self.itemtype = itemtype 

self.dictCheck = dictCheck 

self.itemCheck = itemCheck 

 

def validate(self, instance): 

""" 

DictField validation ensures that non-optional fields are not None, 

and that non-None values comply with dictCheck. 

Individual Item checks are applied at set time and are not re-checked. 

""" 

Field.validate(self, instance) 

value = self.__get__(instance) 

189 ↛ 191line 189 didn't jump to line 191, because the condition on line 189 was never true if value is not None and self.dictCheck is not None \ 

and not self.dictCheck(value): 

msg = "%s is not a valid value" % str(value) 

raise FieldValidationError(self, instance, msg) 

 

def __set__(self, instance, value, at=None, label="assignment"): 

195 ↛ 196line 195 didn't jump to line 196, because the condition on line 195 was never true if instance._frozen: 

msg = "Cannot modify a frozen Config. "\ 

"Attempting to set field to value %s" % value 

raise FieldValidationError(self, instance, msg) 

 

200 ↛ 201line 200 didn't jump to line 201, because the condition on line 200 was never true if at is None: 

at = getCallStack() 

if value is not None: 

value = self.DictClass(instance, self, value, at=at, label=label) 

else: 

history = instance._history.setdefault(self.name, []) 

history.append((value, at, label)) 

 

instance._storage[self.name] = value 

 

def toDict(self, instance): 

value = self.__get__(instance) 

return dict(value) if value is not None else None 

 

def _compare(self, instance1, instance2, shortcut, rtol, atol, output): 

"""Helper function for Config.compare; used to compare two fields for equality. 

 

@param[in] instance1 LHS Config instance to compare. 

@param[in] instance2 RHS Config instance to compare. 

@param[in] shortcut If True, return as soon as an inequality is found. 

@param[in] rtol Relative tolerance for floating point comparisons. 

@param[in] atol Absolute tolerance for floating point comparisons. 

@param[in] output If not None, a callable that takes a string, used (possibly repeatedly) 

to report inequalities. 

 

Floating point comparisons are performed by numpy.allclose; refer to that for details. 

""" 

d1 = getattr(instance1, self.name) 

d2 = getattr(instance2, self.name) 

name = getComparisonName( 

_joinNamePath(instance1._name, self.name), 

_joinNamePath(instance2._name, self.name) 

) 

233 ↛ 234line 233 didn't jump to line 234, because the condition on line 233 was never true if not compareScalars("isnone for %s" % name, d1 is None, d2 is None, output=output): 

return False 

if d1 is None and d2 is None: 

return True 

if not compareScalars("keys for %s" % name, set(d1.keys()), set(d2.keys()), output=output): 

return False 

equal = True 

for k, v1 in d1.items(): 

v2 = d2[k] 

result = compareScalars("%s[%r]" % (name, k), v1, v2, dtype=self.itemtype, 

rtol=rtol, atol=atol, output=output) 

244 ↛ 245line 244 didn't jump to line 245, because the condition on line 244 was never true if not result and shortcut: 

return False 

equal = equal and result 

return equal