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

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

# 

# 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__ = ["ConfigChoiceField"] 

 

import copy 

import collections 

 

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

from .comparison import getComparisonName, compareScalars, compareConfigs 

from .callStack import getCallStack, getStackFrame 

 

 

class SelectionSet(collections.MutableSet): 

""" 

Custom set class used to track the selection of multi-select 

ConfigChoiceField. 

 

This class allows user a multi-select ConfigChoiceField to add/discard 

items from the set of active configs. Each change to the selection is 

tracked in the field's history. 

""" 

def __init__(self, dict_, value, at=None, label="assignment", setHistory=True): 

43 ↛ 45line 43 didn't jump to line 45, because the condition on line 43 was never false if at is None: 

at = getCallStack() 

self._dict = dict_ 

self._field = self._dict._field 

self._config = self._dict._config 

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

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

try: 

for v in value: 

if v not in self._dict: 

# invoke __getitem__ to ensure it's present 

self._dict.__getitem__(v, at=at) 

except TypeError: 

msg = "Value %s is of incorrect type %s. Sequence type expected"(value, _typeStr(value)) 

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

self._set = set(value) 

else: 

self._set = set() 

 

62 ↛ 63line 62 didn't jump to line 63, because the condition on line 62 was never true if setHistory: 

self.__history.append(("Set selection to %s" % self, at, label)) 

 

def add(self, value, at=None): 

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

raise FieldValidationError(self._field, self._config, 

"Cannot modify a frozen Config") 

 

70 ↛ 73line 70 didn't jump to line 73, because the condition on line 70 was never false if at is None: 

at = getCallStack() 

 

if value not in self._dict: 

# invoke __getitem__ to make sure it's present 

self._dict.__getitem__(value, at=at) 

 

self.__history.append(("added %s to selection" % value, at, "selection")) 

self._set.add(value) 

 

def discard(self, value, at=None): 

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

raise FieldValidationError(self._field, self._config, 

"Cannot modify a frozen Config") 

 

85 ↛ 86line 85 didn't jump to line 86, because the condition on line 85 was never true if value not in self._dict: 

return 

 

88 ↛ 91line 88 didn't jump to line 91, because the condition on line 88 was never false if at is None: 

at = getCallStack() 

 

self.__history.append(("removed %s from selection" % value, at, "selection")) 

self._set.discard(value) 

 

def __len__(self): 

return len(self._set) 

 

def __iter__(self): 

return iter(self._set) 

 

def __contains__(self, value): 

return value in self._set 

 

def __repr__(self): 

return repr(list(self._set)) 

 

def __str__(self): 

return str(list(self._set)) 

 

 

class ConfigInstanceDict(collections.Mapping): 

"""A dict of instantiated configs, used to populate a ConfigChoiceField. 

 

typemap must support the following: 

- typemap[name]: return the config class associated with the given name 

""" 

def __init__(self, config, field): 

collections.Mapping.__init__(self) 

self._dict = dict() 

self._selection = None 

self._config = config 

self._field = field 

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

self.__doc__ = field.doc 

 

125 ↛ exitline 125 didn't run the lambda on line 125 types = property(lambda x: x._field.typemap) 

 

def __contains__(self, k): 

return k in self._field.typemap 

 

def __len__(self): 

return len(self._field.typemap) 

 

def __iter__(self): 

return iter(self._field.typemap) 

 

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

if self._config._frozen: 

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

 

if at is None: 

at = getCallStack(1) 

 

if value is None: 

self._selection = None 

elif self._field.multi: 

self._selection = SelectionSet(self, value, setHistory=False) 

else: 

if value not in self._dict: 

self.__getitem__(value, at=at) # just invoke __getitem__ to make sure it's present 

self._selection = value 

self._history.append((value, at, label)) 

 

def _getNames(self): 

154 ↛ 155line 154 didn't jump to line 155, because the condition on line 154 was never true if not self._field.multi: 

raise FieldValidationError(self._field, self._config, 

"Single-selection field has no attribute 'names'") 

return self._selection 

 

def _setNames(self, value): 

160 ↛ 161line 160 didn't jump to line 161, because the condition on line 160 was never true if not self._field.multi: 

raise FieldValidationError(self._field, self._config, 

"Single-selection field has no attribute 'names'") 

