Prepare plugin for Qt6

.github/workflows/test.yml

@@ -12,7 +12,7 @@ jobs:
     - uses: actions/checkout@v4
     - name: Run test 3.16
       run: |
-        docker run -v ${GITHUB_WORKSPACE}:/src -w /src qgis/qgis:release-3_16 sh -c 'apt-get -y update && apt-get -y install xvfb && export ORS_API_KEY=${{ secrets.ORS_API_KEY }} && export DISPLAY=:0.0 && pip install -U pytest && xvfb-run pytest'
+        docker run -v ${GITHUB_WORKSPACE}:/src -w /src qgis/qgis:release-3_16 sh -c 'apt-get -y update && apt-get -y install xvfb && export ORS_API_KEY=${{ secrets.ORS_API_KEY }} && pip install -U pytest && xvfb-run -a pytest'
       env:
         DOCKER_IMAGE: ${{ steps.docker-build.outputs.FULL_IMAGE_NAME }}
   test_3_22:
@@ -21,7 +21,7 @@ jobs:
     - uses: actions/checkout@v4
     - name: Run test 3.22
       run: |
-        docker run -v ${GITHUB_WORKSPACE}:/src -w /src qgis/qgis:release-3_22 sh -c 'apt-get -y update && apt-get -y install xvfb && export DISPLAY=:0.0 && export ORS_API_KEY=${{ secrets.ORS_API_KEY }} && export DISPLAY=:0.0 && pip install -U pytest && xvfb-run pytest'
+        docker run -v ${GITHUB_WORKSPACE}:/src -w /src qgis/qgis:release-3_22 sh -c 'apt-get -y update && apt-get -y install xvfb && export ORS_API_KEY=${{ secrets.ORS_API_KEY }} && export DISPLAY=:0.0 && pip install -U pytest && xvfb-run -a pytest'
       env:
         DOCKER_IMAGE: ${{ steps.docker-build.outputs.FULL_IMAGE_NAME }}
   test_latest:
@@ -30,6 +30,6 @@ jobs:
     - uses: actions/checkout@v4
     - name: Run test latest
       run: |
-        docker run -v ${GITHUB_WORKSPACE}:/src -w /src qgis/qgis:latest sh -c 'apt-get -y update && apt-get -y install xvfb && export DISPLAY=:0.0 && export ORS_API_KEY=${{ secrets.ORS_API_KEY }} && apt install python3-pytest && xvfb-run pytest'
+        docker run -v ${GITHUB_WORKSPACE}:/src -w /src qgis/qgis:latest sh -c 'apt-get -y update && apt-get -y install xvfb && export ORS_API_KEY=${{ secrets.ORS_API_KEY }} && apt install python3-pytest && xvfb-run -a pytest'
       env:
         DOCKER_IMAGE: ${{ steps.docker-build.outputs.FULL_IMAGE_NAME }}

ORStools/common/directions_core.py

@@ -31,9 +31,10 @@
 from qgis.core import QgsPoint, QgsPointXY, QgsGeometry, QgsFeature, QgsFields, QgsField
 from typing import List, Generator, Tuple, Any, Optional
 
-from qgis.PyQt.QtCore import QVariant
+from qgis.PyQt.QtCore import QMetaType
 
 from ORStools.utils import convert, logger
+from ORStools.utils.wrapper import create_qgs_field
 
 
 def get_request_point_features(route_dict: dict, row_by_row: str) -> Generator[List, Tuple, None]:
