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

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

# 

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

# 

 

import copy 

 

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

from .comparison import compareConfigs, getComparisonName 

from .callStack import getCallStack, getStackFrame 

 

 

class ConfigurableInstance: 

"""A retargetable configuration for a configurable object. 

 

The actual `~lsst.pex.config.Config` instance is accessed using the 

``value`` property (e.g. to get its documentation). The associated 

configurable object (usually a `~lsst.pipe.base.Task`) is accessed 

using the ``target`` property. 

""" 

 

def __initValue(self, at, label): 

""" 

if field.default is an instance of ConfigClass, custom construct 

_value with the correct values from default. 

otherwise call ConfigClass constructor 

""" 

name = _joinNamePath(self._config._name, self._field.name) 

if type(self._field.default) == self.ConfigClass: 

storage = self._field.default._storage 

else: 

storage = {} 

value = self._ConfigClass(__name=name, __at=at, __label=label, **storage) 

object.__setattr__(self, "_value", value) 

 

def __init__(self, config, field, at=None, label="default"): 

object.__setattr__(self, "_config", config) 

object.__setattr__(self, "_field", field) 

object.__setattr__(self, "__doc__", config) 

object.__setattr__(self, "_target", field.target) 

object.__setattr__(self, "_ConfigClass", field.ConfigClass) 

object.__setattr__(self, "_value", None) 

 

if at is None: 

at = getCallStack() 

at += [self._field.source] 

self.__initValue(at, label) 

 

history = config._history.setdefault(field.name, []) 

history.append(("Targeted and initialized from defaults", at, label)) 

 

""" 

Read-only access to the targeted configurable 

""" 

72 ↛ exitline 72 didn't run the lambda on line 72 target = property(lambda x: x._target) 

""" 

Read-only access to the ConfigClass 

""" 

76 ↛ exitline 76 didn't run the lambda on line 76 ConfigClass = property(lambda x: x._ConfigClass) 

 

""" 

Read-only access to the ConfigClass instance 

""" 

81 ↛ exitline 81 didn't run the lambda on line 81 value = property(lambda x: x._value) 

 

def apply(self, *args, **kw): 

""" 

Call the configurable. 

With argument config=self.value along with any positional and kw args 

""" 

return self.target(*args, config=self.value, **kw) 

 

def retarget(self, target, ConfigClass=None, at=None, label="retarget"): 

"""Target a new configurable and ConfigClass 

""" 

if self._config._frozen: 

raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config") 

 

try: 

ConfigClass = self._field.validateTarget(target, ConfigClass) 

except BaseException as e: 

raise FieldValidationError(self._field, self._config, e.message) 

 

if at is None: 

at = getCallStack() 

object.__setattr__(self, "_target", target) 

if ConfigClass != self.ConfigClass: 

object.__setattr__(self, "_ConfigClass", ConfigClass) 

self.__initValue(at, label) 

 

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

msg = "retarget(target=%s, ConfigClass=%s)" % (_typeStr(target), _typeStr(ConfigClass)) 

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

 

def __getattr__(self, name): 

return getattr(self._value, name) 

 

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

""" 

Pretend to be an isntance of ConfigClass. 

Attributes defined by ConfigurableInstance will shadow those defined in ConfigClass 

""" 

if self._config._frozen: 

raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config") 

 

if name in self.__dict__: 

# attribute exists in the ConfigurableInstance wrapper 

object.__setattr__(self, name, value) 

else: 

if at is None: 

at = getCallStack() 

self._value.__setattr__(name, value, at=at, label=label) 

 

def __delattr__(self, name, at=None, label="delete"): 

""" 

Pretend to be an isntance of ConfigClass. 

Attributes defiend by ConfigurableInstance will shadow those defined in ConfigClass 

""" 

if self._config._frozen: 

raise FieldValidationError(self._field, self._config, "Cannot modify a frozen Config") 

 

try: 

# attribute exists in the ConfigurableInstance wrapper 

object.__delattr__(self, name) 

except AttributeError: 

if at is None: 

at = getCallStack() 

self._value.__delattr__(name, at=at, label=label) 

 

 

class ConfigurableField(Field): 

""" 

A variant of a ConfigField which has a known configurable target 

 

Behaves just like a ConfigField except that it can be 'retargeted' to point 

at a different configurable. Further you can 'apply' to construct a fully 

configured configurable. 

 

 

""" 

 

def validateTarget(self, target, ConfigClass): 

if ConfigClass is None: 

try: 

ConfigClass = target.ConfigClass 

except Exception: 

raise AttributeError("'target' must define attribute 'ConfigClass'") 

165 ↛ 166line 165 didn't jump to line 166, because the condition on line 165 was never true if not issubclass(ConfigClass, Config): 

raise TypeError("'ConfigClass' is of incorrect type %s." 

"'ConfigClass' must be a subclass of Config" % _typeStr(ConfigClass)) 

168 ↛ 169line 168 didn't jump to line 169, because the condition on line 168 was never true if not hasattr(target, '__call__'): 

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

170 ↛ 171line 170 didn't jump to line 171, because the condition on line 170 was never true if not hasattr(target, '__module__') or not hasattr(target, '__name__'): 

raise ValueError("'target' must be statically defined" 

"(must have '__module__' and '__name__' attributes)") 

return ConfigClass 

 

def __init__(self, doc, target, ConfigClass=None, default=None, check=None): 

""" 

@param target is the configurable target. Must be callable, and the first 

parameter will be the value of this field 

@param ConfigClass is the class of Config object expected by the target. 

If not provided by target.ConfigClass it must be provided explicitly in this argument 

""" 

ConfigClass = self.validateTarget(target, ConfigClass) 

 

if default is None: 

default = ConfigClass 

186 ↛ 187line 186 didn't jump to line 187, because the condition on line 186 was never true if default != ConfigClass and type(default) != ConfigClass: 

raise TypeError("'default' is of incorrect type %s. Expected %s" % 

(_typeStr(default), _typeStr(ConfigClass))) 

 

source = getStackFrame() 

self._setup(doc=doc, dtype=ConfigurableInstance, default=default, 

check=check, optional=False, source=source) 

self.target = target 

self.ConfigClass = ConfigClass 

 

def __getOrMake(self, instance, at=None, label="default"): 

value = instance._storage.get(self.name, None) 

if value is None: 

if at is None: 

at = getCallStack(1) 

value = ConfigurableInstance(instance, self, at=at, label=label) 

instance._storage[self.name] = value 

return value 

 

def __get__(self, instance, owner=None, at=None, label="default"): 

if instance is None or not isinstance(instance, Config): 

return self 

else: 

return self.__getOrMake(instance, at=at, label=label) 

 

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

if instance._frozen: 

raise FieldValidationError(self, instance, "Cannot modify a frozen Config") 

if at is None: 

at = getCallStack() 

oldValue = self.__getOrMake(instance, at=at) 

 

if isinstance(value, ConfigurableInstance): 

oldValue.retarget(value.target, value.ConfigClass, at, label) 

oldValue.update(__at=at, __label=label, **value._storage) 

elif type(value) == oldValue._ConfigClass: 

oldValue.update(__at=at, __label=label, **value._storage) 

elif value == oldValue.ConfigClass: 

value = oldValue.ConfigClass() 

oldValue.update(__at=at, __label=label, **value._storage) 

else: 

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

(value, _typeStr(value), _typeStr(oldValue.ConfigClass)) 

raise FieldValidationError(self, instance, msg) 

 

def rename(self, instance): 

fullname = _joinNamePath(instance._name, self.name) 

value = self.__getOrMake(instance) 

value._rename(fullname) 

 

def save(self, outfile, instance): 

fullname = _joinNamePath(instance._name, self.name) 

value = self.__getOrMake(instance) 

target = value.target 

 

if target != self.target: 

# not targeting the field-default target. 

# save target information 

ConfigClass = value.ConfigClass 

for module in set([target.__module__, ConfigClass.__module__]): 

outfile.write(u"import {}\n".format(module)) 

outfile.write(u"{}.retarget(target={}, ConfigClass={})\n\n".format(fullname, 

_typeStr(target), 

_typeStr(ConfigClass))) 

# save field values 

value._save(outfile) 

 

def freeze(self, instance): 

value = self.__getOrMake(instance) 

value.freeze() 

 

def toDict(self, instance): 

value = self.__get__(instance) 

return value.toDict() 

 

def validate(self, instance): 

value = self.__get__(instance) 

value.validate() 

 

if self.check is not None and not self.check(value): 

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

raise FieldValidationError(self, instance, msg) 

 

def __deepcopy__(self, memo): 

"""Customize deep-copying, because we always want a reference to the original typemap. 

 

WARNING: this must be overridden by subclasses if they change the constructor signature! 

""" 

return type(self)(doc=self.doc, target=self.target, ConfigClass=self.ConfigClass, 

default=copy.deepcopy(self.default)) 

 

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. 

""" 

c1 = getattr(instance1, self.name)._value 

c2 = getattr(instance2, self.name)._value 

name = getComparisonName( 

_joinNamePath(instance1._name, self.name), 

_joinNamePath(instance2._name, self.name) 

) 

return compareConfigs(name, c1, c2, shortcut=shortcut, rtol=rtol, atol=atol, output=output)