Merge pull request #4119 from arnaud-morvan/processing_postgis_wrappers

[processing] Add PostGIS widget wrappers
qgis · Feb 16, 2017 · cdb35d6 · cdb35d6
2 parents 7d2d6e8 + 337d188
commit cdb35d6
Show file tree

Hide file tree

Showing 8 changed files with 346 additions and 134 deletions.
diff --git a/python/plugins/processing/algs/gdal/ogr2ogrtopostgislist.py b/python/plugins/processing/algs/gdal/ogr2ogrtopostgislist.py
@@ -27,8 +27,6 @@
 __revision__ = '$Format:%H$'
 
 
-from qgis.PyQt.QtCore import QSettings
-
 from processing.core.parameters import ParameterVector
 from processing.core.parameters import ParameterString
 from processing.core.parameters import ParameterCrs
@@ -87,17 +85,15 @@ def __init__(self):
         GdalAlgorithm.__init__(self)
         self.processing = False
 
-    def dbConnectionNames(self):
-        settings = QSettings()
-        settings.beginGroup('/PostgreSQL/connections/')
-        return settings.childGroups()
-
     def defineCharacteristics(self):
         self.name, self.i18n_name = self.trAlgorithm('Import Vector into PostGIS database (available connections)')
         self.group, self.i18n_group = self.trAlgorithm('[OGR] Miscellaneous')
-        self.DB_CONNECTIONS = self.dbConnectionNames()
-        self.addParameter(ParameterSelection(self.DATABASE,
-                                             self.tr('Database (connection name)'), self.DB_CONNECTIONS))
+        self.addParameter(ParameterString(
+            self.DATABASE,
+            self.tr('Database (connection name)'),
+            metadata={
+                'widget_wrapper': {
+                    'class': 'processing.gui.wrappers_postgis.ConnectionWidgetWrapper'}}))
         self.addParameter(ParameterVector(self.INPUT_LAYER,
                                           self.tr('Input layer')))
         self.addParameter(ParameterString(self.SHAPE_ENCODING,
@@ -110,11 +106,24 @@ def defineCharacteristics(self):
                                        self.tr('Reproject to this CRS on output '), '', optional=True))
         self.addParameter(ParameterCrs(self.S_SRS,
                                        self.tr('Override source CRS'), '', optional=True))