@@ -75,22 +76,22 @@ def get_request_point_features(route_dict: dict, row_by_row: str) -> Generator[L
 
 
 def get_fields(
-    from_type: QVariant.Type = QVariant.String,
-    to_type: QVariant.Type = QVariant.String,
+    from_type: QMetaType.Type = QMetaType.Type.QString,
+    to_type: QMetaType.Type = QMetaType.Type.QString,
     from_name: str = "FROM_ID",
     to_name: str = "TO_ID",
     line: bool = False,
     extra_info: list = [],
     two_layers: bool = False,
-) -> QgsFields:
+) -> QgsField:
     """
     Builds output fields for directions response layer.
 
     :param from_type: field type for 'FROM_ID' field
-    :type from_type: QVariant enum
+    :type from_type: QMetaType enum
 
     :param to_type: field type for 'TO_ID' field
-    :type to_type: QVariant enum
+    :type to_type: QMetaType enum
 
     :param from_name: field name for 'FROM_ID' field
     :type from_name: str
@@ -107,21 +108,21 @@ def get_fields(
 
     fields = QgsFields()
     if not extra_info:
-        fields.append(QgsField("DIST_KM", QVariant.Double))
-        fields.append(QgsField("DURATION_H", QVariant.Double))
-        fields.append(QgsField("PROFILE", QVariant.String))
-        fields.append(QgsField("PREF", QVariant.String))
-        fields.append(QgsField("OPTIONS", QVariant.String))
-        fields.append(QgsField(from_name, from_type))
+        fields.append(create_qgs_field("DIST_KM", QMetaType.Type.Double))
+        fields.append(create_qgs_field("DURATION_H", QMetaType.Type.Double))
+        fields.append(create_qgs_field("PROFILE", QMetaType.Type.QString))
+        fields.append(create_qgs_field("PREF", QMetaType.Type.QString))
+        fields.append(create_qgs_field("OPTIONS", QMetaType.Type.QString))
+        fields.append(create_qgs_field(from_name, from_type))
     if not line:
-        fields.append(QgsField(to_name, to_type))
+        fields.append(create_qgs_field(to_name, to_type))
     if two_layers:
-        fields.append(QgsField(from_name, from_type))
+        fields.append(create_qgs_field(from_name, from_type))
     for info in extra_info:
-        field_type = QVariant.Int
+        field_type = QMetaType.Type.Int
         if info in ["waytype", "surface", "waycategory", "roadaccessrestrictions", "steepness"]:
-            field_type = QVariant.String
-        fields.append(QgsField(info.upper(), field_type))
+            field_type = QMetaType.Type.QString
+        fields.append(create_qgs_field(info.upper(), field_type))
 
     return fields
 

ORStools/common/isochrones_core.py

@@ -33,7 +33,6 @@
 from qgis.core import (
     QgsPointXY,
     QgsFeature,
-    QgsField,
     QgsFields,
     QgsGeometry,
     QgsSymbol,
@@ -42,9 +41,10 @@
     QgsCategorizedSymbolRenderer,
 )
 
-from qgis.PyQt.QtCore import QVariant
+from qgis.PyQt.QtCore import QMetaType
 from qgis.PyQt.QtGui import QColor
 
+from ORStools.utils.wrapper import create_qgs_field
 
 # import processing
 
@@ -67,7 +67,7 @@ def set_parameters(
         profile: str,
         dimension: str,
         factor: int,
-        id_field_type: QVariant.String = QVariant.String,
+        id_field_type: QMetaType.Type.QString = QMetaType.Type.QString,
         id_field_name: str = "ID",
     ) -> None:
         """
