-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
test_qgsexpression.py
258 lines (213 loc) · 8.77 KB
/
test_qgsexpression.py
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
# -*- coding: utf-8 -*-
"""QGIS Unit tests for QgsExpression.
.. note:: 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 2 of the License, or
(at your option) any later version.
"""
__author__ = 'Nathan Woodrow'
__date__ = '4/11/2012'
__copyright__ = 'Copyright 2012, The QGIS Project'
# This will get replaced with a git SHA1 when you do a git archive
__revision__ = '$Format:%H$'
import qgis # NOQA
from qgis.PyQt.QtCore import QVariant
from qgis.testing import unittest
from qgis.utils import qgsfunction
from qgis.core import QgsExpression, QgsFeatureRequest
class TestQgsExpressionCustomFunctions(unittest.TestCase):
@qgsfunction(1, 'testing', register=False)
def testfun(values, feature, parent):
""" Function help """
return "Testing_%s" % values[0]
@qgsfunction(args="auto", group='testing', register=False)
def autocount(value1, value2, value3, feature, parent):
pass
@qgsfunction(args="auto", group='testing', register=False)
def expandargs(value1, value2, value3, feature, parent):
return value1, value2, value3
@qgsfunction(args=0, group='testing', register=False)
def special(values, feature, parent):
return "test"
@qgsfunction(1, 'testing', register=False)
def sqrt(values, feature, parent):
pass
@qgsfunction(1, 'testing', register=False)
def help_with_docstring(values, feature, parent):
"""The help comes from the python docstring."""
pass
help_text = 'The help comes from a variable.'
@qgsfunction(1, 'testing', register=False, helpText=help_text)
def help_with_variable(values, feature, parent):
"""This docstring is not used for the help."""
pass
@qgsfunction(1, 'testing', register=False, usesgeometry=True)
def geomtest(values, feature, parent):
pass
@qgsfunction(args=0, group='testing', register=False)
def no_referenced_columns_set(values, feature, parent):
return 1
@qgsfunction(args=0, group='testing', register=False, referenced_columns=['a', 'b'])
def referenced_columns_set(values, feature, parent):
return 2
def tearDown(self):
QgsExpression.unregisterFunction('testfun')
def testCanBeRegistered(self):
QgsExpression.registerFunction(self.testfun)
index = QgsExpression.functionIndex('testfun')
self.assertNotEqual(index, -1)
def testAutoCountsCorrectArgs(self):
function = self.autocount
args = function.params()
self.assertEqual(args, 3)
def testHelp(self):
QgsExpression.registerFunction(self.help_with_variable)
html = ('<h3>help_with_variable function</h3><br>'
'The help comes from a variable.')
self.assertEqual(self.help_with_variable.helpText(), html)
QgsExpression.registerFunction(self.help_with_docstring)
html = ('<h3>help_with_docstring function</h3><br>'
'The help comes from the python docstring.')
self.assertEqual(self.help_with_docstring.helpText(), html)
def testAutoArgsAreExpanded(self):
function = self.expandargs
args = function.params()
self.assertEqual(args, 3)
values = [1, 2, 3]
exp = QgsExpression("")
result = function.func(values, None, exp, None)
# Make sure there is no eval error
self.assertEqual(exp.evalErrorString(), "")
self.assertEqual(result, (1, 2, 3))
def testCanUnregisterFunction(self):
QgsExpression.registerFunction(self.testfun)
index = QgsExpression.functionIndex('testfun')
self.assertNotEqual(index, -1)
error = QgsExpression.unregisterFunction('testfun')
self.assertTrue(error)
index = QgsExpression.functionIndex('testfun')
self.assertEqual(index, -1)
def testCanEvaluateFunction(self):
QgsExpression.registerFunction(self.testfun)
exp = QgsExpression('testfun(1)')
result = exp.evaluate()
self.assertEqual('Testing_1', result)
def testZeroArgFunctionsTakeNoArgs(self):
QgsExpression.registerFunction(self.special)
special = self.special
self.assertEqual(special.name(), 'special')
exp = QgsExpression('special()')
result = exp.evaluate()
self.assertEqual('test', result)
def testDecoratorPreservesAttributes(self):
func = self.testfun
self.assertEqual(func.name(), 'testfun')
self.assertEqual(func.group(), 'testing')
self.assertEqual(func.params(), 1)
def testCantReregister(self):
QgsExpression.registerFunction(self.testfun)
success = QgsExpression.registerFunction(self.testfun)
self.assertFalse(success)
def testCanReregisterAfterUnregister(self):
QgsExpression.registerFunction(self.testfun)
QgsExpression.unregisterFunction("testfun")
success = QgsExpression.registerFunction(self.testfun)
self.assertTrue(success)
def testCantOverrideBuiltinsWithRegister(self):
success = QgsExpression.registerFunction(self.sqrt)
self.assertFalse(success)
def testCanRegisterGeometryFunction(self):
success = QgsExpression.registerFunction(self.geomtest)
self.assertTrue(success)
def testReferencedColumnsNoSet(self):
QgsExpression.registerFunction(self.no_referenced_columns_set)
exp = QgsExpression('no_referenced_columns_set()')
self.assertEqual(exp.referencedColumns(),
{QgsFeatureRequest.ALL_ATTRIBUTES})
def testReferencedColumnsSet(self):
QgsExpression.registerFunction(self.referenced_columns_set)
exp = QgsExpression('referenced_columns_set()')
self.assertEqual(set(exp.referencedColumns()), set(['a', 'b']))
def testCantOverrideBuiltinsWithUnregister(self):
success = QgsExpression.unregisterFunction("sqrt")
self.assertFalse(success)
def testDump(self):
for txt in [
"id",
"idä",
"\"id abc\"",
"\"id abc\"",
" abc ",
" /* co */ da ",
]:
self.assertEqual(txt, QgsExpression(txt).expression())
def testBlockComment(self):
expressions = {
"'test' /* comment */": 'test',
"/* comment */'test'": 'test',
"/* comment */'test*/'": 'test*/',
"/** comment */'test*/'": 'test*/',
"/* comment **/'test*/' /* comment */": 'test*/',
"'test/*'/* comment */": 'test/*',
"""/**
comment
**/
'test*/'""": 'test*/',
"""'test*/'
/**
comment
**/""": 'test*/'
}
for e, exp_res in list(expressions.items()):
exp = QgsExpression(e)
result = exp.evaluate()
self.assertEqual(exp_res, result)
def testComment(self):
expressions = {
"'test' -- comment\n": 'test',
"'test--'\n": 'test--',
"'--test'\n": '--test',
"'test' -- comment": 'test',
"'test--'": 'test--',
"'--test'": '--test',
}
for e, exp_res in list(expressions.items()):
exp = QgsExpression(e)
result = exp.evaluate()
self.assertEqual(exp_res, result)
def testValid(self):
e = QgsExpression()
self.assertFalse(e.isValid())
e.setExpression('asdf||#@¼')
self.assertFalse(e.isValid())
e.setExpression('1')
self.assertTrue(e.isValid())
def testCreateFieldEqualityExpression(self):
e = QgsExpression()
# test when value is null
field = "myfield"
value = QVariant()
res = '"myfield" IS NULL'
self.assertEqual(e.createFieldEqualityExpression(field, value), res)
# test when value is null and field name has a quote
field = "my'field"
value = QVariant()
res = '"my\'field" IS NULL'
self.assertEqual(e.createFieldEqualityExpression(field, value), res)
# test when field name has a quote and value is an int
field = "my'field"
value = 5
res = '"my\'field" = 5'
self.assertEqual(e.createFieldEqualityExpression(field, value), res)
# test when field name has a quote and value is a string
field = "my'field"
value = '5'
res = '"my\'field" = \'5\''
self.assertEqual(e.createFieldEqualityExpression(field, value), res)
# test when field name has a quote and value is a boolean
field = "my'field"
value = True
res = '"my\'field" = TRUE'
self.assertEqual(e.createFieldEqualityExpression(field, value), res)
if __name__ == "__main__":
unittest.main()