Merge pull request #24 from GispoCoding/migrate-to-new-settings

Migrate to plugin tools settings methods

Author: LKajan

nlsgpkgloader/nls_geopackage_loader.py

@@ -32,10 +32,11 @@
     QgsLayerTreeGroup,
     QgsMessageLog,
     QgsProject,
+    QgsSettings,
     QgsVectorLayer,
 )
 from qgis.gui import QgsFileWidget
-from qgis.PyQt.QtCore import QCoreApplication, QSettings, QTimer, QTranslator, qVersion
+from qgis.PyQt.QtCore import QCoreApplication, QTimer, QTranslator, qVersion
 from qgis.PyQt.QtGui import QIcon
 from qgis.PyQt.QtWidgets import QAction, QListWidgetItem, QMessageBox
 from qgis.utils import iface
@@ -55,30 +56,28 @@
     DissolveFeaturesTask,
 )
 from nlsgpkgloader.qgis_plugin_tools.tools.resources import resources_path
+from nlsgpkgloader.qgis_plugin_tools.tools.settings import get_setting, set_setting
 from nlsgpkgloader.ui import (
     NLSGeoPackageLoaderMunicipalitySelectionDialog,
     NLSGeoPackageLoaderProgressDialog,
     NLSGeoPackageLoaderUserKeyDialog,
 )
 
+OLD_SETTINGS_GROUP_NAME = "NLSgpkgloader"
+
 
 class NLSGeoPackageLoader:
     """QGIS Plugin Implementation."""
 
     def __init__(self):
-        """Constructor.
+        """Constructor"""
 
-        :param iface: An interface instance that will be passed to this class
-            which provides the hook by which you can manipulate the QGIS
-            application at run time.
-        :type iface: QgsInterface
-        """
         # Save reference to the QGIS interface
         self.iface = iface
         # initialize plugin directory
         self.plugin_dir = os.path.dirname(__file__)
         # initialize locale
-        locale = QSettings().value("locale/userLocale")[0:2]
+        locale = get_setting("locale/userLocale", internal=False)[0:2]
         locale_path = resources_path("i18n", "NLSGeoPackageLoader_{}.qm".format(locale))
 
         if os.path.exists(locale_path):
@@ -101,9 +100,12 @@ def __init__(self):
 
         self.nls_user_key_dialog = NLSGeoPackageLoaderUserKeyDialog()
 
-        self.first_run = QSettings().value("/NLSgpkgloader/first_run", True, type=bool)
+        if OLD_SETTINGS_GROUP_NAME in QgsSettings().childGroups():
+            self._migrate_settings()
+
+        self.first_run = get_setting("first_run", True, bool)
         if self.first_run:
-            QSettings().setValue("/NLSgpkgloader/first_run", False)
+            set_setting("first_run", False)
 
     # noinspection PyMethodMayBeStatic
     def tr(self, message):
@@ -206,6 +208,15 @@ def initGui(self):  # noqa N802
         # will be set False in run()
         self.first_start = True
 
+    @staticmethod
+    def _migrate_settings():
+        settings = QgsSettings()
+        settings.beginGroup(OLD_SETTINGS_GROUP_NAME)
+        for key in settings.allKeys():
+            set_setting(key, settings.value(key))
+        settings.endGroup()
+        settings.remove(OLD_SETTINGS_GROUP_NAME)
+
     def unload(self):
         """Removes the plugin menu item and icon from QGIS GUI."""
         for action in self.actions:
@@ -214,24 +225,21 @@ def unload(self):
 
     def run(self):
         """Run method that performs all the real work"""
-        self.nls_user_key = QSettings().value("/NLSgpkgloader/userKey", "", type=str)
-        self.data_download_dir = QSettings().value(
-            "/NLSgpkgloader/dataDownloadDir", "", type=str
-        )
-        self.fileName = QSettings().value(
-            "/NLSgpkgloader/defaultFileName", "mtk.gpkg", type=str
-        )
-        self.addDownloadedDataAsLayer = QSettings().value(
-            "/NLSgpkgloader/addDownloadedDataAsLayer", True, type=bool
+        self.nls_user_key = get_setting("userKey", "", typehint=str)
+
+        self.data_download_dir = get_setting("dataDownloadDir", "", typehint=str)
+        self.fileName = get_setting("defaultFileName", "mtk.gpkg", typehint=str)
+        self.addDownloadedDataAsLayer = get_setting(
+            "addDownloadedDataAsLayer", True, typehint=bool
         )
-        self.showMunicipalitiesAsLayer = QSettings().value(
-            "/NLSgpkgloader/showMunicipalitiesAsLayer", True, type=bool
+        self.showMunicipalitiesAsLayer = get_setting(
+            "showMunicipalitiesAsLayer", True, typehint=bool
         )
-        self.showUTMGridsAsLayer = QSettings().value(
-            "/NLSgpkgloader/showUTMGridsAsLayer", False, type=bool
+        self.showUTMGridsAsLayer = get_setting(
+            "showUTMGridsAsLayer", False, typehint=bool
         )
-        self.showSeatilesAsLayer = QSettings().value(
-            "/NLSgpkgloader/showSeatilesAsLayer", False, type=bool
+        self.showSeatilesAsLayer = get_setting(
+            "showSeatilesAsLayer", False, typehint=bool
         )
 
         if self.nls_user_key == "":
@@ -290,7 +298,7 @@ def run(self):
                 return
             if self.fileName.split(".")[-1].lower() != "gpkg":
                 self.fileName += ".gpkg"
-            QSettings().setValue("/NLSgpkgloader/defaultFileName", self.fileName)
+            set_setting("defaultFileName", self.fileName)
             self.gpkg_path = os.path.join(self.data_download_dir, self.fileName)
             if os.path.isfile(self.gpkg_path):
                 reply = QMessageBox.question(
@@ -398,18 +406,10 @@ def toggle_layers(self):
         )
         self.showUTMGridsAsLayer = self.municipalities_dialog.loadUtmGrids.isChecked()
         self.showSeatilesAsLayer = self.municipalities_dialog.loadSeaGrids.isChecked()
-        QSettings().setValue(
-            "/NLSgpkgloader/addDownloadedDataAsLayer", self.addDownloadedDataAsLayer
-        )
-        QSettings().setValue(
-            "/NLSgpkgloader/showMunicipalitiesAsLayer", self.showMunicipalitiesAsLayer
-        )
-        QSettings().setValue(
-            "/NLSgpkgloader/showUTMGridsAsLayer", self.showUTMGridsAsLayer
-        )
-        QSettings().setValue(
-            "/NLSgpkgloader/showSeatilesAsLayer", self.showSeatilesAsLayer
-        )
+        set_setting("addDownloadedDataAsLayer", self.addDownloadedDataAsLayer)
+        set_setting("showMunicipalitiesAsLayer", self.showMunicipalitiesAsLayer)
+        set_setting("showUTMGridsAsLayer", self.showUTMGridsAsLayer)
+        set_setting("showSeatilesAsLayer", self.showSeatilesAsLayer)
 
         found_utm5_layer = (
             found_utm10_layer
@@ -872,10 +872,10 @@ def show_settings_dialog(self):
         )
         self.nls_user_key_dialog.userKeyLineEdit.setText(self.nls_user_key)
         self.nls_user_key_dialog.dataLocationQgsFileWidget.setFilePath(
-            QSettings().value(
-                "/NLSgpkgloader/dataDownloadDir",
+            get_setting(
+                "dataDownloadDir",
                 os.path.join(self.path, "data"),
-                type=str,
+                typehint=str,
             )
         )
 
@@ -895,10 +895,8 @@ def show_settings_dialog(self):
                 self.nls_user_key_dialog.dataLocationQgsFileWidget.filePath()
             )
 
-            QSettings().setValue("/NLSgpkgloader/userKey", self.nls_user_key)
-            QSettings().setValue(
-                "/NLSgpkgloader/dataDownloadDir", self.data_download_dir
-            )
+            set_setting("userKey", self.nls_user_key)
+            set_setting("dataDownloadDir", self.data_download_dir)
             return True
 
         else:

nlsgpkgloader/nls_geopackage_loader_tasks.py

@@ -20,13 +20,13 @@
 import os
 import sqlite3
 
-import processing  # pylint: disable=import-error
 from osgeo import ogr
-from processing.tools import dataobjects  # pylint: disable=import-error
+from qgis import processing
 from qgis.core import (
     QgsFeature,
     QgsFeatureRequest,
     QgsMessageLog,
+    QgsProcessingContext,
     QgsTask,
     QgsVectorFileWriter,
     QgsVectorLayer,
@@ -180,7 +180,8 @@ def run(self):
                 + layer_name
                 + '" (geom) sql=',
             }
-            context = dataobjects.createContext()
+
+            context = QgsProcessingContext()
             context.setInvalidGeometryCheck(QgsFeatureRequest.GeometrySkipInvalid)
             processing.run("native:dissolve", params, context=context)
             percentage = i / float(total_tables) * 100.0

pyproject.toml

@@ -12,8 +12,8 @@ extend-exclude = '''
 '''
 
 [tool.pytest.ini_options]
-addopts = "-v"
+addopts = "-v --cov=nlsgpkgloader --cov-report html --cov-report term"
 testpaths = "tests"
 
 [tool.coverage.report]
-omit = "nlsgpkgloader/qgis_plugin_tools/*"
+omit = ["nlsgpkgloader/qgis_plugin_tools/*"]

tests/test_settings_migration.py

@@ -0,0 +1,28 @@
+import pytest
+from qgis.core import QgsSettings
+
+from nlsgpkgloader.nls_geopackage_loader import (
+    OLD_SETTINGS_GROUP_NAME,
+    NLSGeoPackageLoader,
+)
+from nlsgpkgloader.qgis_plugin_tools.tools.settings import get_setting
+
+
+@pytest.fixture
+def old_settings():
+    settings = QgsSettings()
+    settings.beginGroup(OLD_SETTINGS_GROUP_NAME)
+    settings.setValue("setting1", "value1")
+    settings.setValue("setting2", True)
+    settings.endGroup()
+
+    yield settings
+
+
+def test_settings_migration(old_settings):
+    NLSGeoPackageLoader._migrate_settings()
+
+    assert OLD_SETTINGS_GROUP_NAME not in old_settings.childGroups()
+
+    assert get_setting("setting1") == "value1"
+    assert get_setting("setting2", typehint=bool) is True