Refactor creation of batch dialog row algorithm parameters

nyalldawson · nyalldawson · commit 185172a946d3 · 2019-04-30T14:43:58.000+10:00
diff --git a/python/plugins/processing/gui/BatchAlgorithmDialog.py b/python/plugins/processing/gui/BatchAlgorithmDialog.py
@@ -79,42 +79,7 @@ def runAlgorithm(self):
         project = QgsProject.instance() if load_layers else None
 
         for row in range(self.mainWidget().batchRowCount()):
-            col = 0
-            parameters = {}
-            for param in self.algorithm().parameterDefinitions():
-                if param.flags() & QgsProcessingParameterDefinition.FlagHidden or param.isDestination():
-                    continue
-                wrapper = self.mainWidget().wrappers[row][col]
-                parameters[param.name()] = wrapper.parameterValue()
-                if not param.checkValueIsAcceptable(wrapper.parameterValue()):
-                    self.messageBar().pushMessage("", self.tr('Wrong or missing parameter value: {0} (row {1})').format(
-                        param.description(), row + 1),
-                        level=Qgis.Warning, duration=5)
-                    return
-                col += 1
-            count_visible_outputs = 0
-            for out in self.algorithm().destinationParameterDefinitions():
-                if out.flags() & QgsProcessingParameterDefinition.FlagHidden:
-                    continue
-
-                count_visible_outputs += 1
-                widget = self.mainWidget().tblParameters.cellWidget(row + 1, col)
-                text = widget.getValue()
-                if out.checkValueIsAcceptable(text):
-                    if isinstance(out, (QgsProcessingParameterRasterDestination,
-                                        QgsProcessingParameterVectorDestination,
-                                        QgsProcessingParameterFeatureSink)):
-                        # load rasters and sinks on completion
-                        parameters[out.name()] = QgsProcessingOutputLayerDefinition(text, project)
-                    else:
-                        parameters[out.name()] = text
-                    col += 1
-                else:
-                    self.messageBar().pushMessage("", self.tr('Wrong or missing output value: {0} (row {1})').format(
-                        out.description(), row + 1),
-                        level=Qgis.Warning, duration=5)
-                    return
-
+            parameters = self.mainWidget().parametersForRow(row, destinationProject=project, warnOnInvalid=True)
             alg_parameters.append(parameters)
 
         task = QgsScopedProxyProgressTask(self.tr('Batch Processing - {0}').format(self.algorithm().displayName()))
diff --git a/python/plugins/processing/gui/BatchPanel.py b/python/plugins/processing/gui/BatchPanel.py
@@ -46,24 +46,32 @@
     QFileInfo,
     QCoreApplication
 )
-from qgis.core import (Qgis,
-                       QgsApplication,
-                       QgsSettings,
-                       QgsProperty,  # NOQA - must be here for saved file evaluation
-                       QgsProject,
-                       QgsProcessingFeatureSourceDefinition,  # NOQA - must be here for saved file evaluation
-                       QgsCoordinateReferenceSystem,  # NOQA - must be here for saved file evaluation
-                       QgsProcessingParameterDefinition,
-                       QgsProcessingModelAlgorithm,
-                       QgsProcessingParameterFile,
-                       QgsProcessingParameterMapLayer,
-                       QgsProcessingParameterRasterLayer,
-                       QgsProcessingParameterMeshLayer,
-                       QgsProcessingParameterVectorLayer,
-                       QgsProcessingParameterFeatureSource)
-from qgis.gui import (QgsProcessingParameterWidgetContext,
-                      QgsProcessingContextGenerator,
-                      QgsFindFilesByPatternDialog)
+from qgis.core import (
+    Qgis,
+    QgsApplication,
+    QgsSettings,
+    QgsProperty,  # NOQA - must be here for saved file evaluation
+    QgsProject,
+    QgsProcessingFeatureSourceDefinition,  # NOQA - must be here for saved file evaluation
+    QgsCoordinateReferenceSystem,  # NOQA - must be here for saved file evaluation
+    QgsProcessingParameterDefinition,
+    QgsProcessingModelAlgorithm,
+    QgsProcessingParameterFile,
+    QgsProcessingParameterMapLayer,
+    QgsProcessingParameterRasterLayer,
+    QgsProcessingParameterMeshLayer,
+    QgsProcessingParameterVectorLayer,
+    QgsProcessingParameterFeatureSource,
+    QgsProcessingParameterRasterDestination,
+    QgsProcessingParameterVectorDestination,
+    QgsProcessingParameterFeatureSink,
+    QgsProcessingOutputLayerDefinition
+)
+from qgis.gui import (
+    QgsProcessingParameterWidgetContext,
+    QgsProcessingContextGenerator,
+    QgsFindFilesByPatternDialog
+)
 from qgis.utils import iface
 
 from processing.gui.wrappers import WidgetWrapperFactory, WidgetWrapper
@@ -171,7 +179,6 @@ def addFilesByPattern(self):
 
 
 class BatchPanel(BASE, WIDGET):
-
     PARAMETERS = "PARAMETERS"
     OUTPUTS = "OUTPUTS"
 
@@ -457,3 +464,45 @@ def toggleAdvancedMode(self, checked):
         for column, param in enumerate(self.alg.parameterDefinitions()):
             if param.flags() & QgsProcessingParameterDefinition.FlagAdvanced:
                 self.tblParameters.setColumnHidden(column, not checked)
+
+    def parametersForRow(self, row, destinationProject=None, warnOnInvalid=True):
+        """
+        Returns the parameters dictionary corresponding to a row in the batch table
+        """
+        col = 0
+        parameters = {}
+        for param in self.alg.parameterDefinitions():
+            if param.flags() & QgsProcessingParameterDefinition.FlagHidden or param.isDestination():
+                continue
+            wrapper = self.wrappers[row][col]
+            parameters[param.name()] = wrapper.parameterValue()
+            if warnOnInvalid and not param.checkValueIsAcceptable(wrapper.parameterValue()):
+                self.parent.messageBar().pushMessage("",
+                                                     self.tr('Wrong or missing parameter value: {0} (row {1})').format(
+                                                         param.description(), row + 1),
+                                                     level=Qgis.Warning, duration=5)
+                return {}
+            col += 1
+        count_visible_outputs = 0
+        for out in self.alg.destinationParameterDefinitions():
+            if out.flags() & QgsProcessingParameterDefinition.FlagHidden:
+                continue
+
+            count_visible_outputs += 1
+            widget = self.tblParameters.cellWidget(row + 1, col)
+            text = widget.getValue()
+            if not warnOnInvalid or out.checkValueIsAcceptable(text):
+                if isinstance(out, (QgsProcessingParameterRasterDestination,
+                                    QgsProcessingParameterVectorDestination,
+                                    QgsProcessingParameterFeatureSink)):
+                    # load rasters and sinks on completion
+                    parameters[out.name()] = QgsProcessingOutputLayerDefinition(text, destinationProject)
+                else:
+                    parameters[out.name()] = text
+                col += 1
+            else:
+                self.parent.messageBar().pushMessage("", self.tr('Wrong or missing output value: {0} (row {1})').format(
+                    out.description(), row + 1),
+                    level=Qgis.Warning, duration=5)
+                return {}
+        return parameters
