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

# This file is part of daf_butler. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (https://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# 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 GNU General Public License 

# along with this program. If not, see <https://www.gnu.org/licenses/>. 

 

"""Simple unit test for expr_parser/parserYacc module. 

""" 

 

import unittest 

 

from lsst.daf.butler.exprParser import exprTree, TreeVisitor, ParserYacc, ParseError 

import lsst.utils.tests 

 

 

class _Visitor(TreeVisitor): 

"""Trivial implementation of TreeVisitor. 

""" 

def visitNumericLiteral(self, value, node): 

return f"N({value})" 

 

def visitStringLiteral(self, value, node): 

return f"S({value})" 

 

def visitIdentifier(self, name, node): 

return f"ID({name})" 

 

def visitUnaryOp(self, operator, operand, node): 

return f"U({operator} {operand})" 

 

def visitBinaryOp(self, operator, lhs, rhs, node): 

return f"B({lhs} {operator} {rhs})" 

 

def visitIsIn(self, lhs, values, not_in, node): 

values = ", ".join([str(val) for val in values]) 

if not_in: 

return f"!IN({lhs} ({values}))" 

else: 

return f"IN({lhs} ({values}))" 

 

def visitParens(self, expression, node): 

return f"P({expression})" 

 

 

class ParserLexTestCase(unittest.TestCase): 

"""A test case for ParserYacc 

""" 

 

def setUp(self): 

pass 

 

def tearDown(self): 

pass 

 

def testInstantiate(self): 

"""Tests for making ParserLex instances 

""" 

parser = ParserYacc() # noqa: F841 

 

def testEmpty(self): 

"""Tests for empty expression 

""" 

parser = ParserYacc() 

 

# empty expression is allowed, returns None 

tree = parser.parse("") 

self.assertIsNone(tree) 

 

def testParseLiteral(self): 

"""Tests for literals (strings/numbers) 

""" 

parser = ParserYacc() 

 

tree = parser.parse('1') 

self.assertIsInstance(tree, exprTree.NumericLiteral) 

self.assertEqual(tree.value, '1') 

 

tree = parser.parse('.5e-2') 

self.assertIsInstance(tree, exprTree.NumericLiteral) 

self.assertEqual(tree.value, '.5e-2') 

 

tree = parser.parse("'string'") 

self.assertIsInstance(tree, exprTree.StringLiteral) 

self.assertEqual(tree.value, 'string') 

 

def testParseIdentifiers(self): 

"""Tests for identifiers 

""" 

parser = ParserYacc() 

 

tree = parser.parse('a') 

self.assertIsInstance(tree, exprTree.Identifier) 

self.assertEqual(tree.name, 'a') 

 

tree = parser.parse('a.b') 

self.assertIsInstance(tree, exprTree.Identifier) 

self.assertEqual(tree.name, 'a.b') 

 

def testParseParens(self): 

"""Tests for identifiers 

""" 

parser = ParserYacc() 

 

tree = parser.parse('(a)') 

self.assertIsInstance(tree, exprTree.Parens) 

self.assertIsInstance(tree.expr, exprTree.Identifier) 

self.assertEqual(tree.expr.name, 'a') 

 

def testUnaryOps(self): 

"""Tests for unary plus and minus 

""" 

parser = ParserYacc() 

 

tree = parser.parse('+a') 

self.assertIsInstance(tree, exprTree.UnaryOp) 

self.assertEqual(tree.op, '+') 

self.assertIsInstance(tree.operand, exprTree.Identifier) 

self.assertEqual(tree.operand.name, 'a') 

 

tree = parser.parse('- x.y') 

self.assertIsInstance(tree, exprTree.UnaryOp) 

self.assertEqual(tree.op, '-') 

self.assertIsInstance(tree.operand, exprTree.Identifier) 

self.assertEqual(tree.operand.name, 'x.y') 

 

def testBinaryOps(self): 

"""Tests for binary operators 

""" 

parser = ParserYacc() 

 

tree = parser.parse('a + b') 

self.assertIsInstance(tree, exprTree.BinaryOp) 

self.assertEqual(tree.op, '+') 

self.assertIsInstance(tree.lhs, exprTree.Identifier) 

self.assertIsInstance(tree.rhs, exprTree.Identifier) 

