Push parameters into processAlgorithm and related functions

Author: nyalldawson

python/plugins/processing/algs/exampleprovider/ExampleAlgorithm.py

@@ -80,8 +80,9 @@ def displayName(self):
     def group(self):
         return self.tr('Algorithms for vector layers')
 
-    def processAlgorithm(self, context, feedback):
+    def processAlgorithm(self, parameters, context, feedback):
         """Here is where the processing itself takes place.
+        :param parameters:
         :param context:
         """
 

python/plugins/processing/algs/gdal/AssignProjection.py

@@ -66,7 +66,7 @@ def icon(self):
     def group(self):
         return self.tr('Raster projections')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         fileName = self.getParameterValue(self.INPUT)
         crs = self.getParameterValue(self.CRS)
         output = self.getOutputValue(self.OUTPUT)  # NOQA

python/plugins/processing/algs/gdal/ClipByExtent.py

@@ -83,7 +83,7 @@ def icon(self):
     def group(self):
         return self.tr('Raster extraction')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         out = self.getOutputValue(self.OUTPUT)
         noData = self.getParameterValue(self.NO_DATA)
         opts = self.getParameterValue(self.OPTIONS)

python/plugins/processing/algs/gdal/ClipByMask.py

@@ -102,7 +102,7 @@ def icon(self):
     def group(self):
         return self.tr('Raster extraction')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         out = self.getOutputValue(self.OUTPUT)
         mask = self.getParameterValue(self.MASK)
         context = dataobjects.createContext()

python/plugins/processing/algs/gdal/ColorRelief.py

@@ -70,7 +70,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = ['color-relief']
         arguments.append(str(self.getParameterValue(self.INPUT)))
         arguments.append(str(self.getParameterValue(self.COLOR_TABLE)))

python/plugins/processing/algs/gdal/GdalAlgorithm.py

@@ -58,8 +58,11 @@ def svgIconPath(self):
     def createCustomParametersWidget(self, parent):
         return GdalAlgorithmDialog(self)
 
-    def processAlgorithm(self, context, feedback):
-        commands = self.getConsoleCommands()
+    def getConsoleCommands(self, parameters):
+        return None
+
+    def processAlgorithm(self, parameters, context, feedback):
+        commands = self.getConsoleCommands(parameters)
         layers = QgsProcessingUtils.compatibleVectorLayers(QgsProject.instance())
         supported = QgsVectorFileWriter.supportedFormatExtensions()
         for i, c in enumerate(commands):
@@ -96,7 +99,7 @@ def commandName(self):
             output.setValue("dummy")
         for param in self.parameters:
             param.setValue("1")
-        name = self.getConsoleCommands()[0]
+        name = self.getConsoleCommands(parameters)[0]
         if name.endswith(".py"):
             name = name[:-3]
         return name

python/plugins/processing/algs/gdal/GdalAlgorithmDialog.py

@@ -111,7 +111,7 @@ def parametersHaveChanged(self):
             for output in self.alg.destinationParameterDefinitions():
                 if parameters[output.name()] is None:
                     parameters[output.name()] = self.tr("[temporary file]")
-            commands = self.alg.getConsoleCommands()
+            commands = self.alg.getConsoleCommands(parameters)
             commands = [c for c in commands if c not in ['cmd.exe', '/C ']]
             self.text.setPlainText(" ".join(commands))
         except AlgorithmDialogBase.InvalidParameterValue as e:

python/plugins/processing/algs/gdal/GridAverage.py

@@ -90,7 +90,7 @@ def icon(self):
     def group(self):
         return self.tr('Raster analysis')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = ['-l']
         arguments.append(
             os.path.basename(os.path.splitext(

python/plugins/processing/algs/gdal/GridDataMetrics.py

@@ -97,7 +97,7 @@ def icon(self):
     def group(self):
         return self.tr('Raster analysis')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = ['-l']
         arguments.append(
             os.path.basename(os.path.splitext(

python/plugins/processing/algs/gdal/GridInvDist.py

@@ -100,7 +100,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = ['-l']
         arguments.append(
             os.path.basename(os.path.splitext(

python/plugins/processing/algs/gdal/GridNearest.py

@@ -88,7 +88,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = ['-l']
         arguments.append(
             os.path.basename(os.path.splitext(

python/plugins/processing/algs/gdal/aspect.py

@@ -74,7 +74,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = ['aspect']
         arguments.append(str(self.getParameterValue(self.INPUT)))
         output = str(self.getOutputValue(self.OUTPUT))

python/plugins/processing/algs/gdal/buildvrt.py

@@ -75,7 +75,7 @@ def icon(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = []
         arguments.append('-resolution')
         arguments.append(self.RESOLUTION_OPTIONS[self.getParameterValue(self.RESOLUTION)])

python/plugins/processing/algs/gdal/contour.py

@@ -79,7 +79,7 @@ def icon(self):
     def group(self):
         return self.tr('Raster extraction')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         output = self.getOutputValue(self.OUTPUT_VECTOR)
         interval = str(self.getParameterValue(self.INTERVAL))
         fieldName = str(self.getParameterValue(self.FIELD_NAME))

python/plugins/processing/algs/gdal/extractprojection.py

@@ -62,10 +62,10 @@ def icon(self):
     def group(self):
         return self.tr('Raster projections')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         return ["extractprojection"]
 
-    def processAlgorithm(self, context, feedback):
+    def processAlgorithm(self, parameters, context, feedback):
         rasterPath = self.getParameterValue(self.INPUT)
         createPrj = self.getParameterValue(self.PRJ_FILE)
 

python/plugins/processing/algs/gdal/fillnodata.py

@@ -78,7 +78,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         output = self.getOutputValue(self.OUTPUT)
 
         arguments = []

python/plugins/processing/algs/gdal/gdal2tiles.py

@@ -126,7 +126,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
 
         arguments = []
 

python/plugins/processing/algs/gdal/gdal2xyz.py

@@ -61,7 +61,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster conversion')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = []
         arguments.append('-band')
         arguments.append(str(self.getParameterValue(self.BAND)))

python/plugins/processing/algs/gdal/gdaladdo.py

@@ -89,7 +89,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         inFile = self.getParameterValue(self.INPUT)
         clearOverviews = self.getParameterValue(self.CLEAN)
         ovrFormat = self.getParameterValue(self.FORMAT)

python/plugins/processing/algs/gdal/gdalcalc.py

@@ -106,7 +106,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         out = self.getOutputValue(self.OUTPUT)
         extra = self.getParameterValue(self.EXTRA)
         if extra is not None:

python/plugins/processing/algs/gdal/gdaltindex.py

@@ -71,7 +71,7 @@ def icon(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         fieldName = str(self.getParameterValue(self.FIELD_NAME))
 
         arguments = []

python/plugins/processing/algs/gdal/hillshade.py

@@ -83,7 +83,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = ['hillshade']
         arguments.append(str(self.getParameterValue(self.INPUT)))
         arguments.append(str(self.getOutputValue(self.OUTPUT)))

python/plugins/processing/algs/gdal/information.py

@@ -69,7 +69,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = []
         if self.getParameterValue(information.NOGCP):
             arguments.append('-nogcp')
@@ -78,8 +78,8 @@ def getConsoleCommands(self):
         arguments.append(self.getParameterValue(information.INPUT))
         return ['gdalinfo', GdalUtils.escapeAndJoin(arguments)]
 
-    def processAlgorithm(self, context, feedback):
-        GdalUtils.runGdal(self.getConsoleCommands(), feedback)
+    def processAlgorithm(self, parameters, context, feedback):
+        GdalUtils.runGdal(self.getConsoleCommands(parameters), feedback)
         output = self.getOutputValue(information.OUTPUT)
         with open(output, 'w') as f:
             f.write('<pre>')

python/plugins/processing/algs/gdal/merge.py

@@ -87,7 +87,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = []
         arguments.append('-ot')
         arguments.append(self.TYPE[self.getParameterValue(self.RTYPE)])

python/plugins/processing/algs/gdal/nearblack.py

@@ -70,7 +70,7 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = []
         arguments.append('-o')
         output = str(self.getOutputValue(self.OUTPUT))

python/plugins/processing/algs/gdal/offsetcurve.py

@@ -72,7 +72,7 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         inLayer = self.getParameterValue(self.INPUT_LAYER)
         geometry = self.getParameterValue(self.GEOMETRY)
         distance = self.getParameterValue(self.RADIUS)

python/plugins/processing/algs/gdal/ogr2ogr.py

@@ -120,7 +120,7 @@ def displayName(self):
     def group(self):
         return self.tr('Vector conversion')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         inLayer = self.getParameterValue(self.INPUT_LAYER)
         ogrLayer = ogrConnectionString(inLayer)[1:-1]
 

python/plugins/processing/algs/gdal/ogr2ogrbuffer.py

@@ -83,7 +83,7 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         inLayer = self.getParameterValue(self.INPUT_LAYER)
         geometry = self.getParameterValue(self.GEOMETRY)
         distance = self.getParameterValue(self.DISTANCE)

python/plugins/processing/algs/gdal/ogr2ogrclip.py

@@ -65,7 +65,7 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         inLayer = self.getParameterValue(self.INPUT_LAYER)
         ogrLayer = ogrConnectionString(inLayer)[1:-1]
         clipLayer = self.getParameterValue(self.CLIP_LAYER)

python/plugins/processing/algs/gdal/ogr2ogrclipextent.py

@@ -65,7 +65,7 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         inLayer = self.getParameterValue(self.INPUT_LAYER)
         ogrLayer = ogrConnectionString(inLayer)[1:-1]
         clipExtent = self.getParameterValue(self.CLIP_EXTENT)

python/plugins/processing/algs/gdal/ogr2ogrdissolve.py

@@ -89,7 +89,7 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         inLayer = self.getParameterValue(self.INPUT_LAYER)
         geometry = self.getParameterValue(self.GEOMETRY)
         field = self.getParameterValue(self.FIELD)

python/plugins/processing/algs/gdal/ogr2ogrpointsonlines.py

@@ -71,7 +71,7 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         inLayer = self.getParameterValue(self.INPUT_LAYER)
         ogrLayer = ogrConnectionString(inLayer)[1:-1]
         layername = "'" + ogrLayerName(inLayer) + "'"

python/plugins/processing/algs/gdal/ogr2ogrtabletopostgislist.py

@@ -126,12 +126,12 @@ def displayName(self):
     def group(self):
         return self.tr('Vector miscellaneous')
 
-    def processAlgorithm(self, context, feedback):
+    def processAlgorithm(self, parameters, context, feedback):
         self.processing = True
-        GdalAlgorithm.processAlgorithm(self, context, feedback)
+        GdalAlgorithm.processAlgorithm(parameters, self, context)
         self.processing = False
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         connection = self.DB_CONNECTIONS[self.getParameterValue(self.DATABASE)]
         uri = uri_from_name(connection)
         if self.processing:

python/plugins/processing/algs/gdal/ogr2ogrtopostgis.py

@@ -162,7 +162,7 @@ def displayName(self):
     def group(self):
         return self.tr('Vector miscellaneous')
 
-    def getConnectionString(self):
+    def getConnectionString(self, parameters):
         host = self.getParameterValue(self.HOST)
         port = self.getParameterValue(self.PORT)
         user = self.getParameterValue(self.USER)
@@ -184,7 +184,7 @@ def getConnectionString(self):
             arguments.append('user=' + user)
         return GdalUtils.escapeAndJoin(arguments)
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         inLayer = self.getParameterValue(self.INPUT_LAYER)
         ogrLayer = ogrConnectionString(inLayer)[1:-1]
         shapeEncoding = self.getParameterValue(self.SHAPE_ENCODING)
@@ -229,7 +229,7 @@ def getConsoleCommands(self):
         arguments.append('-f')
         arguments.append('PostgreSQL')
         arguments.append('PG:"')
-        arguments.append(self.getConnectionString())
+        arguments.append(self.getConnectionString(parameters))
         arguments.append('"')
         arguments.append(dimstring)
         arguments.append(ogrLayer)

python/plugins/processing/algs/gdal/ogr2ogrtopostgislist.py

@@ -178,12 +178,12 @@ def displayName(self):
     def group(self):
         return self.tr('Vector miscellaneous')
 
-    def processAlgorithm(self, context, feedback):
+    def processAlgorithm(self, parameters, context, feedback):
         self.processing = True
-        GdalAlgorithm.processAlgorithm(None, self)
+        GdalAlgorithm.processAlgorithm(parameters, None, self)
         self.processing = False
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         connection = self.getParameterValue(self.DATABASE)
         uri = uri_from_name(connection)
         if self.processing:

python/plugins/processing/algs/gdal/ogrinfo.py

@@ -61,7 +61,7 @@ def displayName(self):
     def group(self):
         return self.tr('Vector miscellaneous')
 
-    def getConsoleCommands(self):
+    def getConsoleCommands(self, parameters):
         arguments = ["ogrinfo"]
         arguments.append('-al')
         if self.getParameterValue(self.SUMMARY_ONLY):
@@ -71,8 +71,8 @@ def getConsoleCommands(self):
         arguments.append(conn)
         return arguments
 
-    def processAlgorithm(self, context, feedback):
-        GdalUtils.runGdal(self.getConsoleCommands(), feedback)
+    def processAlgorithm(self, parameters, context, feedback):
+        GdalUtils.runGdal(self.getConsoleCommands(parameters), feedback)
         output = self.getOutputValue(self.OUTPUT)
         with open(output, 'w') as f:
             f.write('<pre>')