Skip to content

Commit a56725f

Browse files
nyalldawsonnyalldawson
committed
Resurrect Python Field Calculator algorithm, add test
1 parent 6144b1c commit a56725f

File tree

5 files changed

+187
-53
lines changed

5 files changed

+187
-53
lines changed

‎python/plugins/processing/algs/qgis/FieldPyculator.py

+50-50
Original file line numberDiff line numberDiff line change
@@ -29,30 +29,27 @@
2929
import sys
3030

3131
from qgis.PyQt.QtCore import QVariant
32-
from qgis.core import (QgsFeature,
32+
from qgis.core import (QgsProcessingException,
3333
QgsField,
3434
QgsFeatureSink,
35-
QgsApplication,
36-
QgsProcessingUtils)
35+
QgsProcessingParameterFeatureSource,
36+
QgsProcessingParameterString,
37+
QgsProcessingParameterEnum,
38+
QgsProcessingParameterNumber,
39+
QgsProcessingParameterFeatureSink)
3740
from processing.algs.qgis.QgisAlgorithm import QgisAlgorithm
38-
from processing.core.GeoAlgorithmExecutionException import GeoAlgorithmExecutionException
39-
from processing.core.parameters import ParameterVector
40-
from processing.core.parameters import ParameterString
41-
from processing.core.parameters import ParameterNumber
42-
from processing.core.parameters import ParameterSelection
43-
from processing.core.outputs import OutputVector
4441

4542

4643
class FieldsPyculator(QgisAlgorithm):
4744

48-
INPUT_LAYER = 'INPUT_LAYER'
45+
INPUT = 'INPUT'
4946
FIELD_NAME = 'FIELD_NAME'
5047
FIELD_TYPE = 'FIELD_TYPE'
5148
FIELD_LENGTH = 'FIELD_LENGTH'
5249
FIELD_PRECISION = 'FIELD_PRECISION'
5350
GLOBAL = 'GLOBAL'
5451
FORMULA = 'FORMULA'
55-
OUTPUT_LAYER = 'OUTPUT_LAYER'
52+
OUTPUT = 'OUTPUT'
5653
RESULT_VAR_NAME = 'value'
5754

5855
TYPES = [QVariant.Int, QVariant.Double, QVariant.String]
@@ -68,21 +65,21 @@ def initAlgorithm(self, config=None):
6865
self.tr('Float'),
6966
self.tr('String')]
7067

71-
self.addParameter(ParameterVector(self.INPUT_LAYER,
72-
self.tr('Input layer')))
73-
self.addParameter(ParameterString(self.FIELD_NAME,
74-
self.tr('Result field name'), 'NewField'))
75-
self.addParameter(ParameterSelection(self.FIELD_TYPE,
76-
self.tr('Field type'), self.type_names))
77-
self.addParameter(ParameterNumber(self.FIELD_LENGTH,
78-
self.tr('Field length'), 1, 255, 10))
79-
self.addParameter(ParameterNumber(self.FIELD_PRECISION,
80-
self.tr('Field precision'), 0, 10, 0))
81-
self.addParameter(ParameterString(self.GLOBAL,
82-
self.tr('Global expression'), multiline=True, optional=True))
83-
self.addParameter(ParameterString(self.FORMULA,
84-
self.tr('Formula'), 'value = ', multiline=True))
85-
self.addOutput(OutputVector(self.OUTPUT_LAYER, self.tr('Calculated')))
68+
self.addParameter(QgsProcessingParameterFeatureSource(self.INPUT, self.tr('Input layer')))
69+
self.addParameter(QgsProcessingParameterString(self.FIELD_NAME,
70+
self.tr('Result field name'), defaultValue='NewField'))
71+
self.addParameter(QgsProcessingParameterEnum(self.FIELD_TYPE,
72+
self.tr('Field type'), options=self.type_names))
73+
self.addParameter(QgsProcessingParameterNumber(self.FIELD_LENGTH,
74+
self.tr('Field length'), minValue=1, maxValue=255, defaultValue=10))
75+
self.addParameter(QgsProcessingParameterNumber(self.FIELD_PRECISION,
76+
self.tr('Field precision'), minValue=0, maxValue=15, defaultValue=3))
77+
self.addParameter(QgsProcessingParameterString(self.GLOBAL,
78+
self.tr('Global expression'), multiLine=True, optional=True))
79+
self.addParameter(QgsProcessingParameterString(self.FORMULA,
80+
self.tr('Formula'), defaultValue='value = ', multiLine=True))
81+
self.addParameter(QgsProcessingParameterFeatureSink(self.OUTPUT,
82+
self.tr('Calculated')))
8683

