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

# 

# 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 time 

import unittest 

import numbers 

 

from past.builtins import basestring 

 

import lsst.utils.tests 

import lsst.daf.base as dafBase 

from lsst.log import Log 

import lsst.pex.config as pexConfig 

import lsst.pipe.base as pipeBase 

 

 

class AddConfig(pexConfig.Config): 

addend = pexConfig.Field(doc="amount to add", dtype=float, default=3.1) 

 

 

class AddTask(pipeBase.Task): 

ConfigClass = AddConfig 

 

@pipeBase.timeMethod 

def run(self, val): 

self.metadata.add("add", self.config.addend) 

return pipeBase.Struct( 

val=val + self.config.addend, 

) 

 

 

class MultConfig(pexConfig.Config): 

multiplicand = pexConfig.Field(doc="amount by which to multiply", dtype=float, default=2.5) 

 

 

class MultTask(pipeBase.Task): 

ConfigClass = MultConfig 

 

@pipeBase.timeMethod 

def run(self, val): 

self.metadata.add("mult", self.config.multiplicand) 

return pipeBase.Struct( 

val=val * self.config.multiplicand, 

) 

 

 

# prove that registry fields can also be used to hold subtasks 

# by using a registry to hold MultTask 

multRegistry = pexConfig.makeRegistry("Registry for Mult-like tasks") 

multRegistry.register("stdMult", MultTask) 

 

 

class AddMultConfig(pexConfig.Config): 

add = AddTask.makeField("add task") 

mult = multRegistry.makeField("mult task", default="stdMult") 

 

 

class AddMultTask(pipeBase.Task): 

ConfigClass = AddMultConfig 

_DefaultName = "addMult" 

 

"""First add, then multiply""" 

 

def __init__(self, **keyArgs): 

pipeBase.Task.__init__(self, **keyArgs) 

self.makeSubtask("add") 

self.makeSubtask("mult") 

 

@pipeBase.timeMethod 

def run(self, val): 

with self.timer("context"): 

addRet = self.add.run(val) 

multRet = self.mult.run(addRet.val) 

self.metadata.add("addmult", multRet.val) 

return pipeBase.Struct( 

val=multRet.val, 

) 

 

@pipeBase.timeMethod 

def failDec(self): 

"""A method that fails with a decorator 

""" 

raise RuntimeError("failDec intentional error") 

 

def failCtx(self): 

"""A method that fails inside a context manager 

""" 

with self.timer("failCtx"): 

raise RuntimeError("failCtx intentional error") 

 

 

class AddTwiceTask(AddTask): 

"""Variant of AddTask that adds twice the addend""" 

 

def run(self, val): 

addend = self.config.addend 

return pipeBase.Struct(val=val + (2 * addend)) 

 

 

class TaskTestCase(unittest.TestCase): 

"""A test case for Task 

""" 

 

def setUp(self): 

self.valDict = dict() 

 

def tearDown(self): 

self.valDict = None 

 

def testBasics(self): 

"""Test basic construction and use of a task 

""" 

for addend in (1.1, -3.5): 

for multiplicand in (0.9, -45.0): 

config = AddMultTask.ConfigClass() 

config.add.addend = addend 

config.mult["stdMult"].multiplicand = multiplicand 

# make sure both ways of accessing the registry work and give the same result 

self.assertEqual(config.mult.active.multiplicand, multiplicand) 

addMultTask = AddMultTask(config=config) 

for val in (-1.0, 0.0, 17.5): 

ret = addMultTask.run(val=val) 

self.assertAlmostEqual(ret.val, (val + addend) * multiplicand) 

 

def testNames(self): 

"""Test getName() and getFullName() 

""" 

addMultTask = AddMultTask() 

self.assertEqual(addMultTask.getName(), "addMult") 

self.assertEqual(addMultTask.add.getName(), "add") 

self.assertEqual(addMultTask.mult.getName(), "mult") 

 

self.assertEqual(addMultTask._name, "addMult") 

self.assertEqual(addMultTask.add._name, "add") 

self.assertEqual(addMultTask.mult._name, "mult") 

 

self.assertEqual(addMultTask.getFullName(), "addMult") 

self.assertEqual(addMultTask.add.getFullName(), "addMult.add") 

self.assertEqual(addMultTask.mult.getFullName(), "addMult.mult") 

 

self.assertEqual(addMultTask._fullName, "addMult") 

self.assertEqual(addMultTask.add._fullName, "addMult.add") 

self.assertEqual(addMultTask.mult._fullName, "addMult.mult") 

 

def testLog(self): 

"""Test the Task's logger 

""" 

addMultTask = AddMultTask() 

self.assertEqual(addMultTask.log.getName(), "addMult") 

self.assertEqual(addMultTask.add.log.getName(), "addMult.add") 

 

log = Log.getLogger("tester") 

addMultTask = AddMultTask(log=log) 

self.assertEqual(addMultTask.log.getName(), "tester.addMult") 

self.assertEqual(addMultTask.add.log.getName(), "tester.addMult.add") 

 

def testGetFullMetadata(self): 

"""Test getFullMetadata() 

""" 

addMultTask = AddMultTask() 

fullMetadata = addMultTask.getFullMetadata() 

self.assertIsInstance(fullMetadata.getPropertySet("addMult"), dafBase.PropertySet) 

self.assertIsInstance(fullMetadata.getPropertySet("addMult:add"), dafBase.PropertySet) 

self.assertIsInstance(fullMetadata.getPropertySet("addMult:mult"), dafBase.PropertySet) 

 

def testEmptyMetadata(self): 

task = AddMultTask() 

task.run(val=1.2345) 

task.emptyMetadata() 

fullMetadata = task.getFullMetadata() 

self.assertEqual(fullMetadata.getPropertySet("addMult").nameCount(), 0) 

self.assertEqual(fullMetadata.getPropertySet("addMult:add").nameCount(), 0) 

self.assertEqual(fullMetadata.getPropertySet("addMult:mult").nameCount(), 0) 

 

def testReplace(self): 

"""Test replacing one subtask with another 

""" 

for addend in (1.1, -3.5): 

for multiplicand in (0.9, -45.0): 

config = AddMultTask.ConfigClass() 

config.add.retarget(AddTwiceTask) 

config.add.addend = addend 

config.mult["stdMult"].multiplicand = multiplicand 

addMultTask = AddMultTask(config=config) 

for val in (-1.0, 0.0, 17.5): 

ret = addMultTask.run(val=val) 

self.assertAlmostEqual(ret.val, (val + (2 * addend)) * multiplicand) 

 

def testFail(self): 

"""Test timers when the code they are timing fails 

""" 

addMultTask = AddMultTask() 

try: 

addMultTask.failDec() 

self.fail("Expected RuntimeError") 

except RuntimeError: 

self.assertTrue(addMultTask.metadata.exists("failDecEndCpuTime")) 

try: 

addMultTask.failCtx() 

self.fail("Expected RuntimeError") 

except RuntimeError: 

self.assertTrue(addMultTask.metadata.exists("failCtxEndCpuTime")) 

 

def testTimeMethod(self): 

"""Test that the timer is adding the right metadata 

""" 

addMultTask = AddMultTask() 

addMultTask.run(val=1.1) 

# Check existence and type 

for key, keyType in (("Utc", basestring), 

("CpuTime", float), 

("UserTime", float), 

("SystemTime", float), 

("MaxResidentSetSize", numbers.Integral), 

("MinorPageFaults", numbers.Integral), 

("MajorPageFaults", numbers.Integral), 

("BlockInputs", numbers.Integral), 

("BlockOutputs", numbers.Integral), 

("VoluntaryContextSwitches", numbers.Integral), 

("InvoluntaryContextSwitches", numbers.Integral), 

): 

for when in ("Start", "End"): 

for method in ("run", "context"): 

name = method + when + key 

self.assertIn(name, addMultTask.metadata.names(), 

name + " is missing from task metadata") 

self.assertIsInstance(addMultTask.metadata.getScalar(name), keyType, 

"%s is not of the right type (%s vs %s)" % 

(name, keyType, type(addMultTask.metadata.getScalar(name)))) 

# Some basic sanity checks 

currCpuTime = time.clock() 

self.assertLessEqual( 

addMultTask.metadata.getScalar("runStartCpuTime"), 

addMultTask.metadata.getScalar("runEndCpuTime"), 

) 

self.assertLessEqual(addMultTask.metadata.getScalar("runEndCpuTime"), currCpuTime) 

self.assertLessEqual( 

addMultTask.metadata.getScalar("contextStartCpuTime"), 

addMultTask.metadata.getScalar("contextEndCpuTime"), 

) 

self.assertLessEqual(addMultTask.metadata.getScalar("contextEndCpuTime"), currCpuTime) 

self.assertLessEqual( 

addMultTask.add.metadata.getScalar("runStartCpuTime"), 

addMultTask.metadata.getScalar("runEndCpuTime"), 

) 

self.assertLessEqual(addMultTask.add.metadata.getScalar("runEndCpuTime"), currCpuTime) 

 

 

class MyMemoryTestCase(lsst.utils.tests.MemoryTestCase): 

pass 

 

 

def setup_module(module): 

lsst.utils.tests.init() 

 

 

275 ↛ 276line 275 didn't jump to line 276, because the condition on line 275 was never trueif __name__ == "__main__": 

lsst.utils.tests.init() 

unittest.main()