@@ -84,7 +84,7 @@ def set_parameters(
         :type factor: int
 
         :param id_field_type: field type of ID field
-        :type id_field_type: QVariant enum
+        :type id_field_type: QMetaType enum
 
         :param id_field_name: field name of ID field
         :type id_field_name: str
@@ -105,12 +105,14 @@ def get_fields(self) -> QgsFields:
         :rtype: QgsFields
         """
         fields = QgsFields()
-        fields.append(QgsField(self.id_field_name, self.id_field_type))  # ID field
-        fields.append(QgsField("CENTER_LON", QVariant.String))
-        fields.append(QgsField("CENTER_LAT", QVariant.String))
-        fields.append(QgsField(self.field_dimension_name, QVariant.Int))  # Dimension field
-        fields.append(QgsField("AA_MODE", QVariant.String))
-        fields.append(QgsField("TOTAL_POP", QVariant.String))
+        fields.append(create_qgs_field(self.id_field_name, self.id_field_type))  # ID field
+        fields.append(create_qgs_field("CENTER_LON", QMetaType.Type.QString))
+        fields.append(create_qgs_field("CENTER_LAT", QMetaType.Type.QString))
+        fields.append(
+            create_qgs_field(self.field_dimension_name, QMetaType.Type.Int)
+        )  # Dimension field
+        fields.append(create_qgs_field("AA_MODE", QMetaType.Type.QString))
+        fields.append(create_qgs_field("TOTAL_POP", QMetaType.Type.QString))
 
         return fields
 

ORStools/gui/ORStoolsDialog.py

@@ -30,7 +30,7 @@
 import os
 from typing import Optional
 
-from PyQt5.QtWidgets import QCheckBox
+from qgis.PyQt.QtWidgets import QCheckBox
 
 from ..utils.router import route_as_layer
 
@@ -41,6 +41,8 @@
 
 import webbrowser
 
+from qgis.PyQt import uic
+from qgis._core import Qgis
 from qgis.core import (
     QgsProject,
     QgsVectorLayer,
@@ -51,26 +53,21 @@
     QgsGeometry,
     QgsCoordinateReferenceSystem,
     QgsSettings,
-    Qgis,
+    Qgis,  # noqa: F811
     QgsAnnotation,
     QgsCoordinateTransform,
 )
 from qgis.gui import QgsMapCanvasAnnotationItem, QgsCollapsibleGroupBox, QgisInterface
 from qgis.PyQt.QtCore import QSizeF, QPointF, QCoreApplication
-from qgis.PyQt.QtGui import QIcon, QTextDocument, QColor
+from qgis.PyQt.QtGui import QTextDocument
+from qgis.PyQt.QtWidgets import QAction, QDialog, QApplication, QMenu, QMessageBox, QDialogButtonBox
+from qgis.PyQt.QtGui import QColor
 from qgis.PyQt.QtWidgets import (
-    QAction,
-    QDialog,
-    QApplication,
-    QMenu,
-    QMessageBox,
-    QDialogButtonBox,
     QWidget,
     QRadioButton,
 )
 
 from ORStools import (
-    RESOURCE_PREFIX,
     PLUGIN_NAME,
     DEFAULT_COLOR,
     __version__,
@@ -82,11 +79,8 @@
     PROFILES,
     PREFERENCES,
 )
-from ORStools.utils import maptools, configmanager, transform
+from ORStools.utils import maptools, configmanager, transform, gui
 from .ORStoolsDialogConfig import ORStoolsDialogConfigMain
-from .ORStoolsDialogUI import Ui_ORStoolsDialogBase
-
-from . import resources_rc  # noqa: F401
 
 
 def on_config_click(parent):
@@ -154,19 +148,7 @@ def __init__(self, iface: QgisInterface) -> None:
     def initGui(self) -> None:
         """Called when plugin is activated (on QGIS startup or when activated in Plugin Manager)."""
 
-        def create_icon(f: str) -> QIcon:
-            """
-            internal function to create action icons
-
-            :param f: file name of icon.
-            :type f: str
-
-            :returns: icon object to insert to QAction
-            :rtype: QIcon
-            """
-            return QIcon(RESOURCE_PREFIX + f)
-
-        icon_plugin = create_icon("icon_orstools.png")
+        icon_plugin = gui.GuiUtils.get_icon("icon_orstools.png")
 
         self.actions = [
             QAction(
@@ -176,14 +158,18 @@ def create_icon(f: str) -> QIcon:
             ),
             # Config dialog
             QAction(
-                create_icon("icon_settings.png"),
+                gui.GuiUtils.get_icon("icon_settings.png"),
                 self.tr("Provider Settings"),
                 self.iface.mainWindow(),
             ),
             # About dialog
-            QAction(create_icon("icon_about.png"), self.tr("About"), self.iface.mainWindow()),
+            QAction(
+                gui.GuiUtils.get_icon("icon_about.png"), self.tr("About"), self.iface.mainWindow()
+            ),
             # Help page
-            QAction(create_icon("icon_help.png"), self.tr("Help"), self.iface.mainWindow()),
+            QAction(
+                gui.GuiUtils.get_icon("icon_help.png"), self.tr("Help"), self.iface.mainWindow()
+            ),
         ]
 
         # Create menu
@@ -294,7 +280,10 @@ def tr(self, string: str) -> str:
         return QCoreApplication.translate(str(self.__class__.__name__), string)
 
 
-class ORStoolsDialog(QDialog, Ui_ORStoolsDialogBase):
+MAIN_WIDGET, _ = uic.loadUiType(gui.GuiUtils.get_ui_file_path("ORStoolsDialogUI.ui"))
+
+
+class ORStoolsDialog(QDialog, MAIN_WIDGET):
     """Define the custom behaviour of Dialog"""
 
     def __init__(self, iface: QgisInterface, parent=None) -> None:
@@ -366,6 +355,15 @@ def __init__(self, iface: QgisInterface, parent=None) -> None:
         self.routing_fromline_list.model().rowsMoved.connect(self._reindex_list_items)
         self.routing_fromline_list.model().rowsRemoved.connect(self._reindex_list_items)
 
+        # Add icons to buttons
+        self.routing_fromline_map.setIcon(gui.GuiUtils.get_icon("icon_add.png"))
+        self.routing_fromline_clear.setIcon(gui.GuiUtils.get_icon("icon_clear.png"))
+        self.save_vertices.setIcon(gui.GuiUtils.get_icon("icon_save.png"))
+        self.provider_refresh.setIcon(gui.GuiUtils.get_icon("icon_refresh.png"))
+        self.provider_config.setIcon(gui.GuiUtils.get_icon("icon_settings.png"))
+        self.about_button.setIcon(gui.GuiUtils.get_icon("icon_about.png"))
+        self.help_button.setIcon(gui.GuiUtils.get_icon("icon_help.png"))
+
         # Connect signals to the color_duplicate_items function
         self.routing_fromline_list.model().rowsRemoved.connect(
             lambda: self.color_duplicate_items(self.routing_fromline_list)

ORStools/gui/ORStoolsDialogConfig.py

@@ -29,7 +29,7 @@
 
 from qgis.gui import QgsCollapsibleGroupBox
 
-from qgis.PyQt import QtWidgets
+from qgis.PyQt import QtWidgets, uic
 from qgis.PyQt.QtCore import QMetaObject
 from qgis.PyQt.QtWidgets import (
     QDialog,
@@ -39,12 +39,13 @@
 )
 from qgis.PyQt.QtGui import QIntValidator
 
-from ORStools.utils import configmanager
-from .ORStoolsDialogConfigUI import Ui_ORStoolsDialogConfigBase
+from ORStools.utils import configmanager, gui
 from ..proc import ENDPOINTS, DEFAULT_SETTINGS
 
+CONFIG_WIDGET, _ = uic.loadUiType(gui.GuiUtils.get_ui_file_path("ORStoolsDialogConfigUI.ui"))
 
-class ORStoolsDialogConfigMain(QDialog, Ui_ORStoolsDialogConfigBase):
+
+class ORStoolsDialogConfigMain(QDialog, CONFIG_WIDGET):
     """Builds provider config dialog."""
 
     def __init__(self, parent=None) -> None:
@@ -66,7 +67,7 @@ def __init__(self, parent=None) -> None:
         self.provider_remove.clicked.connect(self._remove_provider)
 
         # Change OK to Save in config window
-        self.buttonBox.button(QDialogButtonBox.Ok).setText(self.tr("Save"))
+        self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setText(self.tr("Save"))
 
     def accept(self) -> None:
         """When the OK Button is clicked, in-memory temp_config is updated and written to settings"""
@@ -88,8 +89,7 @@ def accept(self) -> None:
 
             timeout_input = box.findChild(QtWidgets.QLineEdit, box.title() + "_timeout_text")
             # https://doc.qt.io/qt-5/qvalidator.html#State-enum
-
-            if timeout_input.validator().State() != 2:
+            if timeout_input.validator().State != 2:
                 self._adjust_timeout_input(timeout_input)
 
             current_provider["timeout"] = int(timeout_input.text())
@@ -191,7 +191,7 @@ def _remove_provider(self) -> None:
             provider_id = providers.index(provider)
             del self.temp_config["providers"][provider_id]
 
-    def _collapse_boxes(self) -> None:
+    def _collapse_boxes(self):
         """Collapse all QgsCollapsibleGroupBoxes."""
         collapsible_boxes = self.providers.findChildren(QgsCollapsibleGroupBox)
         for box in collapsible_boxes: