[cuegui] Use the QtPy library instead of PySide directly. (#1238)

AcademySoftwareFoundation · Feb 10, 2023 · 1c5dce4 · 1c5dce4
1 parent ce22531
commit 1c5dce4
Show file tree

Hide file tree

Showing 87 changed files with 357 additions and 303 deletions.
diff --git a/.github/workflows/testing-pipeline.yml b/.github/workflows/testing-pipeline.yml
@@ -91,6 +91,15 @@ jobs:
  chown -R aswfuser:aswfgroup .
  su -c "cd cuebot && ./gradlew build --stacktrace --info" aswfuser
 
+ test_pyside6:
+ name: Run CueGUI Tests using PySide6
+ runs-on: ubuntu-latest
+ container: almalinux:9
+ steps:
+ - uses: actions/checkout@v2
+ - name: Run CueGUI Tests
+ run: ci/test_pyside6.sh
+
  lint_python:
  name: Lint Python Code
  runs-on: ubuntu-latest

diff --git a/VERSION.in b/VERSION.in
@@ -1 +1 @@
-0.21
+0.22
diff --git a/ci/run_gui_test.sh b/ci/run_gui_test.sh
@@ -14,8 +14,14 @@
 # > OK
 #
 
+py="$(command -v python3)"
+if [[ -z "$py" ]]; then
+ py="$(command -v python)"
+fi
+echo "Using Python binary ${py}"
+
 test_log="/tmp/cuegui_result.log"
-PYTHONPATH=pycue xvfb-run -d python cuegui/setup.py test | tee ${test_log}
+PYTHONPATH=pycue xvfb-run -d "${py}" cuegui/setup.py test | tee ${test_log}
 
 grep -Pz 'Ran \d+ tests in [0-9\.]+s\n\nOK' ${test_log}
 if [ $? -eq 0 ]; then

diff --git a/ci/test_pyside6.sh b/ci/test_pyside6.sh
@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# Script for testing CueGUI with PySide6.
+#
+# This script is written to be run within an almalinux environment in the OpenCue
+# GitHub Actions environment. See .github/workflows/testing-pipeline.yml.
+
+set -e
+
+# Install needed packages.
+yum -y install \
+ dbus-libs \
+ fontconfig \
+ gcc \
+ libxkbcommon-x11 \
+ mesa-libEGL-devel \
+ python-devel \
+ which \
+ xcb-util-keysyms \
+ xcb-util-image \
+ xcb-util-renderutil \
+ xcb-util-wm \
+ Xvfb
+
+# Install Python requirements.
+python3 -m pip install --user -r requirements.txt -r requirements_gui.txt
+# Replace PySide2 with PySide6.
+python3 -m pip uninstall -y PySide2
+python3 -m pip install --user PySide6==6.3.2
+
+# Fix compiled proto code for Python 3.
+python3 -m grpc_tools.protoc -I=proto/ --python_out=pycue/opencue/compiled_proto --grpc_python_out=pycue/opencue/compiled_proto proto/*.proto
+2to3 -wn -f import pycue/opencue/compiled_proto/*_pb2*.py
+
+# Run tests.
+ci/run_gui_test.sh
diff --git a/cuegui/cuegui/AbstractDialog.py b/cuegui/cuegui/AbstractDialog.py
@@ -21,8 +21,8 @@
 from __future__ import absolute_import
 from builtins import str
 
-from PySide2 import QtCore
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtWidgets
 
 
 class AbstractDialog(QtWidgets.QDialog):

diff --git a/cuegui/cuegui/AbstractDockWidget.py b/cuegui/cuegui/AbstractDockWidget.py
@@ -22,8 +22,8 @@
 from __future__ import print_function
 from __future__ import division
 
-from PySide2 import QtCore
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtWidgets
 
 import cuegui.Plugins
 

diff --git a/cuegui/cuegui/AbstractTreeWidget.py b/cuegui/cuegui/AbstractTreeWidget.py
@@ -26,9 +26,9 @@
 from builtins import range
 import time
 
-from PySide2 import QtCore
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 import cuegui.AbstractWidgetItem
 import cuegui.Constants

diff --git a/cuegui/cuegui/AbstractWidgetItem.py b/cuegui/cuegui/AbstractWidgetItem.py
@@ -24,8 +24,8 @@
 
 from builtins import str
 
-from PySide2 import QtCore
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtWidgets
 
 import cuegui.Constants
 import cuegui.Logger

diff --git a/cuegui/cuegui/Action.py b/cuegui/cuegui/Action.py
@@ -20,8 +20,8 @@
 from __future__ import print_function
 from __future__ import division
 
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 import cuegui.Constants
 

diff --git a/cuegui/cuegui/App.py b/cuegui/cuegui/App.py
@@ -14,8 +14,8 @@
 
 """Module for CueGUI's custom QApplication and associated helper functions."""
 
-from PySide2 import QtCore
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtWidgets
 
 import cuegui.Exception
 

diff --git a/cuegui/cuegui/Comments.py b/cuegui/cuegui/Comments.py
@@ -23,8 +23,8 @@
 from builtins import str
 import pickle
 
-from PySide2 import QtCore
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtWidgets
 
 import cuegui.Utils
 

diff --git a/cuegui/cuegui/ConfirmationDialog.py b/cuegui/cuegui/ConfirmationDialog.py
@@ -20,9 +20,9 @@
 from __future__ import division
 from __future__ import absolute_import
 
-from PySide2 import QtCore
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 
 class ConfirmationDialog(QtWidgets.QDialog):

diff --git a/cuegui/cuegui/Constants.py b/cuegui/cuegui/Constants.py
@@ -25,8 +25,8 @@
 import os
 import platform
 
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtGui
+from qtpy import QtWidgets
 import yaml
 
 import opencue

diff --git a/cuegui/cuegui/CreateShowDialog.py b/cuegui/cuegui/CreateShowDialog.py
@@ -21,8 +21,8 @@
 from __future__ import division
 
 
-from PySide2 import QtCore
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtWidgets
 
 import opencue
 

diff --git a/cuegui/cuegui/CreatorDialog.py b/cuegui/cuegui/CreatorDialog.py
@@ -23,7 +23,7 @@
 from builtins import str
 from builtins import zip
 
-from PySide2 import QtWidgets
+from qtpy import QtWidgets
 
 import opencue
 

diff --git a/cuegui/cuegui/CueJobMonitorTree.py b/cuegui/cuegui/CueJobMonitorTree.py
@@ -25,9 +25,9 @@
 from collections import namedtuple
 import time
 
-from PySide2 import QtCore
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 import opencue
 import opencue.compiled_proto.job_pb2

diff --git a/cuegui/cuegui/CueStateBarWidget.py b/cuegui/cuegui/CueStateBarWidget.py
@@ -24,9 +24,9 @@
 import time
 import weakref
 
-from PySide2 import QtCore
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 import cuegui.Logger
 

diff --git a/cuegui/cuegui/DarkPalette.py b/cuegui/cuegui/DarkPalette.py
@@ -22,8 +22,8 @@
 
 import platform
 
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 import cuegui.Constants
 

diff --git a/cuegui/cuegui/DependDialog.py b/cuegui/cuegui/DependDialog.py
@@ -20,8 +20,8 @@
 from __future__ import print_function
 from __future__ import division
 
-from PySide2 import QtCore
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtWidgets
 
 import cuegui.DependMonitorTree
 import cuegui.Logger

diff --git a/cuegui/cuegui/DependMonitorTree.py b/cuegui/cuegui/DependMonitorTree.py
@@ -22,7 +22,7 @@
 
 from builtins import map
 
-from PySide2 import QtWidgets
+from qtpy import QtWidgets
 
 from opencue.compiled_proto import depend_pb2
 import opencue.exception

diff --git a/cuegui/cuegui/DependWizard.py b/cuegui/cuegui/DependWizard.py
@@ -25,8 +25,8 @@
 from builtins import range
 import re
 
-from PySide2 import QtCore
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtWidgets
 
 import FileSequence
 import opencue

diff --git a/cuegui/cuegui/EmailDialog.py b/cuegui/cuegui/EmailDialog.py
@@ -38,9 +38,9 @@
  pass
 import smtplib
 
-from PySide2 import QtCore
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 import opencue
 

diff --git a/cuegui/cuegui/FilterDialog.py b/cuegui/cuegui/FilterDialog.py
@@ -23,9 +23,9 @@
 from builtins import map
 from builtins import str
 
-from PySide2 import QtCore
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 import opencue
 import opencue.compiled_proto.filter_pb2
@@ -63,7 +63,7 @@ def __init__(self, show, parent=None):
 
  :type show: opencue.wrappers.show.Show
  :param show: the show to manage filters for
- :type parent: PySide2.QtWidgets.QWidget.QWidget
+ :type parent: qtpy.QtWidgets.QWidget.QWidget
  :param parent: the parent widget
  """
  QtWidgets.QDialog.__init__(self, parent)

diff --git a/cuegui/cuegui/FrameMonitor.py b/cuegui/cuegui/FrameMonitor.py
@@ -24,9 +24,9 @@
 from copy import deepcopy
 import math
 
-from PySide2 import QtCore
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 import FileSequence
 from opencue.compiled_proto import job_pb2

diff --git a/cuegui/cuegui/FrameMonitorTree.py b/cuegui/cuegui/FrameMonitorTree.py
@@ -29,9 +29,9 @@
 import re
 import time
 
-from PySide2 import QtCore
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 import opencue
 from opencue.compiled_proto import job_pb2

diff --git a/cuegui/cuegui/FrameRangeSelection.py b/cuegui/cuegui/FrameRangeSelection.py
@@ -25,9 +25,9 @@
 from builtins import range
 import math
 
-from PySide2 import QtCore
-from PySide2 import QtGui
-from PySide2 import QtWidgets
+from qtpy import QtCore
+from qtpy import QtGui
+from qtpy import QtWidgets
 
 
 class FrameRangeSelectionWidget(QtWidgets.QWidget):
@@ -303,7 +303,7 @@ def __paintLabels(self, painter):
  oldPen = painter.pen()
 
  # draw hatches for labelled frames
- painter.setPen(self.palette().color(QtGui.QPalette.Foreground))
+ painter.setPen(self.palette().color(QtGui.QPalette.WindowText))
  for frame in frames:
  xPos = self.__getTickArea(frame).left()
  painter.drawLine(xPos, -labelHeight, xPos, 0)
@@ -313,15 +313,15 @@ def __paintLabels(self, painter):
  metric = QtGui.QFontMetrics(painter.font())
  yPos = metric.ascent() + 1
  rightEdge = -10000
- width = metric.width(str(frames[-1]))
+ width = metric.horizontalAdvance(str(frames[-1]))
  farEdge = self.__getTickArea(frames[-1]).right() - width // 2
 
  farEdge -= 4
 
  for frame in frames:
  xPos = self.__getTickArea(frame).left()
  frameString = str(frame)
- width = metric.width(frameString)
+ width = metric.horizontalAdvance(frameString)
  xPos = xPos - width // 2
  if (xPos > rightEdge and xPos + width < farEdge) or frame is frames[-1]:
  painter.drawText(xPos, yPos, frameString)
@@ -337,7 +337,7 @@ def __paintStartTime(self, painter):
 
  metric = QtGui.QFontMetrics(painter.font())
  frameString = str(int(startFrame))
- xPos = timeExtent.left() - metric.width(frameString) // 2
+ xPos = timeExtent.left() - metric.horizontalAdvance(frameString) // 2
  yPos = metric.ascent() + 1
  painter.drawText(xPos, yPos, frameString)
  painter.setPen(oldPen)
@@ -351,7 +351,7 @@ def __paintEndTime(self, painter):
 
  metric = QtGui.QFontMetrics(painter.font())
  frameString = str(int(endFrame))
- xPos = timeExtent.left() - metric.width(frameString) // 2
+ xPos = timeExtent.left() - metric.horizontalAdvance(frameString) // 2
  yPos = metric.ascent() + 1
  painter.drawText(xPos, yPos, frameString)
  painter.setPen(oldPen)
@@ -372,7 +372,7 @@ def __paintFloatTime(self, painter):
  painter.setPen(QtGui.QColor(128, 128, 128))
  metric = QtGui.QFontMetrics(painter.font())
  frameString = str(self.__floatTime)
- xPos = timeExtent.left() - metric.width(frameString) // 2
+ xPos = timeExtent.left() - metric.horizontalAdvance(frameString) // 2
  yPos = timeExtent.top() + metric.ascent()
  painter.drawText(xPos, yPos, frameString)
  painter.setPen(oldPen)

diff --git a/cuegui/cuegui/GarbageCollector.py b/cuegui/cuegui/GarbageCollector.py
@@ -23,7 +23,7 @@
 
 import gc
 
-from PySide2 import QtCore
+from qtpy import QtCore
 
 
 class GarbageCollector(QtCore.QObject):