self.assertEqual(tree.lhs.name, 'a') 

self.assertEqual(tree.rhs.name, 'b') 

 

tree = parser.parse('a - 2') 

self.assertIsInstance(tree, exprTree.BinaryOp) 

self.assertEqual(tree.op, '-') 

self.assertIsInstance(tree.lhs, exprTree.Identifier) 

self.assertIsInstance(tree.rhs, exprTree.NumericLiteral) 

self.assertEqual(tree.lhs.name, 'a') 

self.assertEqual(tree.rhs.value, '2') 

 

tree = parser.parse('2 * 2') 

self.assertIsInstance(tree, exprTree.BinaryOp) 

self.assertEqual(tree.op, '*') 

self.assertIsInstance(tree.lhs, exprTree.NumericLiteral) 

self.assertIsInstance(tree.rhs, exprTree.NumericLiteral) 

self.assertEqual(tree.lhs.value, '2') 

self.assertEqual(tree.rhs.value, '2') 

 

tree = parser.parse('1.e5/2') 

self.assertIsInstance(tree, exprTree.BinaryOp) 

self.assertEqual(tree.op, '/') 

self.assertIsInstance(tree.lhs, exprTree.NumericLiteral) 

self.assertIsInstance(tree.rhs, exprTree.NumericLiteral) 

self.assertEqual(tree.lhs.value, '1.e5') 

self.assertEqual(tree.rhs.value, '2') 

 

tree = parser.parse('333%76') 

self.assertIsInstance(tree, exprTree.BinaryOp) 

self.assertEqual(tree.op, '%') 

self.assertIsInstance(tree.lhs, exprTree.NumericLiteral) 

self.assertIsInstance(tree.rhs, exprTree.NumericLiteral) 

self.assertEqual(tree.lhs.value, '333') 

self.assertEqual(tree.rhs.value, '76') 

 

def testIsIn(self): 

"""Tests for IN 

""" 

parser = ParserYacc() 

 

tree = parser.parse("a in (1,2,'X')") 

self.assertIsInstance(tree, exprTree.IsIn) 

self.assertFalse(tree.not_in) 

self.assertIsInstance(tree.lhs, exprTree.Identifier) 

self.assertEqual(tree.lhs.name, 'a') 

self.assertIsInstance(tree.values, list) 

self.assertEqual(len(tree.values), 3) 

self.assertIsInstance(tree.values[0], exprTree.NumericLiteral) 

self.assertEqual(tree.values[0].value, '1') 

self.assertIsInstance(tree.values[1], exprTree.NumericLiteral) 

self.assertEqual(tree.values[1].value, '2') 

self.assertIsInstance(tree.values[2], exprTree.StringLiteral) 

self.assertEqual(tree.values[2].value, 'X') 

 

tree = parser.parse("10 not in (1000)") 

self.assertIsInstance(tree, exprTree.IsIn) 

self.assertTrue(tree.not_in) 

self.assertIsInstance(tree.lhs, exprTree.NumericLiteral) 

self.assertEqual(tree.lhs.value, '10') 

self.assertIsInstance(tree.values, list) 

self.assertEqual(len(tree.values), 1) 

self.assertIsInstance(tree.values[0], exprTree.NumericLiteral) 

self.assertEqual(tree.values[0].value, '1000') 

 

def testCompareOps(self): 

"""Tests for comparison operators 

""" 

parser = ParserYacc() 

 

for op in ('=', '!=', '<', '<=', '>', '>='): 

tree = parser.parse('a {} 10'.format(op)) 

self.assertIsInstance(tree, exprTree.BinaryOp) 

self.assertEqual(tree.op, op) 

self.assertIsInstance(tree.lhs, exprTree.Identifier) 

self.assertIsInstance(tree.rhs, exprTree.NumericLiteral) 

self.assertEqual(tree.lhs.name, 'a') 

self.assertEqual(tree.rhs.value, '10') 

 

def testBoolOps(self): 

"""Tests for boolean operators 

""" 

parser = ParserYacc() 

 

for op in ('OR', 'AND'): 

tree = parser.parse('a {} b'.format(op)) 

self.assertIsInstance(tree, exprTree.BinaryOp) 

self.assertEqual(tree.op, op) 

self.assertIsInstance(tree.lhs, exprTree.Identifier) 

