Port Fix Geometry algorithm to new API

nyalldawson · nyalldawson · commit b88ad8e1ce2c · 2017-06-26T12:44:26.000+10:00
diff --git a/python/plugins/processing/algs/qgis/FixGeometry.py b/python/plugins/processing/algs/qgis/FixGeometry.py
@@ -27,16 +27,15 @@
 
 from qgis.core import (QgsWkbTypes,
                        QgsFeatureSink,
+                       QgsFeatureRequest,
+                       QgsProcessingFeatureSource,
                        QgsGeometry,
-                       QgsApplication,
-                       QgsMessageLog,
-                       QgsProcessingUtils)
+                       QgsProcessingParameterDefinition,
+                       QgsProcessingParameterFeatureSource,
+                       QgsProcessingParameterFeatureSink,
+                       QgsProcessingOutputVectorLayer)
 
 from processing.algs.qgis.QgisAlgorithm import QgisAlgorithm
-from processing.core.parameters import ParameterVector
-from processing.core.outputs import OutputVector
-from processing.core.GeoAlgorithmExecutionException import GeoAlgorithmExecutionException
-from processing.tools import dataobjects
 
 
 class FixGeometry(QgisAlgorithm):
@@ -52,11 +51,9 @@ def group(self):
 
     def __init__(self):
         super().__init__()
-        self.addParameter(ParameterVector(self.INPUT,
-                                          self.tr('Input Layer'),
-                                          [dataobjects.TYPE_VECTOR_POLYGON, dataobjects.TYPE_VECTOR_LINE]))
-        self.addOutput(OutputVector(self.OUTPUT,
-                                    self.tr('Layer with fixed geometries')))
+        self.addParameter(QgsProcessingParameterFeatureSource(self.INPUT, self.tr('Input layer'), [QgsProcessingParameterDefinition.TypeVectorLine, QgsProcessingParameterDefinition.TypeVectorPolygon]))
+        self.addParameter(QgsProcessingParameterFeatureSink(self.OUTPUT, self.tr('Fixed geometries')))
+        self.addOutput(QgsProcessingOutputVectorLayer(self.OUTPUT, self.tr("Fixed geometries")))
 
     def name(self):
         return 'fixgeometries'
@@ -65,22 +62,22 @@ def displayName(self):
         return self.tr('Fix geometries')
 
     def processAlgorithm(self, parameters, context, feedback):
-        layer = QgsProcessingUtils.mapLayerFromString(self.getParameterValue(self.INPUT), context)
+        source = self.parameterAsSource(parameters, self.INPUT, context)
 
-        writer = self.getOutputFromName(
-            self.OUTPUT).getVectorWriter(layer.fields(), QgsWkbTypes.multiType(layer.wkbType()), layer.crs(), context)
+        (sink, dest_id) = self.parameterAsSink(parameters, self.OUTPUT, context,
+                                               source.fields(), QgsWkbTypes.multiType(source.wkbType()), source.sourceCrs())
 
-        features = QgsProcessingUtils.getFeatures(layer, context)
-        if QgsProcessingUtils.featureCount(layer, context) == 0:
-            raise GeoAlgorithmExecutionException(self.tr('There are no features in the input layer'))
-
-        total = 100.0 / layer.featureCount() if layer.featureCount() else 0
+        features = source.getFeatures(QgsFeatureRequest(), QgsProcessingFeatureSource.FlagSkipGeometryValidityChecks)
+        total = 100.0 / source.featureCount() if source.featureCount() else 0
         for current, inputFeature in enumerate(features):
+            if feedback.isCanceled():
+                break
+
             outputFeature = inputFeature
             if inputFeature.geometry():
                 outputGeometry = inputFeature.geometry().makeValid()
                 if not outputGeometry:
-                    QgsMessageLog.logMessage('makeValid failed for feature {}'.format(inputFeature.id()), self.tr('Processing'), QgsMessageLog.WARNING)
+                    feedback.pushInfo('makeValid failed for feature {}'.format(inputFeature.id()))
 
                 if outputGeometry.wkbType() == QgsWkbTypes.Unknown or QgsWkbTypes.flatType(outputGeometry.geometry().wkbType()) == QgsWkbTypes.GeometryCollection:
                     tmpGeometries = outputGeometry.asGeometryCollection()
@@ -89,7 +86,7 @@ def processAlgorithm(self, parameters, context, feedback):
                             try:
                                 g.convertToMultiType()
                                 outputFeature.setGeometry(QgsGeometry(g))
-                                writer.addFeature(outputFeature, QgsFeatureSink.FastInsert)
+                                sink.addFeature(outputFeature, QgsFeatureSink.FastInsert)
                             except:
                                 pass
                     feedback.setProgress(int(current * total))
@@ -98,7 +95,7 @@ def processAlgorithm(self, parameters, context, feedback):
                 outputGeometry.convertToMultiType()
                 outputFeature.setGeometry(outputGeometry)
 
-            writer.addFeature(outputFeature, QgsFeatureSink.FastInsert)
+            sink.addFeature(outputFeature, QgsFeatureSink.FastInsert)
             feedback.setProgress(int(current * total))
 
-        del writer
+        return {self.OUTPUT: dest_id}
diff --git a/python/plugins/processing/algs/qgis/QGISAlgorithmProvider.py b/python/plugins/processing/algs/qgis/QGISAlgorithmProvider.py
@@ -54,6 +54,7 @@
 from .DensifyGeometriesInterval import DensifyGeometriesInterval
 from .DropGeometry import DropGeometry
 from .ExtentFromLayer import ExtentFromLayer
+from .FixGeometry import FixGeometry
 from .GridPolygon import GridPolygon
 from .ImportIntoPostGIS import ImportIntoPostGIS
 from .Merge import Merge
@@ -168,7 +169,6 @@
 # from .ServiceAreaFromLayer import ServiceAreaFromLayer
 # from .TruncateTable import TruncateTable
 # from .Polygonize import Polygonize
-# from .FixGeometry import FixGeometry
 # from .ExecuteSQL import ExecuteSQL
 # from .FindProjection import FindProjection
 # from .TopoColors import TopoColor
@@ -240,7 +240,7 @@ def getAlgs(self):
         #         ShortestPathPointToPoint(), ShortestPathPointToLayer(),
         #         ShortestPathLayerToPoint(), ServiceAreaFromPoint(),
         #         ServiceAreaFromLayer(), TruncateTable(), Polygonize(),
-        #         FixGeometry(), ExecuteSQL(), FindProjection(),
+        #          ExecuteSQL(), FindProjection(),
         #         TopoColor(), EliminateSelection()
         #         ]
         algs = [AddTableField(),
@@ -257,6 +257,7 @@ def getAlgs(self):
                 DensifyGeometriesInterval(),
                 DropGeometry(),
                 ExtentFromLayer(),
+                FixGeometry(),
                 GridPolygon(),
                 ImportIntoPostGIS(),
                 Merge(),
diff --git a/python/plugins/processing/tests/testdata/qgis_algorithm_tests.yaml b/python/plugins/processing/tests/testdata/qgis_algorithm_tests.yaml
@@ -2275,18 +2275,18 @@ tests:
 #      OUTPUT_LAYER:
 #        name: expected/zonal_statistics.gml
 #        type: vector
-#
-#  - algorithm: qgis:fixgeometries
-#    name: Fix geometries
-#    params:
-#      INPUT:
-#        name: invalidgeometries.gml
-#        type: vector
-#    results:
-#      OUTPUT:
-#        name: expected/valid.gml
-#        type: vector
-#
+
+  - algorithm: qgis:fixgeometries
+    name: Fix geometries
+    params:
+      INPUT:
+        name: invalidgeometries.gml
+        type: vector
+    results:
+      OUTPUT:
+        name: expected/valid.gml
+        type: vector
+
 #  - algorithm: qgis:polygonize
 #    name: Polygonize
 #    params:
