Merge pull request #208 from geotribu/packaging/make-qtribu-compatible-with-qt6

Packaging : make QTribu compatible with qt6

Author: Guts

.github/workflows/linter.yml

@@ -45,3 +45,29 @@ jobs:
           flake8 ${{ env.PROJECT_FOLDER }} --count --select=E9,F63,F7,F82 --show-source --statistics
           # exit-zero treats all errors as warnings.
           flake8 ${{ env.PROJECT_FOLDER }} --count --exit-zero --statistics
+
+  qt6-check:
+    name: PyQt6 6️⃣
+    runs-on: ubuntu-latest
+    container:
+      image: registry.gitlab.com/oslandia/qgis/pyqgis-4-checker/pyqgis-qt-checker:latest
+      volumes:
+        - /tmp/.X11-unix:/tmp/.X11-unix
+        - ${{ github.workspace }}:/home/pyqgisdev/
+      options: --user root
+    steps:
+      - name: Get source code
+        uses: actions/checkout@v4
+
+      - name: Check PyQt5 to PyQt6 compatibility.
+        run: |
+          pyqt5_to_pyqt6.py --dry_run ${{ env.PROJECT_FOLDER }}/
+          pyqt5_to_pyqt6.py --logfile pyqt6_checker.log ${{ env.PROJECT_FOLDER }}/
+
+      - name: Upload script report if script fails
+        uses: actions/upload-artifact@v4
+        if: ${{ failure() }}
+        with:
+          name: pyqt6-checker-error-report
+          path: pyqt6_checker.log
+          retention-days: 7

CHANGELOG.md

@@ -14,22 +14,39 @@ Unreleased
 
 ### Features and enhancements 🎉
 
-* feature(qchat): auto-reconnect to last room when QGIS starts by @gounux in https://github.com/geotribu/qtribu/pull/209
-* feature(qchat): handle users registration by @gounux in https://github.com/geotribu/qtribu/pull/200
-* feature(qchat): like message by @gounux in https://github.com/geotribu/qtribu/pull/210
-* feature(qchat): re-arrange websocket message to allow image communications by @gounux in https://github.com/geotribu/qtribu/pull/211
-* refactor(qchat): use custom tree widget items by @gounux in https://github.com/geotribu/qtribu/pull/212
-* feature(qchat): send a geojson layer through websocket by @gounux in https://github.com/geotribu/qtribu/pull/213
-* refactor(qchat): use self.settings instead of PlgOptionsManager by @gounux in https://github.com/geotribu/qtribu/pull/217
-* ui(qchat): vertically optimize the QChat widget by @gounux in https://github.com/geotribu/qtribu/pull/216
-* feature(qchat): send and receive a crs message by @gounux in https://github.com/geotribu/qtribu/pull/219
-* feature(qchat): send and receive a bbox message by @gounux in https://github.com/geotribu/qtribu/pull/220
-* trad(qchat): add QChat fr translations by @gounux in https://github.com/geotribu/qtribu/pull/222
-* ui(qchat): set fixed height for an image chat item by @gounux in https://github.com/geotribu/qtribu/pull/221
+* feature(qchat): auto-reconnect to last room when QGIS starts by @gounux in <https://github.com/geotribu/qtribu/pull/209>
+* feature(qchat): handle users registration by @gounux in <https://github.com/geotribu/qtribu/pull/200>
+* feature(qchat): like message by @gounux in <https://github.com/geotribu/qtribu/pull/210>
+* feature(qchat): re-arrange websocket message to allow image communications by @gounux in <https://github.com/geotribu/qtribu/pull/211>
+* refactor(qchat): use custom tree widget items by @gounux in <https://github.com/geotribu/qtribu/pull/212>
+* feature(qchat): send a geojson layer through websocket by @gounux in <https://github.com/geotribu/qtribu/pull/213>
+* refactor(qchat): use self.settings instead of PlgOptionsManager by @gounux in <https://github.com/geotribu/qtribu/pull/217>
+* ui(qchat): vertically optimize the QChat widget by @gounux in <https://github.com/geotribu/qtribu/pull/216>
+* feature(qchat): send and receive a crs message by @gounux in <https://github.com/geotribu/qtribu/pull/219>
+* feature(qchat): send and receive a bbox message by @gounux in <https://github.com/geotribu/qtribu/pull/220>
+* trad(qchat): add QChat fr translations by @gounux in <https://github.com/geotribu/qtribu/pull/222>
+* ui(qchat): set fixed height for an image chat item by @gounux in <https://github.com/geotribu/qtribu/pull/221>
 
 ### Bugs fixes 🐛
 
