Coverage for tests/test_exprParserLex.py: 9%
180 statements
« prev ^ index » next coverage.py v7.2.7, created at 2023-06-28 10:10 +0000
« prev ^ index » next coverage.py v7.2.7, created at 2023-06-28 10:10 +0000
1# This file is part of daf_butler.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
22"""Simple unit test for expr_parser/parserLex module.
23"""
25import re
26import unittest
28from lsst.daf.butler.registry.queries.expressions.parser import ParserLex, ParserLexError
31class ParserLexTestCase(unittest.TestCase):
32 """A test case for ParserLex"""
34 def _assertToken(self, token, type, value, lineno=None, lexpos=None):
35 self.assertIsNotNone(token)
36 self.assertEqual(token.type, type)
37 self.assertEqual(token.value, value)
38 if lineno is not None:
39 self.assertEqual(token.lineno, lineno)
40 if lexpos is not None:
41 self.assertEqual(token.lexpos, lexpos)
43 def setUp(self):
44 pass
46 def tearDown(self):
47 pass
49 def testInstantiate(self):
50 """Tests for making ParserLex instances"""
51 default_reflags = re.IGNORECASE | re.VERBOSE
52 lexer = ParserLex.make_lexer()
53 self.assertEqual(lexer.lexreflags, default_reflags)
55 lexer = ParserLex.make_lexer(reflags=re.DOTALL)
56 self.assertEqual(lexer.lexreflags, re.DOTALL | default_reflags)
58 def testSimpleTokens(self):
59 """Test for simple tokens"""
60 lexer = ParserLex.make_lexer()
62 lexer.input("=!= <<= >>= +-*/()")
63 self._assertToken(lexer.token(), "EQ", "=")
64 self._assertToken(lexer.token(), "NE", "!=")
65 self._assertToken(lexer.token(), "LT", "<")
66 self._assertToken(lexer.token(), "LE", "<=")
67 self._assertToken(lexer.token(), "GT", ">")
68 self._assertToken(lexer.token(), "GE", ">=")
69 self._assertToken(lexer.token(), "ADD", "+")
70 self._assertToken(lexer.token(), "SUB", "-")
71 self._assertToken(lexer.token(), "MUL", "*")
72 self._assertToken(lexer.token(), "DIV", "/")
73 self._assertToken(lexer.token(), "LPAREN", "(")
74 self._assertToken(lexer.token(), "RPAREN", ")")
75 self.assertIsNone(lexer.token())
77 def testReservedTokens(self):
78 """Test for reserved words"""
79 lexer = ParserLex.make_lexer()
81 tokens = "NOT IN OR AND OVERLAPS"
82 lexer.input(tokens)
83 for token in tokens.split():
84 self._assertToken(lexer.token(), token, token)
85 self.assertIsNone(lexer.token())
87 tokens = "not in or and overlaps"
88 lexer.input(tokens)
89 for token in tokens.split():
90 self._assertToken(lexer.token(), token.upper(), token.upper())
91 self.assertIsNone(lexer.token())
93 # not reserved
94 token = "NOTIN"
95 lexer.input(token)
96 self._assertToken(lexer.token(), "SIMPLE_IDENTIFIER", token)
97 self.assertIsNone(lexer.token())
99 def testStringLiteral(self):
100 """Test for string literals"""
101 lexer = ParserLex.make_lexer()
103 lexer.input("''")
104 self._assertToken(lexer.token(), "STRING_LITERAL", "")
105 self.assertIsNone(lexer.token())
107 lexer.input("'string'")
108 self._assertToken(lexer.token(), "STRING_LITERAL", "string")
109 self.assertIsNone(lexer.token())
111 lexer.input("'string' 'string'\n'string'")
112 self._assertToken(lexer.token(), "STRING_LITERAL", "string")
113 self._assertToken(lexer.token(), "STRING_LITERAL", "string")
114 self._assertToken(lexer.token(), "STRING_LITERAL", "string")
115 self.assertIsNone(lexer.token())
117 # odd newline inside string
118 lexer.input("'string\nstring'")
119 with self.assertRaises(ParserLexError):
120 lexer.token()
122 lexer.input("'string")
123 with self.assertRaises(ParserLexError):
124 lexer.token()
126 def testNumericLiteral(self):
127 """Test for numeric literals"""
128 lexer = ParserLex.make_lexer()
130 lexer.input("0 100 999. 100.1 1e10 1e-10 1.e+20 .2E5")
131 self._assertToken(lexer.token(), "NUMERIC_LITERAL", "0")
132 self._assertToken(lexer.token(), "NUMERIC_LITERAL", "100")
133 self._assertToken(lexer.token(), "NUMERIC_LITERAL", "999.")
134 self._assertToken(lexer.token(), "NUMERIC_LITERAL", "100.1")
135 self._assertToken(lexer.token(), "NUMERIC_LITERAL", "1e10")
136 self._assertToken(lexer.token(), "NUMERIC_LITERAL", "1e-10")
137 self._assertToken(lexer.token(), "NUMERIC_LITERAL", "1.e+20")
138 self._assertToken(lexer.token(), "NUMERIC_LITERAL", ".2E5")
139 self.assertIsNone(lexer.token())
141 def testRangeLiteral(self):
142 """Test for range literals"""
143 lexer = ParserLex.make_lexer()
145 lexer.input("0..10 -10..-1 -10..10:2 0 .. 10 0 .. 10 : 2 ")
146 self._assertToken(lexer.token(), "RANGE_LITERAL", (0, 10, None))
147 self._assertToken(lexer.token(), "RANGE_LITERAL", (-10, -1, None))
148 self._assertToken(lexer.token(), "RANGE_LITERAL", (-10, 10, 2))
149 self._assertToken(lexer.token(), "RANGE_LITERAL", (0, 10, None))
150 self._assertToken(lexer.token(), "RANGE_LITERAL", (0, 10, 2))
151 self.assertIsNone(lexer.token())
153 def testTimeLiteral(self):
154 """Test for time literals"""
155 lexer = ParserLex.make_lexer()
157 # string can contain anything, lexer does not check it
158 lexer.input("T'2020-03-30' T'2020-03-30 00:00:00' T'2020-03-30T00:00:00' T'123.456' T'time'")
159 self._assertToken(lexer.token(), "TIME_LITERAL", "2020-03-30")
160 self._assertToken(lexer.token(), "TIME_LITERAL", "2020-03-30 00:00:00")
161 self._assertToken(lexer.token(), "TIME_LITERAL", "2020-03-30T00:00:00")
162 self._assertToken(lexer.token(), "TIME_LITERAL", "123.456")
163 self._assertToken(lexer.token(), "TIME_LITERAL", "time")
164 self.assertIsNone(lexer.token())
166 def testIdentifier(self):
167 """Test for numeric literals"""
168 lexer = ParserLex.make_lexer()
170 lexer.input("ID id _012 a_b_C")
171 self._assertToken(lexer.token(), "SIMPLE_IDENTIFIER", "ID")
172 self._assertToken(lexer.token(), "SIMPLE_IDENTIFIER", "id")
173 self._assertToken(lexer.token(), "SIMPLE_IDENTIFIER", "_012")
174 self._assertToken(lexer.token(), "SIMPLE_IDENTIFIER", "a_b_C")
175 self.assertIsNone(lexer.token())
177 lexer.input("a.b a.b.c _._ _._._")
178 self._assertToken(lexer.token(), "QUALIFIED_IDENTIFIER", "a.b")
179 self._assertToken(lexer.token(), "QUALIFIED_IDENTIFIER", "a.b.c")
180 self._assertToken(lexer.token(), "QUALIFIED_IDENTIFIER", "_._")
181 self._assertToken(lexer.token(), "QUALIFIED_IDENTIFIER", "_._._")
182 self.assertIsNone(lexer.token())
184 lexer.input(".id")
185 with self.assertRaises(ParserLexError):
186 lexer.token()
188 lexer.input("id.")
189 self._assertToken(lexer.token(), "SIMPLE_IDENTIFIER", "id")
190 with self.assertRaises(ParserLexError):
191 lexer.token()
193 lexer.input("id.id.id.id")
194 self._assertToken(lexer.token(), "QUALIFIED_IDENTIFIER", "id.id.id")
195 with self.assertRaises(ParserLexError):
196 lexer.token()
198 def testExpression(self):
199 """Test for more or less complete expression"""
200 lexer = ParserLex.make_lexer()
202 expr = (
203 "((instrument='HSC' AND detector != 9) OR instrument='CFHT') "
204 "AND tract=8766 AND patch.cell_x > 5 AND "
205 "patch.cell_y < 4 AND band='i' "
206 "or visit IN (1..50:2)"
207 )
208 tokens = (
209 ("LPAREN", "("),
210 ("LPAREN", "("),
211 ("SIMPLE_IDENTIFIER", "instrument"),
212 ("EQ", "="),
213 ("STRING_LITERAL", "HSC"),
214 ("AND", "AND"),
215 ("SIMPLE_IDENTIFIER", "detector"),
216 ("NE", "!="),
217 ("NUMERIC_LITERAL", "9"),
218 ("RPAREN", ")"),
219 ("OR", "OR"),
220 ("SIMPLE_IDENTIFIER", "instrument"),
221 ("EQ", "="),
222 ("STRING_LITERAL", "CFHT"),
223 ("RPAREN", ")"),
224 ("AND", "AND"),
225 ("SIMPLE_IDENTIFIER", "tract"),
226 ("EQ", "="),
227 ("NUMERIC_LITERAL", "8766"),
228 ("AND", "AND"),
229 ("QUALIFIED_IDENTIFIER", "patch.cell_x"),
230 ("GT", ">"),
231 ("NUMERIC_LITERAL", "5"),
232 ("AND", "AND"),
233 ("QUALIFIED_IDENTIFIER", "patch.cell_y"),
234 ("LT", "<"),
235 ("NUMERIC_LITERAL", "4"),
236 ("AND", "AND"),
237 ("SIMPLE_IDENTIFIER", "band"),
238 ("EQ", "="),
239 ("STRING_LITERAL", "i"),
240 ("OR", "OR"),
241 ("SIMPLE_IDENTIFIER", "visit"),
242 ("IN", "IN"),
243 ("LPAREN", "("),
244 ("RANGE_LITERAL", (1, 50, 2)),
245 ("RPAREN", ")"),
246 )
247 lexer.input(expr)
248 for type, value in tokens:
249 self._assertToken(lexer.token(), type, value)
250 self.assertIsNone(lexer.token())
252 def testExceptions(self):
253 """Test for exception contents"""
255 def _assertExc(exc, expr, remain, pos, lineno):
256 """Check exception attribute values"""
257 self.assertEqual(exc.expression, expr)
258 self.assertEqual(exc.remain, remain)
259 self.assertEqual(exc.pos, pos)
260 self.assertEqual(exc.lineno, lineno)
262 lexer = ParserLex.make_lexer()
263 expr = "a.b.c.d"
264 lexer.input(expr)
265 self._assertToken(lexer.token(), "QUALIFIED_IDENTIFIER", "a.b.c")
266 with self.assertRaises(ParserLexError) as catcher:
267 lexer.token()
268 _assertExc(catcher.exception, expr, ".d", 5, 1)
270 lexer = ParserLex.make_lexer()
271 expr = "a \n& b"
272 lexer.input(expr)
273 self._assertToken(lexer.token(), "SIMPLE_IDENTIFIER", "a")
274 with self.assertRaises(ParserLexError) as catcher:
275 lexer.token()
276 _assertExc(catcher.exception, expr, "& b", 3, 2)
278 lexer = ParserLex.make_lexer()
279 expr = "a\n=\n1e5.e2"
280 lexer.input(expr)
281 self._assertToken(lexer.token(), "SIMPLE_IDENTIFIER", "a")
282 self._assertToken(lexer.token(), "EQ", "=")
283 self._assertToken(lexer.token(), "NUMERIC_LITERAL", "1e5")
284 with self.assertRaises(ParserLexError) as catcher:
285 lexer.token()
286 _assertExc(catcher.exception, expr, ".e2", 7, 3)
288 # zero stride in range literal
289 lexer = ParserLex.make_lexer()
290 expr = "1..2:0"
291 lexer.input(expr)
292 self._assertToken(lexer.token(), "RANGE_LITERAL", (1, 2, None))
293 with self.assertRaises(ParserLexError) as catcher:
294 lexer.token()
295 _assertExc(catcher.exception, expr, ":0", 4, 1)
297 # negative stride in range literal
298 lexer = ParserLex.make_lexer()
299 expr = "1..2:-10"
300 lexer.input(expr)
301 self._assertToken(lexer.token(), "RANGE_LITERAL", (1, 2, None))
302 with self.assertRaises(ParserLexError) as catcher:
303 lexer.token()
304 _assertExc(catcher.exception, expr, ":-10", 4, 1)
307if __name__ == "__main__":
308 unittest.main()