8784
def name(self):
8885
return 'advancedpythonfieldcalculator'
@@ -91,33 +88,33 @@ def displayName(self):
9188
return self.tr('Advanced Python field calculator')
9289

9390
def processAlgorithm(self, parameters, context, feedback):
94-
fieldName = self.getParameterValue(self.FIELD_NAME)
95-
fieldType = self.getParameterValue(self.FIELD_TYPE)
96-
fieldLength = self.getParameterValue(self.FIELD_LENGTH)
97-
fieldPrecision = self.getParameterValue(self.FIELD_PRECISION)
98-
code = self.getParameterValue(self.FORMULA)
99-
globalExpression = self.getParameterValue(self.GLOBAL)
100-
output = self.getOutputFromName(self.OUTPUT_LAYER)
101-
102-
layer = QgsProcessingUtils.mapLayerFromString(self.getParameterValue(self.INPUT_LAYER), context)
103-
fields = layer.fields()
104-
fields.append(QgsField(fieldName, self.TYPES[fieldType], '',
105-
fieldLength, fieldPrecision))
106-
writer = output.getVectorWriter(fields, layer.wkbType(), layer.crs(), context)
107-
outFeat = QgsFeature()
91+
source = self.parameterAsSource(parameters, self.INPUT, context)
92+
field_name = self.parameterAsString(parameters, self.FIELD_NAME, context)
93+
field_type = self.TYPES[self.parameterAsEnum(parameters, self.FIELD_TYPE, context)]
94+
width = self.parameterAsInt(parameters, self.FIELD_LENGTH, context)
95+
precision = self.parameterAsInt(parameters, self.FIELD_PRECISION, context)
96+
code = self.parameterAsString(parameters, self.FORMULA, context)
97+
globalExpression = self.parameterAsString(parameters, self.GLOBAL, context)
98+
99+
fields = source.fields()
100+
fields.append(QgsField(field_name, self.TYPES[field_type], '',
101+
width, precision))
108102
new_ns = {}
109103

104+
(sink, dest_id) = self.parameterAsSink(parameters, self.OUTPUT, context,
105+
fields, source.wkbType(), source.sourceCrs())
106+
110107
# Run global code
111108
if globalExpression.strip() != '':
112109
try:
113110
bytecode = compile(globalExpression, '<string>', 'exec')
114111
exec(bytecode, new_ns)
115112
except:
116-
raise GeoAlgorithmExecutionException(
113+
raise QgsProcessingException(
117114
self.tr("FieldPyculator code execute error.Global code block can't be executed!\n{0}\n{1}").format(str(sys.exc_info()[0].__name__), str(sys.exc_info()[1])))
118115

119116
# Replace all fields tags
120-
fields = layer.fields()
117+
fields = source.fields()
121118
num = 0
122119
for field in fields:
123120
field_name = str(field.name())
@@ -136,13 +133,17 @@ def processAlgorithm(self, parameters, context, feedback):
136133
try:
137134
bytecode = compile(code, '<string>', 'exec')
138135
except:
139-
raise GeoAlgorithmExecutionException(
136+
raise QgsProcessingException(
140137
self.tr("FieldPyculator code execute error. Field code block can't be executed!\n{0}\n{1}").format(str(sys.exc_info()[0].__name__), str(sys.exc_info()[1])))
141138

142139
# Run
143-
features = QgsProcessingUtils.getFeatures(layer, context)
144-
total = 100.0 / layer.featureCount() if layer.featureCount() else 0
140+
features = source.getFeatures()
141+
total = 100.0 / source.featureCount() if source.featureCount() else 0
142+
145143
for current, feat in enumerate(features):
144+
if feedback.isCanceled():
145+
break
146+
146147
feedback.setProgress(int(current * total))
147148
attrs = feat.attributes()
148149
feat_id = feat.id()
@@ -168,18 +169,17 @@ def processAlgorithm(self, parameters, context, feedback):
168169

169170
# Check result
170171
if self.RESULT_VAR_NAME not in new_ns:
171-
raise GeoAlgorithmExecutionException(
172+
raise QgsProcessingException(
172173
self.tr("FieldPyculator code execute error\n"
173174
"Field code block does not return '{0}' variable! "
174175
"Please declare this variable in your code!").format(self.RESULT_VAR_NAME))
175176

176177
# Write feature
177-
outFeat.setGeometry(feat.geometry())
178178
attrs.append(new_ns[self.RESULT_VAR_NAME])
179-
outFeat.setAttributes(attrs)
180-
writer.addFeature(outFeat, QgsFeatureSink.FastInsert)
179+
feat.setAttributes(attrs)
180+
sink.addFeature(feat, QgsFeatureSink.FastInsert)
181181

182-
del writer
182+
return {self.OUTPUT: dest_id}
183183

184184
def checkParameterValues(self, parameters, context):
185185
# TODO check that formula is correct and fields exist

‎python/plugins/processing/algs/qgis/QGISAlgorithmProvider.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@
7070
from .ExtentFromLayer import ExtentFromLayer
7171
from .ExtractNodes import ExtractNodes
7272
from .ExtractSpecificNodes import ExtractSpecificNodes
73+
from .FieldPyculator import FieldsPyculator
7374
from .FieldsCalculator import FieldsCalculator
7475
from .FieldsMapper import FieldsMapper
7576
from .FixedDistanceBuffer import FixedDistanceBuffer
@@ -167,7 +168,6 @@
167168
# from .SelectByLocation import SelectByLocation
168169
# from .SpatialJoin import SpatialJoin
169170
# from .GeometryConvert import GeometryConvert
170-
# from .FieldPyculator import FieldsPyculator
171171
# from .SelectByAttributeSum import SelectByAttributeSum
172172
# from .DefineProjection import DefineProjection
173173
# from .RasterCalculator import RasterCalculator
@@ -191,8 +191,7 @@ def getAlgs(self):
191191
# ExtractByLocation(),
192192
# SpatialJoin(),
193193
# GeometryConvert(),
194-
# FieldsPyculator(),
195-
# FieldsMapper(), SelectByAttributeSum()
194+
# SelectByAttributeSum()
196195
# DefineProjection(),
197196
# RasterCalculator(),
198197
# ExecuteSQL(), FindProjection(),
@@ -229,6 +228,7 @@ def getAlgs(self):
229228
ExtractSpecificNodes(),
230229
FieldsCalculator(),
231230
FieldsMapper(),
231+
FieldsPyculator(),
232232
FixedDistanceBuffer(),
233233
FixGeometry(),
234234
GeometryByExpression(),

‎python/plugins/processing/tests/testdata/expected/pycalculator_points.gfs

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<GMLFeatureClassList>
2+
<GMLFeatureClass>
3+
<Name>pycalculator_points</Name>
4+
<ElementPath>pycalculator_points</ElementPath>
5+
<!--POINT-->
6+
<GeometryType>1</GeometryType>
7+
<SRSName>EPSG:4326</SRSName>
8+
<DatasetSpecificInfo>
9+
<FeatureCount>9</FeatureCount>
10+
<ExtentXMin>0.00000</ExtentXMin>
11+
<ExtentXMax>8.00000</ExtentXMax>
12+
<ExtentYMin>-5.00000</ExtentYMin>
13+
<ExtentYMax>3.00000</ExtentYMax>
14+
</DatasetSpecificInfo>
15+
<PropertyDefn>
16+
<Name>id</Name>
17+
<ElementPath>id</ElementPath>
18+
<Type>Integer</Type>
19+
</PropertyDefn>
20+
<PropertyDefn>
21+
<Name>id2</Name>
22+
<ElementPath>id2</ElementPath>
23+
<Type>Integer</Type>
24+
</PropertyDefn>
25+
<PropertyDefn>
26+
<Name>new_field</Name>
27+
<ElementPath>new_field</ElementPath>
28+
<Type>Integer</Type>
29+
</PropertyDefn>
30+
</GMLFeatureClass>
31+
</GMLFeatureClassList>

‎python/plugins/processing/tests/testdata/expected/pycalculator_points.gml

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<?xml version="1.0" encoding="utf-8" ?>
2+
<ogr:FeatureCollection
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation=""
5+
xmlns:ogr="http://ogr.maptools.org/"
6+
xmlns:gml="http://www.opengis.net/gml">
7+
<gml:boundedBy>
8+
<gml:Box>
9+
<gml:coord><gml:X>0</gml:X><gml:Y>-5</gml:Y></gml:coord>
10+
<gml:coord><gml:X>8</gml:X><gml:Y>3</gml:Y></gml:coord>
11+
</gml:Box>
12+
</gml:boundedBy>
13+
14+
<gml:featureMember>
15+
<ogr:pycalculator_points fid="points.0">
16+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>1,1</gml:coordinates></gml:Point></ogr:geometryProperty>
17+
<ogr:id>1</ogr:id>
18+
<ogr:id2>2</ogr:id2>
19+
<ogr:new_field>4</ogr:new_field>
20+
</ogr:pycalculator_points>
21+
</gml:featureMember>
22+
<gml:featureMember>
23+
<ogr:pycalculator_points fid="points.1">
24+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>3,3</gml:coordinates></gml:Point></ogr:geometryProperty>
25+
<ogr:id>2</ogr:id>
26+
<ogr:id2>1</ogr:id2>
27+
<ogr:new_field>2</ogr:new_field>
28+
</ogr:pycalculator_points>
29+
</gml:featureMember>
30+
<gml:featureMember>
31+
<ogr:pycalculator_points fid="points.2">
32+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>2,2</gml:coordinates></gml:Point></ogr:geometryProperty>
33+
<ogr:id>3</ogr:id>
34+
<ogr:id2>0</ogr:id2>
35+
<ogr:new_field>0</ogr:new_field>
36+
</ogr:pycalculator_points>
37+
</gml:featureMember>
38+
<gml:featureMember>
39+
<ogr:pycalculator_points fid="points.3">
40+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>5,2</gml:coordinates></gml:Point></ogr:geometryProperty>
41+
<ogr:id>4</ogr:id>
42+
<ogr:id2>2</ogr:id2>
43+
<ogr:new_field>4</ogr:new_field>
44+
</ogr:pycalculator_points>
45+
</gml:featureMember>
46+
<gml:featureMember>
47+
<ogr:pycalculator_points fid="points.4">
48+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>4,1</gml:coordinates></gml:Point></ogr:geometryProperty>
49+
<ogr:id>5</ogr:id>
50+
<ogr:id2>1</ogr:id2>
51+
<ogr:new_field>2</ogr:new_field>
52+
</ogr:pycalculator_points>
53+
</gml:featureMember>
54+
<gml:featureMember>
55+
<ogr:pycalculator_points fid="points.5">
56+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>0,-5</gml:coordinates></gml:Point></ogr:geometryProperty>
57+
<ogr:id>6</ogr:id>
58+
<ogr:id2>0</ogr:id2>
59+
<ogr:new_field>0</ogr:new_field>
60+
</ogr:pycalculator_points>
61+
</gml:featureMember>
62+
<gml:featureMember>
63+
<ogr:pycalculator_points fid="points.6">
64+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>8,-1</gml:coordinates></gml:Point></ogr:geometryProperty>
65+
<ogr:id>7</ogr:id>
66+
<ogr:id2>0</ogr:id2>
67+
<ogr:new_field>0</ogr:new_field>
68+
</ogr:pycalculator_points>
69+
</gml:featureMember>
70+
<gml:featureMember>
71+
<ogr:pycalculator_points fid="points.7">
72+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>7,-1</gml:coordinates></gml:Point></ogr:geometryProperty>
73+
<ogr:id>8</ogr:id>
74+
<ogr:id2>0</ogr:id2>
75+
<ogr:new_field>0</ogr:new_field>
76+
</ogr:pycalculator_points>
77+
</gml:featureMember>
78+
<gml:featureMember>
79+
<ogr:pycalculator_points fid="points.8">
80+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>0,-1</gml:coordinates></gml:Point></ogr:geometryProperty>
81+
<ogr:id>9</ogr:id>
82+
<ogr:id2>0</ogr:id2>
83+
<ogr:new_field>0</ogr:new_field>
84+
</ogr:pycalculator_points>
85+
</gml:featureMember>
86+
</ogr:FeatureCollection>

‎python/plugins/processing/tests/testdata/qgis_algorithm_tests.yaml

+17
Original file line numberDiff line numberDiff line change
@@ -3193,3 +3193,20 @@ tests:
31933193
OUTPUT:
31943194
name: expected/field_calculator_points.gml
31953195
type: vector
3196+
3197+
- algorithm: qgis:advancedpythonfieldcalculator
3198+
name: Test advanced python calculator
3199+
params:
3200+
FIELD_LENGTH: 10
3201+
FIELD_NAME: new_field
3202+
FIELD_PRECISION: 3
3203+
FIELD_TYPE: 0
3204+
FORMULA: value = __attr[2]*2
3205+
GLOBAL: ''
3206+
INPUT:
3207+
name: points.gml
3208+
type: vector
3209+
results:
3210+
OUTPUT:
3211+
name: expected/pycalculator_points.gml
3212+
type: vector

0 commit comments

Comments
 (0)