Skip to content

Commit f24cda4

Browse files
committedNov 13, 2016
[processing] Add unit tests for retrieving param from script code
And fix number param retrieving from script code
1 parent 3ef7b3b commit f24cda4

File tree

2 files changed

+134
-3
lines changed

2 files changed

+134
-3
lines changed
 

‎python/plugins/processing/core/parameters.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -863,14 +863,20 @@ def getAsScriptCode(self):
863863
if self.optional:
864864
param_type += 'optional '
865865
param_type += 'number'
866-
return '##' + self.name + '=' + param_type + str(self.default)
866+
code = '##' + self.name + '=' + param_type
867+
if self.default:
868+
code += str(self.default)
869+
return code
867870

868871
@classmethod
869872
def fromScriptCode(self, line):
873+
870874
isOptional, name, definition = _splitParameterOptions(line)
871875
descName = _createDescriptiveName(name)
872876
if definition.lower().strip().startswith('number'):
873-
default = definition.strip()[len('number') + 1:] or None
877+
default = definition.strip()[len('number'):] or None
878+
if default == 'None':
879+
default = None
874880
return ParameterNumber(name, descName, default=default, optional=isOptional)
875881

876882
def _evaluate(self, value):

‎python/plugins/processing/tests/ParametersTest.py

Lines changed: 126 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@
4141
ParameterVector,
4242
ParameterTableField,
4343
ParameterSelection,
44-
ParameterExpression)
44+
ParameterExpression,
45+
getParameterFromString)
4546
from processing.tools import dataobjects
4647
from processing.tests.TestData import points2
4748

@@ -96,6 +97,19 @@ def testOptional(self):
9697
self.assertFalse(requiredParameter.setValue(None))
9798
self.assertEqual(requiredParameter.value, True)
9899

100+
def testScriptCode(self):
101+
parameter = ParameterBoolean('myName', 'myDescription')
102+
code = parameter.getAsScriptCode()
103+
result = getParameterFromString(code)
104+
self.assertTrue(isinstance(result, ParameterBoolean))
105+
self.assertFalse(result.optional)
106+
107+
parameter.optional = True
108+
code = parameter.getAsScriptCode()
109+
result = getParameterFromString(code)
110+
self.assertTrue(isinstance(result, ParameterBoolean))
111+
self.assertTrue(result.optional)
112+
99113

100114
class ParameterCRSTest(unittest.TestCase):
101115

@@ -119,6 +133,18 @@ def testOptional(self):
119133
self.assertFalse(requiredParameter.setValue(None))
120134
self.assertEqual(requiredParameter.value, 'EPSG:12003')
121135

136+
def testScriptCode(self):
137+
parameter = ParameterCrs('myName', 'myDescription')
138+
code = parameter.getAsScriptCode()
139+
result = getParameterFromString(code)
140+
self.assertTrue(isinstance(result, ParameterCrs))
141+
142+
parameter.optional = True
143+
code = parameter.getAsScriptCode()
144+
result = getParameterFromString(code)
145+
self.assertTrue(isinstance(result, ParameterCrs))
146+
self.assertTrue(result.optional)
147+
122148

123149
class ParameterDataObjectTest(unittest.TestCase):
124150

@@ -161,6 +187,18 @@ def testOptional(self):
161187
self.assertFalse(requiredParameter.setValue(None))
162188
self.assertEqual(requiredParameter.value, '1,2,3,4')
163189

190+
def testScriptCode(self):
191+
parameter = ParameterExtent('myName', 'myDescription')
192+
code = parameter.getAsScriptCode()
193+
result = getParameterFromString(code)
194+
self.assertTrue(isinstance(result, ParameterExtent))
195+
196+
parameter.optional = True
197+
code = parameter.getAsScriptCode()
198+
result = getParameterFromString(code)
199+
self.assertTrue(isinstance(result, ParameterExtent))
200+
self.assertTrue(result.optional)
201+
164202

165203
class ParameterPointTest(unittest.TestCase):
166204

@@ -191,6 +229,18 @@ def testOptional(self):
191229
self.assertFalse(requiredParameter.setValue(None))
192230
self.assertEqual(requiredParameter.value, '1,2')
193231

232+
def testScriptCode(self):
233+
parameter = ParameterPoint('myName', 'myDescription')
234+
code = parameter.getAsScriptCode()
235+
result = getParameterFromString(code)
236+
self.assertTrue(isinstance(result, ParameterPoint))
237+
238+
parameter.optional = True
239+
code = parameter.getAsScriptCode()
240+
result = getParameterFromString(code)
241+
self.assertTrue(isinstance(result, ParameterPoint))
242+
self.assertTrue(result.optional)
243+
194244

195245
class ParameterSelectionTest(unittest.TestCase):
196246

@@ -283,6 +333,18 @@ def testGetValueAsCommandLineParameter(self):
283333
parameter.setValue('myFile.png')
284334
self.assertEqual(parameter.getValueAsCommandLineParameter(), '"myFile.png"')
285335

336+
def testScriptCode(self):
337+
parameter = ParameterFile('myName', 'myDescription')
338+
code = parameter.getAsScriptCode()
339+
result = getParameterFromString(code)
340+
self.assertTrue(isinstance(result, ParameterFile))
341+
342+
parameter.optional = True
343+
code = parameter.getAsScriptCode()
344+
result = getParameterFromString(code)
345+
self.assertTrue(isinstance(result, ParameterFile))
346+
self.assertTrue(result.optional)
347+
286348

287349
class TestParameterFixedTable(unittest.TestCase):
288350

@@ -393,6 +455,18 @@ def testGetAsStringWhenVector(self):
393455

394456
# TODO With Layer Name, instead of Layer object
395457

458+
def testScriptCode(self):
459+
parameter = ParameterMultipleInput('myName', 'myDescription')
460+
code = parameter.getAsScriptCode()
461+
result = getParameterFromString(code)
462+
self.assertTrue(isinstance(result, ParameterMultipleInput))
463+
464+
parameter.optional = True
465+
code = parameter.getAsScriptCode()
466+
result = getParameterFromString(code)
467+
self.assertTrue(isinstance(result, ParameterMultipleInput))
468+
self.assertTrue(result.optional)
469+
396470

397471
class ParameterNumberTest(unittest.TestCase):
398472

@@ -447,6 +521,18 @@ def testOptional(self):
447521
self.assertFalse(requiredParameter.setValue(None))
448522
self.assertEqual(requiredParameter.value, 5)
449523

524+
def testScriptCode(self):
525+
parameter = ParameterNumber('myName', 'myDescription')
526+
code = parameter.getAsScriptCode()
527+
result = getParameterFromString(code)
528+
self.assertTrue(isinstance(result, ParameterNumber))
529+
530+
parameter.optional = True
531+
code = parameter.getAsScriptCode()
532+
result = getParameterFromString(code)
533+
self.assertTrue(isinstance(result, ParameterNumber))
534+
self.assertTrue(result.optional)
535+
450536

451537
class ParameterStringTest(unittest.TestCase):
452538

@@ -470,6 +556,18 @@ def testOptional(self):
470556
self.assertFalse(requiredParameter.setValue(None))
471557
self.assertEqual(requiredParameter.value, 'check')
472558

559+
def testScriptCode(self):
560+
parameter = ParameterString('myName', 'myDescription', default='test')
561+
code = parameter.getAsScriptCode()
562+
result = getParameterFromString(code)
563+
self.assertTrue(isinstance(result, ParameterString))
564+
565+
parameter.optional = True
566+
code = parameter.getAsScriptCode()
567+
result = getParameterFromString(code)
568+
self.assertTrue(isinstance(result, ParameterString))
569+
self.assertTrue(result.optional)
570+
473571

474572
class ParameterExpressionTest(unittest.TestCase):
475573

@@ -493,6 +591,18 @@ def testOptional(self):
493591
self.assertFalse(requiredParameter.setValue(None))
494592
self.assertEqual(requiredParameter.value, 'check')
495593

594+
def testScriptCode(self):
595+
parameter = ParameterExpression('myName', 'myDescription', default='test')
596+
code = parameter.getAsScriptCode()
597+
result = getParameterFromString(code)
598+
self.assertTrue(isinstance(result, ParameterExpression))
599+
600+
parameter.optional = True
601+
code = parameter.getAsScriptCode()
602+
result = getParameterFromString(code)
603+
self.assertTrue(isinstance(result, ParameterExpression))
604+
self.assertTrue(result.optional)
605+
496606

497607
class ParameterTableFieldTest(unittest.TestCase):
498608

@@ -505,6 +615,21 @@ def testOptional(self):
505615
parameter = ParameterTableField(
506616
'myName', 'myDesc', parent_name, optional=True)
507617

618+
def testScriptCode(self):
619+
parent_name = 'test_parent_layer'
620+
test_data = points2()
621+
test_layer = QgsVectorLayer(test_data, parent_name, 'ogr')
622+
parameter = ParameterTableField(
623+
'myName', 'myDesc', parent_name)
624+
code = parameter.getAsScriptCode()
625+
result = getParameterFromString(code)
626+
self.assertTrue(isinstance(result, ParameterTableField))
627+
628+
parameter.optional = True
629+
code = parameter.getAsScriptCode()
630+
result = getParameterFromString(code)
631+
self.assertTrue(isinstance(result, ParameterTableField))
632+
self.assertTrue(result.optional)
508633

509634
if __name__ == '__main__':
510635
unittest.main()

0 commit comments

Comments
 (0)
Please sign in to comment.