Merge pull request #5867 from alexbruy/processing-group

[processing] add groupId() method to get untranslated algorithm group
qgis · Dec 15, 2017 · db07bc6 · db07bc6
2 parents abdd875 + 2674022
commit db07bc6
Show file tree

Hide file tree

Showing 268 changed files with 841 additions and 6 deletions.
diff --git a/python/core/processing/models/qgsprocessingmodelalgorithm.sip b/python/core/processing/models/qgsprocessingmodelalgorithm.sip
@@ -22,7 +22,7 @@ class QgsProcessingModelAlgorithm : QgsProcessingAlgorithm
 %End
   public:
 
-    QgsProcessingModelAlgorithm( const QString &name = QString(), const QString &group = QString() );
+    QgsProcessingModelAlgorithm( const QString &name = QString(), const QString &group = QString(), const QString &groupId = QString() );
 %Docstring
  Constructor for QgsProcessingModelAlgorithm.
 %End
@@ -36,6 +36,8 @@ class QgsProcessingModelAlgorithm : QgsProcessingAlgorithm
 
     virtual QString group() const;
 
+    virtual QString groupId() const;
+
     virtual QIcon icon() const;
 
     virtual QString svgIconPath() const;

diff --git a/python/core/processing/qgsprocessingalgorithm.sip b/python/core/processing/qgsprocessingalgorithm.sip
@@ -158,10 +158,20 @@ class QgsProcessingAlgorithm
 %Docstring
  Returns the name of the group this algorithm belongs to. This string
  should be localised.
+.. seealso:: :py:func:`groupId()`
 .. seealso:: :py:func:`tags()`
  :rtype: str
 %End
 
+    virtual QString groupId() const;
+%Docstring
+ Returns the unique ID of the group this algorithm belongs to. This string
+ should be fixed for the algorithm, and must not be localised. The group id
+ should be unique within each provider. Group id should contain lowercase
+ alphanumeric characters only and no spaces or other formatting characters.
+.. seealso:: :py:func:`group()`
+ :rtype: str
+%End
     virtual Flags flags() const;
 %Docstring
  Returns the flags indicating how and when the algorithm operates and should be exposed to users.

diff --git a/python/plugins/processing/algs/gdal/AssignProjection.py b/python/plugins/processing/algs/gdal/AssignProjection.py
@@ -70,6 +70,9 @@ def icon(self):
     def group(self):
         return self.tr('Raster projections')
 
+    def group(self):
+        return 'rasterprojections'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         inLayer = self.parameterAsRasterLayer(parameters, self.INPUT, context)
         fileName = inLayer.source()

diff --git a/python/plugins/processing/algs/gdal/Buffer.py b/python/plugins/processing/algs/gdal/Buffer.py
@@ -95,6 +95,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
+    def groupId(self):
+        return 'vectorgeoprocessing'
+
     def commandName(self):
         return 'ogr2ogr'
 

diff --git a/python/plugins/processing/algs/gdal/ClipRasterByExtent.py b/python/plugins/processing/algs/gdal/ClipRasterByExtent.py
@@ -99,6 +99,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster extraction')
 
+    def groupId(self):
+        return 'rasterextraction'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'raster-clip.png'))
 

diff --git a/python/plugins/processing/algs/gdal/ClipRasterByMask.py b/python/plugins/processing/algs/gdal/ClipRasterByMask.py
@@ -116,6 +116,9 @@ def icon(self):
     def group(self):
         return self.tr('Raster extraction')
 
+    def groupId(self):
+        return 'rasterextraction'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         inLayer = self.parameterAsRasterLayer(parameters, self.INPUT, context)
 

diff --git a/python/plugins/processing/algs/gdal/ClipVectorByExtent.py b/python/plugins/processing/algs/gdal/ClipVectorByExtent.py
@@ -71,6 +71,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
+    def groupId(self):
+        return 'vectorgeoprocessing'
+
     def commandName(self):
         return 'ogr2ogr'
 

diff --git a/python/plugins/processing/algs/gdal/ClipVectorByMask.py b/python/plugins/processing/algs/gdal/ClipVectorByMask.py
@@ -70,6 +70,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
+    def groupId(self):
+        return 'vectorgeoprocessing'
+
     def commandName(self):
         return 'ogr2ogr'
 

diff --git a/python/plugins/processing/algs/gdal/ColorRelief.py b/python/plugins/processing/algs/gdal/ColorRelief.py
@@ -92,6 +92,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         arguments = ['color-relief']
         inLayer = self.parameterAsRasterLayer(parameters, self.INPUT, context)

diff --git a/python/plugins/processing/algs/gdal/Dissolve.py b/python/plugins/processing/algs/gdal/Dissolve.py
@@ -106,6 +106,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
+    def groupId(self):
+        return 'vectorgeoprocessing'
+
     def commandName(self):
         return 'ogr2ogr'
 

diff --git a/python/plugins/processing/algs/gdal/ExecuteSql.py b/python/plugins/processing/algs/gdal/ExecuteSql.py
@@ -82,6 +82,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector miscellaneous')
 
+    def groupId(self):
+        return 'vectormiscellaneous'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         ogrLayer, layerName = self.getOgrCompatibleSource(self.INPUT, parameters, context, feedback, executing)
         sql = self.parameterAsString(parameters, self.SQL, context)

diff --git a/python/plugins/processing/algs/gdal/GridAverage.py b/python/plugins/processing/algs/gdal/GridAverage.py
@@ -132,6 +132,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))
 

diff --git a/python/plugins/processing/algs/gdal/GridDataMetrics.py b/python/plugins/processing/algs/gdal/GridDataMetrics.py
@@ -149,6 +149,9 @@ def icon(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         ogrLayer, layerName = self.getOgrCompatibleSource(self.INPUT, parameters, context, feedback, executing)
 

diff --git a/python/plugins/processing/algs/gdal/GridInverseDistance.py b/python/plugins/processing/algs/gdal/GridInverseDistance.py
@@ -152,6 +152,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))
 

diff --git a/python/plugins/processing/algs/gdal/GridInverseDistanceNearestNeighbor.py b/python/plugins/processing/algs/gdal/GridInverseDistanceNearestNeighbor.py
@@ -139,6 +139,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))
 

diff --git a/python/plugins/processing/algs/gdal/GridLinear.py b/python/plugins/processing/algs/gdal/GridLinear.py
@@ -114,6 +114,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))
 

diff --git a/python/plugins/processing/algs/gdal/GridNearestNeighbor.py b/python/plugins/processing/algs/gdal/GridNearestNeighbor.py
@@ -127,6 +127,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))
 

diff --git a/python/plugins/processing/algs/gdal/OffsetCurve.py b/python/plugins/processing/algs/gdal/OffsetCurve.py
@@ -78,6 +78,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
+    def groupId(self):
+        return 'vectorgeoprocessing'
+
     def commandName(self):
         return 'ogr2ogr'
 

diff --git a/python/plugins/processing/algs/gdal/OgrToPostGis.py b/python/plugins/processing/algs/gdal/OgrToPostGis.py
@@ -162,6 +162,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector miscellaneous')
 
+    def groupId(self):
+        return 'vectormiscellaneous'
+
     def getConnectionString(self, parameters, context):
         host = self.parameterAsString(parameters, self.HOST, context)
         port = self.parameterAsString(parameters, self.PORT, context)

diff --git a/python/plugins/processing/algs/gdal/OneSideBuffer.py b/python/plugins/processing/algs/gdal/OneSideBuffer.py
@@ -104,6 +104,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
+    def groupId(self):
+        return 'vectorgeoprocessing'
+
     def commandName(self):
         return 'ogr2ogr'
 

diff --git a/python/plugins/processing/algs/gdal/PointsAlongLines.py b/python/plugins/processing/algs/gdal/PointsAlongLines.py
@@ -83,6 +83,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector geoprocessing')
 
+    def groupId(self):
+        return 'vectorgeoprocessing'
+
     def commandName(self):
         return 'ogr2ogr'
 

diff --git a/python/plugins/processing/algs/gdal/aspect.py b/python/plugins/processing/algs/gdal/aspect.py
@@ -93,6 +93,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         arguments = ['aspect']
         inLayer = self.parameterAsRasterLayer(parameters, self.INPUT, context)

diff --git a/python/plugins/processing/algs/gdal/buildvrt.py b/python/plugins/processing/algs/gdal/buildvrt.py
@@ -100,6 +100,9 @@ def icon(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
+    def groupId(self):
+        return 'rastermiscellaneous'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         arguments = []
         arguments.append('-resolution')

diff --git a/python/plugins/processing/algs/gdal/contour.py b/python/plugins/processing/algs/gdal/contour.py
@@ -118,6 +118,9 @@ def icon(self):
     def group(self):
         return self.tr('Raster extraction')
 
+    def groupId(self):
+        return 'rasterextraction'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         inLayer = self.parameterAsRasterLayer(parameters, self.INPUT, context)
         fieldName = self.parameterAsString(parameters, self.FIELD_NAME, context)

diff --git a/python/plugins/processing/algs/gdal/extractprojection.py b/python/plugins/processing/algs/gdal/extractprojection.py
@@ -63,6 +63,9 @@ def icon(self):
     def group(self):
         return self.tr('Raster projections')
 
+    def groupId(self):
+        return 'rasterprojections'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         return ["extractprojection"]
 

diff --git a/python/plugins/processing/algs/gdal/fillnodata.py b/python/plugins/processing/algs/gdal/fillnodata.py
@@ -86,6 +86,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         arguments = []
         arguments.append('-md')

diff --git a/python/plugins/processing/algs/gdal/gdal2tiles.py b/python/plugins/processing/algs/gdal/gdal2tiles.py
@@ -153,6 +153,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
+    def groupId(self):
+        return 'rastermiscellaneous'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         arguments = []
 

diff --git a/python/plugins/processing/algs/gdal/gdal2xyz.py b/python/plugins/processing/algs/gdal/gdal2xyz.py
@@ -69,6 +69,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster conversion')
 
+    def groupId(self):
+        return 'rasterconversion'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         arguments = []
         arguments = []

diff --git a/python/plugins/processing/algs/gdal/gdaladdo.py b/python/plugins/processing/algs/gdal/gdaladdo.py
@@ -99,6 +99,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
+    def groupId(self):
+        return 'rastermiscellaneous'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'raster-overview.png'))
 

diff --git a/python/plugins/processing/algs/gdal/gdalcalc.py b/python/plugins/processing/algs/gdal/gdalcalc.py
@@ -102,6 +102,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
+    def groupId(self):
+        return 'rastermiscellaneous'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         out = self.getOutputValue(self.OUTPUT)
         extra = self.getParameterValue(self.EXTRA)

diff --git a/python/plugins/processing/algs/gdal/gdalinfo.py b/python/plugins/processing/algs/gdal/gdalinfo.py
@@ -80,6 +80,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
+    def groupId(self):
+        return 'rastermiscellaneous'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'raster-info.png'))
 

diff --git a/python/plugins/processing/algs/gdal/gdaltindex.py b/python/plugins/processing/algs/gdal/gdaltindex.py
@@ -111,6 +111,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
+    def groupId(self):
+        return 'rastermiscellaneous'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'tiles.png'))
 

diff --git a/python/plugins/processing/algs/gdal/hillshade.py b/python/plugins/processing/algs/gdal/hillshade.py
@@ -120,6 +120,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         arguments = ['hillshade']
         inLayer = self.parameterAsRasterLayer(parameters, self.INPUT, context)

diff --git a/python/plugins/processing/algs/gdal/merge.py b/python/plugins/processing/algs/gdal/merge.py
@@ -98,6 +98,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster miscellaneous')
 
+    def groupId(self):
+        return 'rastermiscellaneous'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'merge.png'))
 

diff --git a/python/plugins/processing/algs/gdal/nearblack.py b/python/plugins/processing/algs/gdal/nearblack.py
@@ -86,6 +86,9 @@ def displayName(self):
     def group(self):
         return self.tr('Raster analysis')
 
+    def groupId(self):
+        return 'rasteranalysis'
+
     def icon(self):
         return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'nearblack.png'))
 

diff --git a/python/plugins/processing/algs/gdal/ogr2ogr.py b/python/plugins/processing/algs/gdal/ogr2ogr.py
@@ -68,6 +68,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector conversion')
 
+    def groupId(self):
+        return 'vectorconversion'
+
     def commandName(self):
         return 'ogr2ogr'
 

diff --git a/python/plugins/processing/algs/gdal/ogr2ogrtabletopostgislist.py b/python/plugins/processing/algs/gdal/ogr2ogrtabletopostgislist.py
@@ -119,6 +119,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector miscellaneous')
 
+    def groupId(self):
+        return 'vectormiscellaneous'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         connection = self.DB_CONNECTIONS[self.getParameterValue(self.DATABASE)]
         uri = uri_from_name(connection)

diff --git a/python/plugins/processing/algs/gdal/ogr2ogrtopostgislist.py b/python/plugins/processing/algs/gdal/ogr2ogrtopostgislist.py
@@ -176,6 +176,9 @@ def displayName(self):
     def group(self):
         return self.tr('Vector miscellaneous')
 
+    def groupId(self):
+        return 'vectormiscellaneous'
+
     def getConsoleCommands(self, parameters, context, feedback, executing=True):
         connection = self.parameterAsString(parameters, self.DATABASE, context)
         uri = uri_from_name(connection)