self._setSelection(value) 

 

def _delNames(self): 

if not self._field.multi: 

raise FieldValidationError(self._field, self._config, 

"Single-selection field has no attribute 'names'") 

self._selection = None 

 

def _getName(self): 

172 ↛ 173line 172 didn't jump to line 173, because the condition on line 172 was never true if self._field.multi: 

raise FieldValidationError(self._field, self._config, 

"Multi-selection field has no attribute 'name'") 

return self._selection 

 

def _setName(self, value): 

178 ↛ 179line 178 didn't jump to line 179, because the condition on line 178 was never true if self._field.multi: 

raise FieldValidationError(self._field, self._config, 

"Multi-selection field has no attribute 'name'") 

self._setSelection(value) 

 

def _delName(self): 

if self._field.multi: 

raise FieldValidationError(self._field, self._config, 

"Multi-selection field has no attribute 'name'") 

self._selection = None 

 

""" 

In a multi-selection ConfigInstanceDict, list of names of active items 

Disabled In a single-selection _Regsitry) 

""" 

names = property(_getNames, _setNames, _delNames) 

 

""" 

In a single-selection ConfigInstanceDict, name of the active item 

Disabled In a multi-selection _Regsitry) 

""" 

name = property(_getName, _setName, _delName) 

 

def _getActive(self): 

if self._selection is None: 

return None 

 

if self._field.multi: 

return [self[c] for c in self._selection] 

else: 

return self[self._selection] 

 

""" 

Readonly shortcut to access the selected item(s) 

for multi-selection, this is equivalent to: [self[name] for name in self.names] 

for single-selection, this is equivalent to: self[name] 

""" 

active = property(_getActive) 

 

def __getitem__(self, k, at=None, label="default"): 

try: 

value = self._dict[k] 

except KeyError: 

try: 

dtype = self._field.typemap[k] 

except Exception: 

raise FieldValidationError(self._field, self._config, 

"Unknown key %r in Registry/ConfigChoiceField" % k) 

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

if at is None: 

at = getCallStack() 

at.insert(0, dtype._source) 

value = self._dict.setdefault(k, dtype(__name=name, __at=at, __label=label)) 

return value 

 

def __setitem__(self, k, value, at=None, label="assignment"): 

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

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

 

try: 

dtype = self._field.typemap[k] 

except Exception: 

raise FieldValidationError(self._field, self._config, "Unknown key %r" % k) 

 

242 ↛ 243line 242 didn't jump to line 243, because the condition on line 242 was never true if value != dtype and type(value) != dtype: 

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

(value, k, _typeStr(value), _typeStr(dtype)) 

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

 

if at is None: 

at = getCallStack() 

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

oldValue = self._dict.get(k, None) 

if oldValue is None: 

252 ↛ 253line 252 didn't jump to line 253, because the condition on line 252 was never true if value == dtype: 

self._dict[k] = value(__name=name, __at=at, __label=label) 

else: 

self._dict[k] = dtype(__name=name, __at=at, __label=label, **value._storage) 

else: 

257 ↛ 258line 257 didn't jump to line 258, because the condition on line 257 was never true if value == dtype: 

value = value() 

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

 

def _rename(self, fullname): 

for k, v in self._dict.items(): 

