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

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

# 

# LSST Data Management System 

# 

# Copyright 2008-2017 AURA/LSST. 

# 

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

# 

 

from __future__ import absolute_import, division, print_function 

 

__all__ = ["getstate", "setstate"] 

 

from past.builtins import long 

import numbers 

 

from lsst.utils import continueClass 

 

from .propertySet import PropertySet 

from .propertyList import PropertyList 

 

import lsst.pex.exceptions 

from ..dateTime import DateTime 

 

 

def _propertyContainerElementTypeName(container, name): 

"""Return name of the type of a particular element""" 

t = container.typeOf(name) 

for checkType in ("Bool", "Short", "Int", "Long", "LongLong", "Float", "Double", "String", "DateTime"): 

if t == getattr(container, "TYPE_" + checkType): 

return checkType 

return None 

 

 

def _propertyContainerGet(container, name, asArray=False): 

"""Extract a single Python value of unknown type""" 

if not container.exists(name): 

raise lsst.pex.exceptions.NotFoundError(name + " not found") 

 

elemType = _propertyContainerElementTypeName(container, name) 

if elemType: 

value = getattr(container, "getArray" + elemType)(name) 

return value[0] if len(value) == 1 and not asArray else value 

 

try: 

return container.getAsPropertyListPtr(name) 

except Exception: 

pass 

63 ↛ 65line 63 didn't jump to line 65, because the condition on line 63 was never false if container.typeOf(name) == container.TYPE_PropertySet: 

return container.getAsPropertySetPtr(name) 

try: 

return container.getAsPersistablePtr(name) 

except Exception: 

pass 

raise lsst.pex.exceptions.TypeError('Unknown PropertySet value type for ' + name) 

 

 

def _guessIntegerType(container, name, value): 

"""Given an existing container and name, determine the type 

that should be used for the supplied value. The supplied value 

is assumed to be a scalar. 

 

On Python 3 all ints are LongLong but we need to be able to store them 

in Int containers if that is what is being used (testing for truncation). 

Int is assumed to mean 32bit integer (2147483647 to -2147483648). 

 

If there is no pre-existing value we have to decide what to do. For now 

we pick Int if the value is less than maxsize. 

 

Returns None if the value supplied is a bool or not an integral value. 

""" 

useType = None 

maxInt = 2147483647 

minInt = -2147483648 

 

# We do not want to convert bool to int so let the system work that 

# out itself 

if isinstance(value, bool): 

return useType 

 

if isinstance(value, numbers.Integral): 

try: 

containerType = _propertyContainerElementTypeName(container, name) 

except lsst.pex.exceptions.NotFoundError: 

# nothing in the container so choose based on size. Safe option is to 

# always use LongLong 

101 ↛ 104line 101 didn't jump to line 104, because the condition on line 101 was never false if value <= maxInt and value >= minInt: 

useType = "Int" 

else: 

useType = "LongLong" 

else: 

106 ↛ 112line 106 didn't jump to line 112, because the condition on line 106 was never false if containerType == "Int": 

# Always use an Int even if we know it won't fit. The later 

# code will trigger OverflowError if appropriate. Setting the 

# type to LongLong here will trigger a TypeError instead so it's 

# best to trigger a predictable OverflowError. 

useType = "Int" 

elif containerType == "LongLong": 

useType = "LongLong" 

return useType 

 

 

def _propertyContainerSet(container, name, value, typeMenu, *args): 

"""Set a single Python value of unknown type""" 

if hasattr(value, "__iter__") and not isinstance(value, str): 

exemplar = value[0] 

else: 

exemplar = value 

 

t = type(exemplar) 

setType = _guessIntegerType(container, name, exemplar) 

 

if setType is not None or t in typeMenu: 

if setType is None: 

setType = typeMenu[t] 

return getattr(container, "set" + setType)(name, value, *args) 

# Allow for subclasses 

132 ↛ 135line 132 didn't jump to line 135, because the loop on line 132 didn't complete for checkType in typeMenu: 

if isinstance(exemplar, checkType): 

return getattr(container, "set" + typeMenu[checkType])(name, value, *args) 

raise lsst.pex.exceptions.TypeError("Unknown value type for %s: %s" % (name, t)) 

 

 

def _propertyContainerAdd(container, name, value, typeMenu, *args): 

"""Add a single Python value of unknown type""" 

if hasattr(value, "__iter__"): 

exemplar = value[0] 

else: 

exemplar = value 

 

t = type(exemplar) 

addType = _guessIntegerType(container, name, exemplar) 

 

if addType is not None or t in typeMenu: 

if addType is None: 

addType = typeMenu[t] 

return getattr(container, "add" + addType)(name, value, *args) 

# Allow for subclasses 

153 ↛ 156line 153 didn't jump to line 156, because the loop on line 153 didn't complete for checkType in typeMenu: 

if isinstance(exemplar, checkType): 

return getattr(container, "add" + typeMenu[checkType])(name, value, *args) 

raise lsst.pex.exceptions.TypeError("Unknown value type for %s: %s" % (name, t)) 

 

 

def getstate(self): 

return [(name, _propertyContainerElementTypeName(self, name), self.get(name), 

self.getComment(name)) for name in self.getOrderedNames()] 

 

 

def setstate(self, state): 

for name, elemType, value, comment in state: 

getattr(self, "set" + elemType)(name, value, comment) 

 

 

@continueClass 

class PropertySet: 

# Mapping of type to method names 

_typeMenu = {bool: "Bool", 

long: "LongLong", 

int: "Int", # overwrites long on Python 3.x 

float: "Double", 

str: "String", 

DateTime: "DateTime", 

PropertySet: "PropertySet", 

PropertyList: "PropertySet", 

} 

 

# Map unicode to String, but this only works on Python 2 

# so catch the error and do nothing on Python 3. 

try: 

_typeMenu[unicode] = "String" # noqa F821 

except Exception: 

pass 

 

def get(self, name, asArray=False): 

return _propertyContainerGet(self, name, asArray) 

 

def set(self, name, value): 

return _propertyContainerSet(self, name, value, self._typeMenu) 

 

def add(self, name, value): 

return _propertyContainerAdd(self, name, value, self._typeMenu) 

 

def toDict(self): 

"""Returns a (possibly nested) dictionary with all properties. 

""" 

 

d = {} 

for name in self.names(): 

v = self.get(name) 

 

if isinstance(v, PropertySet): 

d[name] = PropertySet.toDict(v) 

else: 

d[name] = v 

return d 

 

 

@continueClass 

class PropertyList: 

# Mapping of type to method names 

_typeMenu = {bool: "Bool", 

long: "LongLong", 

int: "Int", # overwrites long on Python 3.x 

float: "Double", 

str: "String", 

DateTime: "DateTime", 

PropertySet: "PropertySet", 

PropertyList: "PropertySet", 

} 

 

# Map unicode to String, but this only works on Python 2 

# so catch the error and do nothing on Python 3. 

try: 

_typeMenu[unicode] = "String" # noqa F821 

except Exception: 

pass 

 

def get(self, name, asArray=False): 

return _propertyContainerGet(self, name, asArray) 

 

def set(self, name, value, comment=None): 

args = [] 

if comment is not None: 

args.append(comment) 

return _propertyContainerSet(self, name, value, self._typeMenu, *args) 

 

def add(self, name, value, comment=None): 

args = [] 

if comment is not None: 

args.append(comment) 

return _propertyContainerAdd(self, name, value, self._typeMenu, *args) 

 

def toList(self): 

orderedNames = self.getOrderedNames() 

ret = [] 

for name in orderedNames: 

if self.isArray(name): 

values = self.get(name) 

for v in values: 

ret.append((name, v, self.getComment(name))) 

else: 

ret.append((name, self.get(name), self.getComment(name))) 

return ret 

 

def toOrderedDict(self): 

"""Return an ordered dictionary with all properties in the order that 

they were inserted. 

""" 

from collections import OrderedDict 

 

d = OrderedDict() 

for name in self.getOrderedNames(): 

d[name] = self.get(name) 

return d