Use PySide6

Upgrade from qtpy with pyqt5 to PySide6.
Using PySide6 directly should give us better typing.

.github/actions/install_dependencies/action.yml

@@ -2,9 +2,8 @@ name: install_dependencies
 description: Installs dependencies for the pip build
 
 inputs:
-    os:
-        required: true
-
+  os:
+    required: true
 
 runs:
   using: "composite"

.github/actions/install_dependencies_qt/action.yml

@@ -0,0 +1,16 @@
+name: install_dependencies_qt
+description: Installs dependencies for qt
+
+inputs:
+  os:
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install Ubuntu dependencies
+      if: inputs.os == 'ubuntu-latest'
+      run: |
+        sudo apt-get update
+        sudo apt-get install libegl1
+      shell: bash

.github/workflows/test_ert.yml

@@ -25,6 +25,10 @@ jobs:
         submodules: true
         lfs: true
 
+    - uses: ./.github/actions/install_dependencies_qt
+      with:
+        os: ${{ inputs.os }}
+
     - uses: actions/setup-python@v5
       id: setup_python
       with:

pyproject.toml

@@ -58,7 +58,7 @@ dependencies = [
     "python-dateutil",
     "python-multipart",  # extra dependency for fastapi
     "pyyaml",
-    "qtpy",
+    "PySide6",
     "requests",
     "resfo",
     "scipy >= 1.10.1",
@@ -126,6 +126,7 @@ style = [
 ]
 types = [
     "mypy",
+    "pyside6-stubs",
     "types-lxml",
     "types-requests",
     "types-PyYAML",
@@ -251,7 +252,7 @@ typeCheckingMode = "standard"
 pythonVersion = "3.11"
 
 [tool.pyright.defineConstant]
-PYSIDE6 = false
-PYQT5 = true
+PYSIDE6 = true
+PYQT5 = false
 PYSIDE2 = false
 PYQT6 = false

src/ert/ensemble_evaluator/snapshot.py

@@ -6,7 +6,7 @@
 from datetime import datetime
 from typing import Any, TypeVar, cast, get_args
 
-from qtpy.QtGui import QColor
+from PySide6.QtGui import QColor
 from typing_extensions import TypedDict
 
 from _ert.events import (

src/ert/gui/about_dialog.py

@@ -1,6 +1,6 @@
-from qtpy.QtCore import QSize, Qt
-from qtpy.QtGui import QFont
-from qtpy.QtWidgets import (
+from PySide6.QtCore import QSize, Qt
+from PySide6.QtGui import QFont
+from PySide6.QtWidgets import (
     QDialog,
     QHBoxLayout,
     QLabel,
@@ -19,13 +19,8 @@ def __init__(self, parent: QWidget | None) -> None:
         self.setWindowTitle("About")
         self.setModal(True)
         self.setFixedSize(QSize(600, 480))
-        self.setWindowFlags(
-            self.windowFlags()
-            & ~Qt.WindowFlags(Qt.WindowType.WindowContextHelpButtonHint)
-        )
-        self.setWindowFlags(
-            self.windowFlags() & ~Qt.WindowFlags(Qt.WindowType.WindowCloseButtonHint)
-        )
+        self.setWindowFlag(Qt.WindowType.WindowContextHelpButtonHint, False)
+        self.setWindowFlag(Qt.WindowType.WindowCloseButtonHint, False)
 
         main_layout = QVBoxLayout()
 

src/ert/gui/ertnotifier.py

@@ -1,4 +1,4 @@
-from qtpy.QtCore import QObject, Signal, Slot
+from PySide6.QtCore import QObject, Signal, Slot
 
 from ert.storage import Ensemble, Storage
 

src/ert/gui/ertwidgets/__init__.py

@@ -1,7 +1,7 @@
 # isort: skip_file
-from qtpy.QtCore import Qt
-from qtpy.QtGui import QCursor
-from qtpy.QtWidgets import QApplication
+from PySide6.QtCore import Qt
+from PySide6.QtGui import QCursor
+from PySide6.QtWidgets import QApplication
 from typing import Any
 from collections.abc import Callable
 

src/ert/gui/ertwidgets/analysismoduleedit.py

@@ -2,9 +2,9 @@
 
 from typing import TYPE_CHECKING
 
-from qtpy.QtCore import QMargins, Qt
-from qtpy.QtGui import QIcon
-from qtpy.QtWidgets import QHBoxLayout, QToolButton, QWidget
+from PySide6.QtCore import QMargins, Qt
+from PySide6.QtGui import QIcon
+from PySide6.QtWidgets import QHBoxLayout, QToolButton, QWidget
 
 from ert.gui.ertwidgets import ClosableDialog
 from ert.gui.ertwidgets.analysismodulevariablespanel import AnalysisModuleVariablesPanel

src/ert/gui/ertwidgets/analysismodulevariablespanel.py

@@ -4,16 +4,15 @@
 from typing import cast, get_args
 
 from annotated_types import Ge, Gt, Le
-from qtpy.QtCore import Qt
-from qtpy.QtWidgets import (
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import (
     QCheckBox,
     QComboBox,
     QDoubleSpinBox,
     QFormLayout,
     QFrame,
     QHBoxLayout,
     QLabel,
-    QLayout,
     QWidget,
 )
 
@@ -52,7 +51,7 @@ def __init__(self, analysis_module: AnalysisModule, ensemble_size: int):
             ):
                 metadata = analysis_module.model_fields[variable_name]
                 layout.addRow(
-                    metadata.title,
+                    metadata.title if metadata.title else "",
                     self.createDoubleSpinBox(
                         variable_name,
                         analysis_module.__getattribute__(variable_name),
@@ -105,7 +104,8 @@ def __init__(self, analysis_module: AnalysisModule, ensemble_size: int):
 
             localization_frame = QFrame()
             localization_frame.setLayout(QHBoxLayout())
-            lf_layout = cast(QLayout, localization_frame.layout())
+            lf_layout = localization_frame.layout()
+            assert lf_layout is not None
             lf_layout.setContentsMargins(0, 0, 0, 0)
 
             metadata = analysis_module.model_fields[
@@ -154,8 +154,8 @@ def update_inversion_algorithm(
     @staticmethod
     def create_horizontal_line() -> QFrame:
         hline = QFrame()
-        hline.setFrameShape(QFrame.HLine)
-        hline.setFrameShadow(QFrame.Sunken)
+        hline.setFrameShape(QFrame.Shape.HLine)
+        hline.setFrameShadow(QFrame.Shadow.Sunken)
         hline.setFixedHeight(20)
         return hline
 

src/ert/gui/ertwidgets/checklist.py

@@ -2,9 +2,9 @@
 
 from typing import TYPE_CHECKING
 
-from qtpy.QtCore import QPoint, QSize, Qt
-from qtpy.QtGui import QIcon
-from qtpy.QtWidgets import (
+from PySide6.QtCore import QPoint, QSize, Qt
+from PySide6.QtGui import QIcon
+from PySide6.QtWidgets import (
     QAbstractItemView,
     QHBoxLayout,
     QLabel,
@@ -44,7 +44,7 @@ def __init__(
 
         self._list = QListWidget()
         self._list.setContextMenuPolicy(Qt.ContextMenuPolicy.CustomContextMenu)
-        self._list.setSelectionMode(QAbstractItemView.ExtendedSelection)
+        self._list.setSelectionMode(QAbstractItemView.SelectionMode.ExtendedSelection)
 
         self._search_box = SearchBox()
 
@@ -162,7 +162,7 @@ def uncheckSelected(self) -> None:
 
     def showContextMenu(self, point: QPoint) -> None:
         p = self._list.mapToGlobal(point)
-        menu = QMenu()
+        menu = QMenu(self)
         check_selected = menu.addAction("Check selected")
         uncheck_selected = menu.addAction("Uncheck selected")
         menu.addSeparator()

src/ert/gui/ertwidgets/closabledialog.py

@@ -1,30 +1,25 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from collections.abc import Callable
+from typing import TYPE_CHECKING, cast
 
-from qtpy.QtCore import Qt
-from qtpy.QtWidgets import QDialog, QHBoxLayout, QPushButton, QVBoxLayout, QWidget
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import QDialog, QHBoxLayout, QPushButton, QVBoxLayout, QWidget
 
 if TYPE_CHECKING:
-    from qtpy.QtGui import QKeyEvent
-    from qtpy.QtWidgets import QT_SLOT
+    from PySide6.QtGui import QKeyEvent
 
 
 class ClosableDialog(QDialog):
     def __init__(
         self, title: str | None, widget: QWidget, parent: QWidget | None = None
     ) -> None:
         QDialog.__init__(self, parent)
-        self.setWindowTitle(title)
+        self.setWindowTitle(title if title else "")
         self.setModal(True)
-        self.setWindowFlags(self.windowFlags() | Qt.WindowType.CustomizeWindowHint)
-        self.setWindowFlags(
-            self.windowFlags()
-            & ~Qt.WindowFlags(Qt.WindowType.WindowContextHelpButtonHint)
-        )
-        self.setWindowFlags(
-            self.windowFlags() & ~Qt.WindowFlags(Qt.WindowType.WindowCloseButtonHint)
-        )
+        self.setWindowFlag(Qt.WindowType.CustomizeWindowHint, True)
+        self.setWindowFlag(Qt.WindowType.WindowContextHelpButtonHint, False)
+        self.setWindowFlag(Qt.WindowType.WindowCloseButtonHint, False)
 
         layout = QVBoxLayout()
         layout.addWidget(widget, stretch=1)
@@ -47,18 +42,20 @@ def disableCloseButton(self) -> None:
     def enableCloseButton(self) -> None:
         self.close_button.setEnabled(True)
 
-    def keyPressEvent(self, a0: QKeyEvent | None) -> None:
-        if self.close_button.isEnabled() or a0 is None or a0.key() != Qt.Key.Key_Escape:
-            QDialog.keyPressEvent(self, a0)
+    def keyPressEvent(self, arg__1: QKeyEvent) -> None:
+        if self.close_button.isEnabled() or arg__1.key() != Qt.Key.Key_Escape:
+            QDialog.keyPressEvent(self, arg__1)
 
-    def addButton(self, caption: str, listener: QT_SLOT) -> QPushButton:
+    def addButton(self, caption: str, listener: Callable) -> QPushButton:
         button = QPushButton(caption)
         button.setObjectName(str(caption).capitalize())
         self.__button_layout.insertWidget(1, button)
         button.clicked.connect(listener)
         return button
 
     def toggleButton(self, caption: str, enabled: bool) -> None:
-        button = self.findChild(QPushButton, str(caption).capitalize())
+        button = cast(
+            QPushButton, self.findChild(QPushButton, str(caption).capitalize())
+        )
         if button is not None:
             button.setEnabled(enabled)

src/ert/gui/ertwidgets/copy_button.py

@@ -1,14 +1,14 @@
 from abc import abstractmethod
 
-from qtpy.QtCore import QTimer
-from qtpy.QtGui import QIcon
-from qtpy.QtWidgets import QApplication, QMessageBox, QPushButton, QSizePolicy
+from PySide6.QtCore import QTimer
+from PySide6.QtGui import QIcon
+from PySide6.QtWidgets import QApplication, QMessageBox, QPushButton, QSizePolicy
 
 
 class CopyButton(QPushButton):
     def __init__(self) -> None:
         super().__init__()
-        self.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed)
+        self.setSizePolicy(QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Fixed)
         self.setIcon(QIcon("img:copy.svg"))
         self.restore_timer = QTimer(self)
 
@@ -32,7 +32,7 @@ def copy_text(self, text: str) -> None:
                 None,
                 "Error",
                 "Cannot copy text to clipboard because your system does not have a clipboard",
-                QMessageBox.Ok,
+                QMessageBox.StandardButton.Ok,
             )
         self.setIcon(QIcon("img:check.svg"))
         self.restore_timer.start(1000)

src/ert/gui/ertwidgets/copyablelabel.py

@@ -1,7 +1,7 @@
 from os import path
 
-from qtpy.QtCore import Qt
-from qtpy.QtWidgets import QHBoxLayout, QLabel
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import QHBoxLayout, QLabel
 
 from .copy_button import CopyButton
 

src/ert/gui/ertwidgets/create_experiment_dialog.py

@@ -1,8 +1,8 @@
-from qtpy.QtCore import (
+from PySide6.QtCore import (
     Qt,
     Signal,
 )
-from qtpy.QtWidgets import (
+from PySide6.QtWidgets import (
     QDialog,
     QDialogButtonBox,
     QGridLayout,
@@ -59,13 +59,13 @@ def __init__(
         self._iterations_field.setValidator(IntegerArgument(from_value=0))
         self._iterations_field.setObjectName("iterations_field_ced")
         buttons = QDialogButtonBox(
-            QDialogButtonBox.Ok | QDialogButtonBox.Cancel,
+            QDialogButtonBox.StandardButton.Ok | QDialogButtonBox.StandardButton.Cancel,
             Qt.Orientation.Horizontal,
             self,
         )
         buttons.accepted.connect(self.accept)
         buttons.rejected.connect(self.reject)
-        ok_button = buttons.button(QDialogButtonBox.Ok)
+        ok_button = buttons.button(QDialogButtonBox.StandardButton.Ok)
         assert ok_button
         self._ok_button = ok_button
 

src/ert/gui/ertwidgets/customdialog.py

@@ -1,8 +1,8 @@
 from typing import Any
 
-from qtpy.QtCore import QSize, Qt
-from qtpy.QtGui import QColor
-from qtpy.QtWidgets import (
+from PySide6.QtCore import QSize, Qt
+from PySide6.QtGui import QColor
+from PySide6.QtWidgets import (
     QDialog,
     QDialogButtonBox,
     QFormLayout,
@@ -93,18 +93,18 @@ def addLabeledOption(self, label: Any, option_widget: QWidget) -> None:
 
         self._layout.addRow(f"{label}:", option_widget)
 
-    def addWidget(self, widget: QWidget | QLayout | None, label: str = "") -> None:
+    def addWidget(self, widget: QWidget | QLayout, label: str = "") -> None:
         if not label.endswith(":"):
             label = f"{label}:"
         self._layout.addRow(label, widget)
 
     def addButtons(self) -> None:
         buttons = QDialogButtonBox(
-            QDialogButtonBox.Ok | QDialogButtonBox.Cancel,
+            QDialogButtonBox.StandardButton.Ok | QDialogButtonBox.StandardButton.Cancel,
             Qt.Orientation.Horizontal,
             self,
         )
-        self.ok_button = buttons.button(QDialogButtonBox.Ok)
+        self.ok_button = buttons.button(QDialogButtonBox.StandardButton.Ok)
         if self.ok_button:
             self.ok_button.setEnabled(False)