self.assertIsInstance(tree.rhs, exprTree.Identifier) 

self.assertEqual(tree.lhs.name, 'a') 

self.assertEqual(tree.rhs.name, 'b') 

 

tree = parser.parse('NOT b') 

self.assertIsInstance(tree, exprTree.UnaryOp) 

self.assertEqual(tree.op, 'NOT') 

self.assertIsInstance(tree.operand, exprTree.Identifier) 

self.assertEqual(tree.operand.name, 'b') 

 

def testExpression(self): 

"""Test for more or less complete expression""" 

parser = ParserYacc() 

 

expression = ("((instrument='HSC' AND detector != 9) OR instrument='CFHT') " 

"AND tract=8766 AND patch.cell_x > 5 AND " 

"patch.cell_y < 4 AND abstract_filter='i'") 

 

tree = parser.parse(expression) 

self.assertIsInstance(tree, exprTree.BinaryOp) 

self.assertEqual(tree.op, 'AND') 

self.assertIsInstance(tree.lhs, exprTree.BinaryOp) 

# AND is left-associative, so rhs operand will be the 

# last sub-expressions 

self.assertIsInstance(tree.rhs, exprTree.BinaryOp) 

self.assertEqual(tree.rhs.op, '=') 

self.assertIsInstance(tree.rhs.lhs, exprTree.Identifier) 

self.assertEqual(tree.rhs.lhs.name, 'abstract_filter') 

self.assertIsInstance(tree.rhs.rhs, exprTree.StringLiteral) 

self.assertEqual(tree.rhs.rhs.value, 'i') 

 

def testException(self): 

"""Test for exceptional cases""" 

 

def _assertExc(exc, expr, token, pos, lineno, posInLine): 

"""Check exception attribute values""" 

self.assertEqual(exc.expression, expr) 

self.assertEqual(exc.token, token) 

self.assertEqual(exc.pos, pos) 

self.assertEqual(exc.lineno, lineno) 

self.assertEqual(exc.posInLine, posInLine) 

 

parser = ParserYacc() 

 

expression = "(1, 2, 3)" 

with self.assertRaises(ParseError) as catcher: 

parser.parse(expression) 

_assertExc(catcher.exception, expression, ",", 2, 1, 2) 

 

expression = "\n(1\n,\n 2, 3)" 

with self.assertRaises(ParseError) as catcher: 

parser.parse(expression) 

_assertExc(catcher.exception, expression, ",", 4, 3, 0) 

 

def testStr(self): 

"""Test for formatting""" 

parser = ParserYacc() 

 

tree = parser.parse("(a+b)") 

self.assertEqual(str(tree), '(a + b)') 

 

tree = parser.parse("1 in (1,'x',3)") 

self.assertEqual(str(tree), "1 IN (1, 'x', 3)") 

 

tree = parser.parse("a not in (1,'x',3)") 

self.assertEqual(str(tree), "a NOT IN (1, 'x', 3)") 

 

tree = parser.parse("(A or B) And NoT (x+3 > y)") 

self.assertEqual(str(tree), "(A OR B) AND NOT (x + 3 > y)") 

 

def testVisit(self): 

"""Test for visitor methods""" 

 

# test should cover all visit* methods 

parser = ParserYacc() 

visitor = _Visitor() 

 

tree = parser.parse("(a+b)") 

result = tree.visit(visitor) 

self.assertEqual(result, "P(B(ID(a) + ID(b)))") 

 

tree = parser.parse("(A or B) and not (x + 3 > y)") 

result = tree.visit(visitor) 

self.assertEqual(result, "B(P(B(ID(A) OR ID(B))) AND U(NOT P(B(B(ID(x) + N(3)) > ID(y)))))") 

 

tree = parser.parse("x in (1,2) AND y NOT IN (1.1, .25, 1e2) OR z in ('a', 'b')") 

result = tree.visit(visitor) 

self.assertEqual(result, "B(B(IN(ID(x) (N(1), N(2))) AND !IN(ID(y) (N(1.1), N(.25), N(1e2))))" 

" OR IN(ID(z) (S(a), S(b))))") 

 

 

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

pass 

 

 

def setup_module(module): 

lsst.utils.tests.init() 

 

 

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

lsst.utils.tests.init() 

unittest.main()