-        self.addParameter(ParameterString(self.SCHEMA,
-                                          self.tr('Schema name'), 'public', optional=True))
-        self.addParameter(ParameterString(self.TABLE,
-                                          self.tr('Table name, leave blank to use input name'),
-                                          '', optional=True))
+        self.addParameter(ParameterString(
+            self.SCHEMA,
+            self.tr('Schema name'),
+            'public',
+            optional=True,
+            metadata={
+                'widget_wrapper': {
+                    'class': 'processing.gui.wrappers_postgis.SchemaWidgetWrapper',
+                    'connection_param': self.DATABASE}}))
+        self.addParameter(ParameterString(
+            self.TABLE,
+            self.tr('Table name, leave blank to use input name'),
+            '',
+            optional=True,
+            metadata={
+                'widget_wrapper': {
+                    'class': 'processing.gui.wrappers_postgis.TableWidgetWrapper',
+                    'schema_param': self.SCHEMA}}))
         self.addParameter(ParameterString(self.PK,
                                           self.tr('Primary key (new field)'), 'id', optional=True))
         self.addParameter(ParameterTableField(self.PRIMARY_KEY,
@@ -168,7 +177,7 @@ def processAlgorithm(self, feedback):
         self.processing = False
 
     def getConsoleCommands(self):
-        connection = self.DB_CONNECTIONS[self.getParameterValue(self.DATABASE)]
+        connection = self.getParameterValue(self.DATABASE)
         uri = uri_from_name(connection)
         if self.processing:
             # to get credentials input when needed

diff --git a/python/plugins/processing/algs/qgis/ImportIntoPostGIS.py b/python/plugins/processing/algs/qgis/ImportIntoPostGIS.py
@@ -33,7 +33,6 @@
 from processing.core.parameters import ParameterBoolean
 from processing.core.parameters import ParameterVector
 from processing.core.parameters import ParameterString
-from processing.core.parameters import ParameterSelection
 from processing.core.parameters import ParameterTableField
 from processing.tools import dataobjects, postgis
 
@@ -58,14 +57,30 @@ def defineCharacteristics(self):
         self.group, self.i18n_group = self.trAlgorithm('Database')
         self.addParameter(ParameterVector(self.INPUT,
                                           self.tr('Layer to import')))
-
-        self.DB_CONNECTIONS = self.dbConnectionNames()
-        self.addParameter(ParameterSelection(self.DATABASE,
-                                             self.tr('Database (connection name)'), self.DB_CONNECTIONS))
-        self.addParameter(ParameterString(self.SCHEMA,
-                                          self.tr('Schema (schema name)'), 'public'))
-        self.addParameter(ParameterString(self.TABLENAME,
-                                          self.tr('Table to import to (leave blank to use layer name)'), optional=True))
+        self.addParameter(ParameterString(
+            self.DATABASE,
+            self.tr('Database (connection name)'),
+            metadata={
+                'widget_wrapper': {
+                    'class': 'processing.gui.wrappers_postgis.ConnectionWidgetWrapper'}}))
+        self.addParameter(ParameterString(
+            self.SCHEMA,
+            self.tr('Schema (schema name)'),
+            'public',
+            optional=True,
+            metadata={
+                'widget_wrapper': {
+                    'class': 'processing.gui.wrappers_postgis.SchemaWidgetWrapper',
+                    'connection_param': self.DATABASE}}))
+        self.addParameter(ParameterString(
+            self.TABLENAME,
+            self.tr('Table to import to (leave blank to use layer name)'),
+            '',
+            optional=True,
+            metadata={
+                'widget_wrapper': {
+                    'class': 'processing.gui.wrappers_postgis.TableWidgetWrapper',
+                    'schema_param': self.SCHEMA}}))
         self.addParameter(ParameterTableField(self.PRIMARY_KEY,
                                               self.tr('Primary key field'), self.INPUT, optional=True))
         self.addParameter(ParameterString(self.GEOMETRY_COLUMN,
@@ -85,7 +100,7 @@ def defineCharacteristics(self):
                                            self.tr('Create single-part geometries instead of multi-part'), False))
 
     def processAlgorithm(self, feedback):
-        connection = self.DB_CONNECTIONS[self.getParameterValue(self.DATABASE)]
+        connection = self.getParameterValue(self.DATABASE)
         db = postgis.GeoDB.from_name(connection)
 
         schema = self.getParameterValue(self.SCHEMA)

diff --git a/python/plugins/processing/algs/qgis/PostGISExecuteSQL.py b/python/plugins/processing/algs/qgis/PostGISExecuteSQL.py
@@ -26,8 +26,6 @@
 
 __revision__ = '$Format:%H$'
 
-from qgis.PyQt.QtCore import QSettings
-
 from processing.core.GeoAlgorithm import GeoAlgorithm
 from processing.core.GeoAlgorithmExecutionException import GeoAlgorithmExecutionException
 from processing.core.parameters import ParameterString
@@ -42,7 +40,12 @@ class PostGISExecuteSQL(GeoAlgorithm):
     def defineCharacteristics(self):
         self.name, self.i18n_name = self.trAlgorithm('PostGIS execute SQL')
         self.group, self.i18n_group = self.trAlgorithm('Database')
-        self.addParameter(ParameterString(self.DATABASE, self.tr('Database')))
+        self.addParameter(ParameterString(
+            self.DATABASE,
+            self.tr('Database'),
+            metadata={
+                'widget_wrapper': {
+                    'class': 'processing.gui.wrappers_postgis.ConnectionWidgetWrapper'}}))
         self.addParameter(ParameterString(self.SQL, self.tr('SQL query'), '', True))
 
     def processAlgorithm(self, feedback):

diff --git a/python/plugins/processing/core/parameters.py b/python/plugins/processing/core/parameters.py
@@ -178,14 +178,19 @@ def tr(self, string, context=''):
 
     def wrapper(self, dialog, row=0, col=0):
         wrapper = self.metadata.get('widget_wrapper', None)
+        params = {}
+        # wrapper metadata should be a dict with class key
+        if isinstance(wrapper, dict):
+            params = deepcopy(wrapper)
+            wrapper = params.pop('class')
         # wrapper metadata should be a class path
         if isinstance(wrapper, str):
             tokens = wrapper.split('.')
             mod = __import__('.'.join(tokens[:-1]), fromlist=[tokens[-1]])
             wrapper = getattr(mod, tokens[-1])
         # or directly a class object
         if isclass(wrapper):
-            wrapper = wrapper(self, dialog, row, col)
+            wrapper = wrapper(self, dialog, row, col, **params)
         # or a wrapper instance
         return wrapper
 

diff --git a/python/plugins/processing/gui/StringInputPanel.py b/python/plugins/processing/gui/StringInputPanel.py