v._rename(_joinNamePath(name=fullname, index=k)) 

 

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

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 ["_history", "_field", "_config", "_dict", 

"_selection", "__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 ConfigChoiceField(Field): 

""" 

ConfigChoiceFields allow the config to choose from a set of possible Config types. 

The set of allowable types is given by the typemap argument to the constructor 

 

The typemap object must implement typemap[name], which must return a Config subclass. 

 

While the typemap is shared by all instances of the field, each instance of 

the field has its own instance of a particular sub-config type 

 

For example: 

 

class AaaConfig(Config): 

somefield = Field(int, "...") 

TYPEMAP = {"A", AaaConfig} 

class MyConfig(Config): 

choice = ConfigChoiceField("doc for choice", TYPEMAP) 

 

instance = MyConfig() 

instance.choice['AAA'].somefield = 5 

instance.choice = "AAA" 

 

Alternatively, the last line can be written: 

instance.choice.name = "AAA" 

 

Validation of this field is performed only the "active" selection. 

If active is None and the field is not optional, validation will fail. 

 

ConfigChoiceFields can allow single selections or multiple selections. 

Single selection fields set selection through property name, and 

multi-selection fields use the property names. 

 

ConfigChoiceFields also allow multiple values of the same type: 

TYPEMAP["CCC"] = AaaConfig 

TYPEMAP["BBB"] = AaaConfig 

 

When saving a config with a ConfigChoiceField, the entire set is saved, as well as the active selection 

""" 

instanceDictClass = ConfigInstanceDict 

 

def __init__(self, doc, typemap, default=None, optional=False, multi=False): 

source = getStackFrame() 

self._setup(doc=doc, dtype=self.instanceDictClass, default=default, check=None, optional=optional, 

source=source) 

self.typemap = typemap 

self.multi = multi 

 

def _getOrMake(self, instance, label="default"): 

instanceDict = instance._storage.get(self.name) 

if instanceDict is None: 

at = getCallStack(1) 

instanceDict = self.dtype(instance, self) 

instanceDict.__doc__ = self.doc 

instance._storage[self.name] = instanceDict 

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

history.append(("Initialized from defaults", at, label)) 

 

return instanceDict 

 

def __get__(self, instance, owner=None): 

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

return self 

else: 

return self._getOrMake(instance) 

 

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

if instance._frozen: 

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

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

at = getCallStack() 

instanceDict = self._getOrMake(instance) 

if isinstance(value, self.instanceDictClass): 

for k, v in value.items(): 

instanceDict.__setitem__(k, v, at=at, label=label) 

instanceDict._setSelection(value._selection, at=at, label=label) 

 

else: 

instanceDict._setSelection(value, at=at, label=label) 

 

def rename(self, instance): 

instanceDict = self.__get__(instance) 

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

instanceDict._rename(fullname) 

 

def validate(self, instance): 

instanceDict = self.__get__(instance) 

if instanceDict.active is None and not self.optional: 

msg = "Required field cannot be None" 

raise FieldValidationError(self, instance, msg) 

elif instanceDict.active is not None: 

if self.multi: 

for a in instanceDict.active: 

a.validate() 

else: 

instanceDict.active.validate() 

 

def toDict(self, instance): 

instanceDict = self.__get__(instance) 

 

dict_ = {} 

379 ↛ 380line 379 didn't jump to line 380, because the condition on line 379 was never true if self.multi: 

dict_["names"] = instanceDict.names 

else: 

dict_["name"] = instanceDict.name 

 

values = {} 

for k, v in instanceDict.items(): 

values[k] = v.toDict() 

dict_["values"] = values 

 

return dict_ 

 

def freeze(self, instance): 

instanceDict = self.__get__(instance) 

for v in instanceDict.values(): 

v.freeze() 

 

def save(self, outfile, instance): 

instanceDict = self.__get__(instance) 

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

for v in instanceDict.values(): 

v._save(outfile) 

if self.multi: 

outfile.write(u"{}.names={!r}\n".format(fullname, instanceDict.names)) 

else: 

outfile.write(u"{}.name={!r}\n".format(fullname, instanceDict.name)) 

 

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! 

""" 

other = type(self)(doc=self.doc, typemap=self.typemap, default=copy.deepcopy(self.default), 

optional=self.optional, multi=self.multi) 

other.source = self.source 

return other 

 

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

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

 

Only the selected config(s) are compared, as the parameters of any others do not matter. 

 

@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) 

) 

437 ↛ 438line 437 didn't jump to line 438, because the condition on line 437 was never true if not compareScalars("selection for %s" % name, d1._selection, d2._selection, output=output): 

return False 

439 ↛ 440line 439 didn't jump to line 440, because the condition on line 439 was never true if d1._selection is None: 

return True 

441 ↛ 442line 441 didn't jump to line 442, because the condition on line 441 was never true if self.multi: 

nested = [(k, d1[k], d2[k]) for k in d1._selection] 

else: 

nested = [(d1._selection, d1[d1._selection], d2[d1._selection])] 

equal = True 

for k, c1, c2 in nested: 

result = compareConfigs("%s[%r]" % (name, k), c1, c2, shortcut=shortcut, 

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

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

return False 

equal = equal and result 

return equal