-* fix(qchat): add type key check when receiving a message by @gounux in https://github.com/geotribu/qtribu/pull/218
+* fix(qchat): add type key check when receiving a message by @gounux in <https://github.com/geotribu/qtribu/pull/218>
+
+## 1.0.0 - 2024-10-11
+
+### Bugs fixes 🐛
+
+* fix(qchat): use mp3 instead of ogg by @gounux in <https://github.com/geotribu/qtribu/pull/198>
+
+### Features and enhancements 🎉
+
+* improve(qchat): play sound only on mention by @gounux in <https://github.com/geotribu/qtribu/pull/199>
+* update(ui): move misc groupbox to bottom in settings dialog by @Guts in <https://github.com/geotribu/qtribu/pull/205>
+* UI: display avatars right into combobox by @Guts in <https://github.com/geotribu/qtribu/pull/206>
+* update(i18n): refine translation to prepare next stable release by @Guts in <https://github.com/geotribu/qtribu/pull/207>
+
+### Tooling 🔧
+
+* update(ci): rm deprecated `set-output` command by @Guts in <https://github.com/geotribu/qtribu/pull/203>
 
 ## 1.0.0 - 2024-10-11
 

qtribu/__about__.py

@@ -44,7 +44,7 @@ def plugin_metadata_as_dict() -> dict:
     Returns:
         dict: dict of dicts.
     """
-    config = ConfigParser()
+    config = ConfigParser(interpolation=None)
     if PLG_METADATA_FILE.is_file():
         config.read(PLG_METADATA_FILE.resolve(), encoding="UTF-8")
         return {s: dict(config.items(s)) for s in config.sections()}

qtribu/gui/dck_qchat.py

@@ -8,7 +8,6 @@
 from typing import Optional
 
 # PyQGIS
-from PyQt5 import QtWebSockets  # noqa QGS103
 from qgis.core import Qgis, QgsApplication, QgsJsonExporter, QgsMapLayer, QgsProject
 from qgis.gui import QgisInterface, QgsDockWidget
 from qgis.PyQt import uic
@@ -23,6 +22,7 @@
     QWidget,
 )
 
+# plugin
 from qtribu.__about__ import __title__
 from qtribu.constants import (
     ADMIN_MESSAGES_NICKNAME,
@@ -64,8 +64,6 @@
 )
 from qtribu.logic.qchat_websocket import QChatWebsocket
 from qtribu.tasks.dizzy import DizzyTask
-
-# plugin
 from qtribu.toolbelt import PlgLogger, PlgOptionsManager
 from qtribu.toolbelt.commons import open_url_in_webviewer, play_resource_sound
 from qtribu.toolbelt.preferences import PlgSettingsStructure
@@ -88,8 +86,8 @@ class QChatWidget(QgsDockWidget):
     def __init__(
         self,
         iface: QgisInterface,
-        parent: QWidget = None,
-        auto_reconnect_room: str = None,
+        parent: Optional[QWidget] = None,
+        auto_reconnect_room: Optional[str] = None,
     ):
         """QWidget to see and post messages on chat
 
@@ -137,7 +135,7 @@ def __init__(
         )
         self.twg_chat.itemClicked.connect(self.on_message_clicked)
         self.twg_chat.itemDoubleClicked.connect(self.on_message_double_clicked)
-        self.twg_chat.setContextMenuPolicy(Qt.CustomContextMenu)
+        self.twg_chat.setContextMenuPolicy(Qt.ContextMenuPolicy.CustomContextMenu)
         self.twg_chat.customContextMenuRequested.connect(
             self.on_custom_context_menu_requested
         )
@@ -260,7 +258,7 @@ def on_widget_opened(self) -> None:
                 self.cbb_room.addItem(room)
         except Exception as exc:
             self.iface.messageBar().pushCritical(self.tr("QChat error"), str(exc))
-            self.log(message=str(exc), log_level=Qgis.Critical)
+            self.log(message=str(exc), log_level=Qgis.MessageLevel.Critical)
         finally:
             self.current_room = MARKER_VALUE
 
@@ -304,7 +302,7 @@ def on_rules_button_clicked(self) -> None:
             )
         except Exception as exc:
             self.iface.messageBar().pushCritical(self.tr("QChat error"), str(exc))
-            self.log(message=str(exc), log_level=Qgis.Critical)
+            self.log(message=str(exc), log_level=Qgis.MessageLevel.Critical)
 
     def on_status_button_clicked(self) -> None:
         """
@@ -330,7 +328,7 @@ def on_status_button_clicked(self) -> None:
             )
             QMessageBox.information(self, self.tr("QChat instance status"), text)
         except Exception as exc:
-            self.log(message=str(exc), log_level=Qgis.Critical)
+            self.log(message=str(exc), log_level=Qgis.MessageLevel.Critical)
 
     def on_settings_button_clicked(self) -> None:
         """
@@ -367,7 +365,7 @@ def on_room_changed(self) -> None:
                 message=self.tr(
                     "QChat nickname not set or too short (between {min} and {max} characters). Please open settings to fix it."
                 ).format(min=self.min_author_length, max=self.max_author_length),
-                log_level=Qgis.Warning,
+                log_level=Qgis.MessageLevel.Warning,
                 push=self.settings.notify_push_info,
                 duration=self.settings.notify_push_duration,
                 button=True,
@@ -410,7 +408,7 @@ def on_connect_button_clicked(self) -> None:
                     message=self.tr(
                         "QChat nickname not set or too short (between {min} and {max} characters). Please open settings to fix it."
                     ).format(min=self.min_author_length, max=self.max_author_length),
-                    log_level=Qgis.Warning,
+                    log_level=Qgis.MessageLevel.Warning,
                     push=self.settings.notify_push_info,
                     duration=self.settings.notify_push_duration,
                     button=True,
@@ -493,7 +491,7 @@ def on_ws_error(self, error_code: int) -> None:
             self.add_admin_message(self.qchat_ws.error_string())
         self.log(
             message=f"{error_code}: {self.qchat_ws.error_string()}",
-            log_level=Qgis.Critical,
+            log_level=Qgis.MessageLevel.Critical,
         )
 
     # region websocket message received
@@ -504,7 +502,7 @@ def on_uncompliant_message_received(self, message: QChatUncompliantMessage) -> N
                 reason=message.reason
             ),
             application=self.tr("QChat"),
-            log_level=Qgis.Critical,
+            log_level=Qgis.MessageLevel.Critical,
             push=self.settings.notify_push_info,
             duration=self.settings.notify_push_duration,
         )
@@ -534,7 +532,7 @@ def on_text_message_received(self, message: QChatTextMessage) -> None:
                         "You were mentionned by {sender}: {message}"
                     ).format(sender=message.author, message=message.text),
                     application=self.tr("QChat"),
-                    log_level=Qgis.Info,
+                    log_level=Qgis.MessageLevel.Info,
                     push=self.settings.notify_push_info,
                     duration=self.settings.notify_push_duration,
                 )
@@ -602,7 +600,7 @@ def on_like_message_received(self, message: QChatLikeMessage) -> None:
                     liker_author=message.liker_author, message=message.message
                 ),
                 application=self.tr("QChat"),
-                log_level=Qgis.Success,
+                log_level=Qgis.MessageLevel.Success,
                 push=self.settings.notify_push_info,
                 duration=self.settings.notify_push_duration,
             )
@@ -777,7 +775,7 @@ def on_list_users_button_clicked(self) -> None:
             )
         except Exception as exc:
             self.iface.messageBar().pushCritical(self.tr("QChat error"), str(exc))
-            self.log(message=str(exc), log_level=Qgis.Critical)
+            self.log(message=str(exc), log_level=Qgis.MessageLevel.Critical)
 
     def on_clear_chat_button_clicked(self) -> None:
         """
@@ -798,7 +796,7 @@ def on_send_button_clicked(self) -> None:
         if not nickname:
             self.log(
                 message=self.tr("Nickname not set : please open settings and set it"),
-                log_level=Qgis.Warning,
+                log_level=Qgis.MessageLevel.Warning,
                 push=self.settings.notify_push_info,
                 duration=self.settings.notify_push_duration,
                 button=True,
@@ -812,7 +810,7 @@ def on_send_button_clicked(self) -> None:
                 message=self.tr(
                     "Nickname too short: must be at least 3 characters. Please open settings and set it"
                 ),
-                log_level=Qgis.Warning,
+                log_level=Qgis.MessageLevel.Warning,
                 push=self.settings.notify_push_info,
                 duration=self.settings.notify_push_duration,
                 button=True,
@@ -950,7 +948,7 @@ def check_cheatcode(self, text: str) -> bool:
             self.log(
                 message=self.tr("Your QGIS Pro license is about to expire"),
                 application="QGIS Pro",
-                log_level=Qgis.Warning,
+                log_level=Qgis.MessageLevel.Warning,
                 push=self.settings.notify_push_info,
                 duration=self.settings.notify_push_duration,
                 button=True,
@@ -968,7 +966,7 @@ def check_cheatcode(self, text: str) -> bool:
     def on_renew_clicked(self) -> None:
         msg_box = QMessageBox()
         msg_box.setWindowTitle("QGIS")
-        msg_box.setIcon(QMessageBox.Information)
+        msg_box.setIcon(QMessageBox.Icon.Information)
         msg_box.setText(
             self.tr(
                 """No... it was a joke!
@@ -980,9 +978,9 @@ def on_renew_clicked(self) -> None:
 """
             )
         )
-        msg_box.setStandardButtons(QMessageBox.Yes)
+        msg_box.setStandardButtons(QMessageBox.StandardButton.Yes)
         return_value = msg_box.exec()
-        if return_value == QMessageBox.Yes:
+        if return_value == QMessageBox.StandardButton.Yes:
             open_url_in_webviewer("https://qgis.org/funding/donate/", "qgis.org")
 
     def generate_qaction_send_geojson_layer(self, menu: QMenu) -> None:
@@ -1002,7 +1000,7 @@ def on_send_layer_to_qchat(self) -> None:
                     "Not connected to QChat. Please connect to a room first"
                 ),
                 application="QChat",
-                log_level=Qgis.Critical,
+                log_level=Qgis.MessageLevel.Critical,
                 push=self.settings.notify_push_info,
                 duration=self.settings.notify_push_duration,
             )
@@ -1012,16 +1010,16 @@ def on_send_layer_to_qchat(self) -> None:
             self.log(
                 message=self.tr("No active layer in current QGIS project"),
                 application=self.tr("QChat"),
-                log_level=Qgis.Critical,
+                log_level=Qgis.MessageLevel.Critical,
                 push=self.settings.notify_push_info,
                 duration=self.settings.notify_push_duration,
             )
             return
-        if layer.type() != QgsMapLayer.VectorLayer:
+        if layer.type() != QgsMapLayer.LayerType.VectorLayer:
             self.log(
                 message=self.tr("Only vector layers can be sent on QChat"),
                 application=self.tr("QChat"),
-                log_level=Qgis.Critical,
+                log_level=Qgis.MessageLevel.Critical,
                 push=self.settings.notify_push_info,
                 duration=self.settings.notify_push_duration,
             )

qtribu/gui/dlg_settings.py

@@ -155,7 +155,7 @@ def load_settings(self) -> None:
 
         # qchat
         instance_index = self.cbb_qchat_instance_uri.findText(
-            settings.qchat_instance_uri, Qt.MatchFixedString
+            settings.qchat_instance_uri, Qt.MatchFlag.MatchFixedString
         )
         if instance_index >= 0:
             self.cbb_qchat_instance_uri.setCurrentIndex(instance_index)
@@ -171,7 +171,7 @@ def load_settings(self) -> None:
         self.ckb_play_sounds.setChecked(settings.qchat_play_sounds)
         self.hsl_sound_volume.setValue(settings.qchat_sound_volume)
         beep_index = self.cbb_ring_tone.findText(
-            settings.qchat_ring_tone, Qt.MatchFixedString
+            settings.qchat_ring_tone, Qt.MatchFlag.MatchFixedString
         )
         if beep_index >= 0:
             self.cbb_ring_tone.setCurrentIndex(beep_index)
@@ -213,7 +213,7 @@ def show_instance_rules(self) -> None:
                 ),
             )
         except Exception as e:
-            self.log(message=str(e), log_level=Qgis.Critical)
+            self.log(message=str(e), log_level=Qgis.MessageLevel.Critical)
 
     def discover_instances(self) -> None:
         """
@@ -234,7 +234,7 @@ def discover_instances(self) -> None:
                 msg,
             )
         except Exception as e:
-            self.log(message=str(e), log_level=Qgis.Critical)
+            self.log(message=str(e), log_level=Qgis.MessageLevel.Critical)
 
     def on_ring_tone_changed(self) -> None:
         """

qtribu/gui/form_article.py

@@ -12,6 +12,7 @@
 from typing import Optional, Union
 
 # PyQGIS
+from qgis.core import Qgis
 from qgis.PyQt import uic
 from qgis.PyQt.QtWidgets import QDialog, QDialogButtonBox, QWidget
 
@@ -62,9 +63,13 @@ def __init__(self, parent: Optional[QWidget] = None):
                 "https://contribuer.geotribu.fr/articles/workflow/",
             )
         )
-        self.btn_box.button(QDialogButtonBox.Ok).clicked.connect(self.on_btn_submit)
-        self.btn_box.button(QDialogButtonBox.Ok).setDefault(True)
-        self.btn_box.button(QDialogButtonBox.Ok).setText(self.tr("Submit"))
+        self.btn_box.button(QDialogButtonBox.StandardButton.Ok).clicked.connect(
+            self.on_btn_submit
+        )
+        self.btn_box.button(QDialogButtonBox.StandardButton.Ok).setDefault(True)
+        self.btn_box.button(QDialogButtonBox.StandardButton.Ok).setText(
+            self.tr("Submit")
+        )
 
     def check_required_fields(self) -> bool:
         invalid_fields = []
@@ -121,7 +126,7 @@ def check_required_fields(self) -> bool:
                 parent_location=self,
                 message=self.tr("Some of required fields are incorrectly filled."),
                 push=True,
-                log_level=2,
+                log_level=Qgis.MessageLevel.Critical,
                 duration=20,
                 button=True,
                 button_label=self.tr("See details..."),
@@ -169,7 +174,7 @@ def on_btn_submit(self) -> Union[bool, str, None]:
         if url_opened:
             self.log(
                 message=self.tr("Issue form URL opened in default system web browser."),
-                log_level=4,
+                log_level=Qgis.MessageLevel.NoLevel,
             )
             super().accept()
             return True
@@ -182,6 +187,6 @@ def on_btn_submit(self) -> Union[bool, str, None]:
                 ),
                 push=True,
                 duration=10,
-                log_level=2,
+                log_level=Qgis.MessageLevel.Critical,
             )
             return False