Added PySide6 Support (squash) #394

zoshua · 2024-02-22T14:47:27Z

New branch for the "squashing"

mottosso · 2024-02-22T19:07:36Z

Excellent, nice and clean. But, somehow, tests are still not running. 😭 @martin-chatterjee can you spot what we could do to make tests run on PRs?

I expect tests will pass, as they appear to have done locally. So it's likely we can merge this, without officially announcing support for PySide6, and work our way to introducing tests for it in a separate PR. Although ideally, we'd do that here as well.

One of the reasons for using such a complex Dockerfile as we have today is because the world was young, and PyQt and PySide was just starting to live side by side, so it wasn't clear whether there were differences between official PySide/PyQt on PyPI versus PySide embedded in Maya. At this point however, I expect it would be very safe to test against what exists on PyPI. Especially considering this project no longer runs exclusively on Maya.

I remember seeing someone post their fork with an alternative test suite, but I'm struggling to find it :S It would be sensible to keep a separate GitHub action script or runner per Python version and PySide/PyQt combination.

Would you be up for this @zoshua or @martin-chatterjee?

martin-chatterjee · 2024-02-26T12:40:39Z

"Excellent, nice and clean. But, somehow, tests are still not running. 😭 @martin-chatterjee can you spot what we could do to make tests run on PRs?"

@mottosso, I just found the time to have a quick look, and I can not reproduce the CI issues on my side – which is good news, I guess? 🙂

I've created a PR for further debugging – so maybe you could try to merge my PR into some temp branch and push on your end?
This should show us if the CI still fails on mottosso/Qt.py.

For reference, here's what I did:

1. Add @zoshua's Qt.py fork as a remote, and fetch:

git remote add zoshua [email protected]:zoshua/Qt.py.git
git remote set-url zoshua --push no-push
git fetch zoshua

2. Create new branch `review-zoshua-pyside6` off of `master`, and push:

git checkout master
git checkout -b review-zoshua-pyside6
git push origin review-zoshua-pyside6

→ This establishes my base line, proofing that CI is (still) running as expected. ✅

3. Bring in @zoshua's work out of branch `squash`, and un-stage it:

git merge --squash zoshua/squash
git restore --staged .

4. Commit changes bit by bit, and push on every commit:

→ CI completes without errors on every commit. ✅

mottosso · 2024-02-26T13:02:10Z

so maybe you could try to merge my PR into some temp branch and push on your end?

But actions should run without merging. A big part of the actions is to make sure merging is safe to begin with, but if we have to merge before running the tests..? Am I missing something? 🤔 Your PR also is not triggering any tests. I expect there must be a configuration option to make GitHub Actions run on PRs too?

martin-chatterjee · 2024-02-26T13:28:43Z

@mottosso: Ah I see, I might have misunderstood the issue in the first place.

I was under the impression that the CI test jobs do not succeed on your end (→ just like this last failed GH action).

But what you would like to have is automatic CI test runs being executed on mottosso/Qt.py for every new PR, right?

So I might have barked up the wrong tree here for while... 🙂🤦‍♂️

martin-chatterjee · 2024-02-26T13:37:53Z

Off the top of my head, I'm not sure if running CI on the targeted repo of a PR is possible on Github – I've never thought about that before...

However, before any contributor is able to open a PR, they need to push to their fork – and this will already trigger and execute the CI test jobs over there.

So in a way, every PR already has executed CI test jobs associated with it – just not on mottosso/Qt.py, but on the source fork.

@mottosso, is this what you're after?

mottosso · 2024-02-26T13:38:28Z

But what you would like to have is automatic CI test runs being executed on mottosso/Qt.py for every new PR, right?

That's right, yeah. Sorry for not being clear about this! I appreciate you spent time putting together this alternative PR and painstakingly ran through each commit.

mottosso · 2024-02-26T13:40:20Z

@mottosso, is this what you're after?

No. In every other project I maintain on GitHub, CI is always run on PRs. There should be no need to visit a fork in order to see the results of tests.

For example:

Implements a different approach for __repr__ cmdx#78

martin-chatterjee · 2024-02-26T13:42:07Z

Ah nice, thanks for the example. So this actually is possible within Github. I'll take a look. 👍

martin-chatterjee · 2024-02-26T13:46:06Z

Well, that should be easy... 🙂👍

According to the example repo you provided:

name: cmdx-workflow

on:
  push:
  pull_request:
    branches: [ master ]

That seems to be all that's needed. 🙂

I'll take a look and test this.

martin-chatterjee · 2024-02-26T14:12:19Z

@mottosso:

→ PR #399

mottosso · 2024-02-26T14:16:10Z

Excellent, thanks @martin-chatterjee. At this point, I expect any updates to this PR to also run all tests. @zoshua would you mind merging with latest master, so we can see this thing in action?

mottosso · 2024-02-27T07:17:07Z

Great work. Now all we need is a GitHub workflow to test the PySide6-specifics of it. I expect we can start by adding a pyside6.yml here with the steps (1) install Python, (2) install PySide6 and (3) run the tests. Would you like to give it a spin @zoshua?

mottosso · 2024-02-29T08:37:38Z

.github/workflows/pyside6.yml

+        run: |
+          docker run --rm \
+            -v $(pwd):/Qt.py \
+            -e PYTHON=${{ matrix.PYTHON }} \


This line runs a Docker container, which we would no longer need in this case. Instead, call the ./entrypoint.sh file directly, along with the Python version used.

run: PYTHON=3.11 ./entrypoint.sh

Set PYTHON=3.10 or 3.11, depending on which version of Python ubuntu-latest has. You should probably set it to a specific version of Ubuntu, so we know and that it won't change in the future.

From here, it looks like Ubuntu 22.

https://github.com/mottosso/Qt.py/actions/runs/8088173386/job/22101676573?pr=394#step:1:4

It would be safe to set runs-on to always use Ubuntu 22. That way, we will be made aware of when it is no longer available, a few years from now, and can update accordingly.

FYI, I just had a look: Ubuntu 22 seems to ship with Python 3.10.
(→ source)

martin-chatterjee · 2024-02-29T09:42:55Z

.github/workflows/pyside6.yml

+      - name: pip install PySide6
+        run: |
+          pip install PySide6


Choose pip explicitly, install needed dependencies.

As @mottosso mentioned, these tests will not be run within the Docker container anymore. So you probably also need to install a few more dependency packages here.

You'll probably need to installnose and nosepipe, maybe a few more. (→ You can have a look at the Dockerfile, to see what's needed.)

Also, it might be good to be explicit about the pip/python version that you are using.

So please replace:
(Using Python 3.10 in my example...)

pip install PySide6

with:

python3.10 -m pip install PySide6

martin-chatterjee · 2024-02-29T09:50:04Z

.github/workflows/pyside6.yml

+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            VFXPLATFORM: "2018"
+            PYTHON: "3.6"


I think, the strategy: block can go away.

A strategy: matrix: block is used to execute tests within the Docker container multiples times in a row in run-tests.yml, using different parameters.

→ I think this does not have any use in here, and can be removed.

martin-chatterjee · 2024-02-29T09:55:47Z

.github/workflows/pyside6.yml

+        run: |
+          docker run --rm \
+            -v $(pwd):/Qt.py \
+            -e PYTHON=${{ matrix.PYTHON }} \


FYI, I just had a look: Ubuntu 22 seems to ship with Python 3.10.
(→ source)

removed strategy block updated pip install step updated the run tests step

added step Set entrypoint.sh script permissions

changed nosetests${PYTHON} to python${PYTHON} -m nose

mottosso · 2024-02-29T15:58:42Z

entrypoint.sh

@@ -22,13 +22,13 @@ printf "#\n# Testing implementation..\n"
    python${PYTHON} -u run_tests.py
 printf "#\n# Testing caveats..\n"
    python${PYTHON} build_caveats.py
-    nosetests${PYTHON} \
+    python${PYTHON} -m nose \


nose is oldschool, need to use nose2

updated pip install step to use nose2

updated to use nose2

removed incompatible nose2 command line arguments

more nose2 usage updates

removed: ['QSslCertificate', 'QSslCipher', 'QSslConfiguration', 'QSslError', 'QSslKey', 'QSslSocket', 'QUuid']

… mesa step

…gui libs incrementally

mottosso · 2024-04-06T07:42:40Z

https://github.com/mottosso/Qt.py/pull/394/checks#step:7:94

Only one missing member! That's great.

https://doc.qt.io/qt-6/qregularexpressionvalidator.html

This seems to me like it's been renamed/slightly edited. We could either (1) wrap the Qt 6 class in our own to emulate the one from Qt 4/5. Or we could deprecate it entirely. Wrapping it seems straightforward, but I haven't looked into whether it's used in the same way. And it is useful, I expect we will need it.

Thoughts?

mottosso · 2024-04-06T07:43:39Z

"AttributeError: module 'PySide2.QtCore' has no attribute 'QStringListModel'"

Did you overcome this? Because it does exist in Qt 4/5/6.

https://doc.qt.io/qt-6/qstringlistmodel.html

zoshua · 2024-04-06T14:42:44Z

"AttributeError: module 'PySide2.QtCore' has no attribute 'QStringListModel'"

Did you overcome this? Because it does exist in Qt 4/5/6.

https://doc.qt.io/qt-6/qstringlistmodel.html

I just reverted to what previously existed/worked here in the github Run Tests.

Do you think its related to running our tests in the highly customized docker container?

added QRegularExpressionValidator remap

zoshua · 2024-04-06T15:13:51Z

https://doc.qt.io/qt-6/qregularexpressionvalidator.html

Just checked and it appears that the function signatures match..

https://doc.qt.io/qtforpython-5/PySide2/QtGui/QRegExpValidator.html#PySide2.QtGui.PySide2.QtGui.QRegExpValidator

https://doc.qt.io/qtforpython-6/PySide6/QtGui/QRegularExpressionValidator.html#PySide6.QtGui.PySide6.QtGui.QRegularExpressionValidator

So we should be good to map PySide6 to QRegExpValidator with _misplaced_members

…SON testing

zoshua · 2024-04-06T17:14:19Z

@mottosso
This one appears to be PyQt4 Centric
File "/home/runner/work/Qt.py/Qt.py/examples/loadUi/baseinstance2.py", line 7, in

You think I am good to remove from Pyside6.yml?

…members()

mottosso · 2024-04-07T15:49:33Z

Yes, definitely. Based on explicitly making this only run for PyQt4, https://github.com/mottosso/Qt.py/blob/master/examples/loadUi/baseinstance2.py that seems safe.

Removed python3.10 -m nose2 --verbose examples.loadUi.baseinstance2

mottosso · 2024-04-21T10:06:14Z

Had a look at this, and we've got a bit more work before we can call this drop-in ready for Qt 4 and Qt 5.

QFont.setWeight doesn't take a number anymore, but an enum
QtCore.Qt.MidButton no longer exists for mousePressEvent

Here's one way to solve (1).

diff --git a/Qt.py b/Qt.py
index 08b5c03..00d3571 100644
--- a/Qt.py
+++ b/Qt.py
@@ -1195,6 +1195,9 @@ _compatibility_members = {
             "getOpenFileNames": "QtWidgets.QFileDialog.getOpenFileNames",
             "getSaveFileName": "QtWidgets.QFileDialog.getSaveFileName",
         },
+        "QFont": {
+            "setWeight": "QtGui.QFont.setWeight",
+        },
     },
     "PySide2": {
         "QWidget": {
@@ -1514,8 +1517,38 @@ def _pyside6():
         Qt.QtCompat.setSectionResizeMode = \
             Qt._QtWidgets.QHeaderView.setSectionResizeMode

+    def setWeight(func):
+        def wrapper(self, weight):
+            weight = {
+                100: Qt._QtGui.QFont.Thin,
+                200: Qt._QtGui.QFont.ExtraLight,
+                300: Qt._QtGui.QFont.Light,
+                400: Qt._QtGui.QFont.Normal,
+                500: Qt._QtGui.QFont.Medium,
+                600: Qt._QtGui.QFont.DemiBold,
+                700: Qt._QtGui.QFont.Bold,
+                800: Qt._QtGui.QFont.ExtraBold,
+                900: Qt._QtGui.QFont.Black,
+            }.get(weight, Qt._QtGui.QFont.Normal)
+
+            return func(self, weight)
+
+        wrapper.__doc__ = func.__doc__
+        wrapper.__name__ = func.__name__
+
+        return wrapper
+
+    decorators = {
+        "QFont": {
+            "setWeight": setWeight,
+        }
+    }
+
     _reassign_misplaced_members("PySide6")
-    _build_compatibility_members("PySide6")
+    _build_compatibility_members("PySide6", decorators)


 def _pyside2():

Namely, we provide a new member via QtCompat which requires updates to legacy software.

font = self._window.font()
font.setFamily("Open Sans")
font.setPointSize(8)
Qt.QtCompat.QFont.setWeight(font, 400)

Not ideal, the ideal would be for existing code to require 0 changes. But, we cannot do:

Qt.QtGui.QFont.setWeight = some_wrapper_function

As this would modify the original binding, which is one of the things that sets Qt.py apart from other wrappers. We cannot risk the stability of code that does not use Qt.py.

What options do we have? If we go with the above, then we must provide this member for all bindings, and we should also provide the new enums, e.g. QtCompat.QtGui.QFont.Bold, such that new code can run on old bindings.

Here's one project you can try with.

python -m pip install pyblish-lite

It bundles Qt.py inside of vendor/Qt.py. Replace that with this version and you'll run into the above issues. Can we test with a few project projects to find what else there is? We'll need an upgrade guide in the README with what users are expected to do in order to make their projects compatible with Qt 6. If indeed we cannot find a way to make it transparent.

zoshua · 2024-04-26T16:21:30Z

Thank you for the feedback and insight.

Will be picking this up soon 👍

zoshua · 2024-04-27T16:07:06Z

Investigations...

I made the "Here's one way to solve (1)." tweaks locally to Qt.py and ran our current PySide6 tests without issue.
I created a new space/venv to test pyblish-lite w/ PySide6 and the latest tweaks made from step 1, updating the local vendor/Qt.py.
I encounter and fix some PySide6 _misplaced_members issues
I confirm the QtCore.Qt.MidButton button issue
I hacked a bit with _misplaced_members to see if we could reroute "QtCore.Qt.MiddleButton": "QtCore.Qt.MidButton" with no luck
I hacked a bit further directly tweaking _pyside6() by adding Qt._QtCore.Qt.MidButton = module.QtCore.Qt.MiddleButton, which seems to have made the error go away, however I am sure this is not the appropriate solution. Also, I have not used pyblish before so I am not familiar w/ how it is supposed to function.

Thoughts on next steps?

mottosso · 2024-04-28T08:44:51Z

I hacked a bit further directly tweaking _pyside6() by adding Qt._QtCore.Qt.MidButton = module.QtCore.Qt.MiddleButton, which seems to have made the error go away

This would be the easiest route, but we can't risk affecting applications that use PyQt/PySide without Qt.py, and this approach would affect those.

Thoughts on next steps?

Let's stick with the first approach for now and put it in a "Qt 6 Transition Guide". We need the find a similar solution to MidButton and put that in the guide too. Our goal then should be to make this guide as small as possible.

Qt 6 Transition Guide

Replace font.setWeight(some number) with Qt.QtCompat.QFont.setWeight(font, some number)
Replace event.type == QtCore.MidButton with ...?
And so forth

updated _pyside6() - added QtCompat.QFont.setWeight functionality updated _misplaced_members PySide2 to restore parity with current release. updated _misplaced_members PySide6 to be consistent with PySide2.

zoshua · 2024-05-01T16:44:23Z

Made the suggested updates and added a possible solution for the Mid/Middle Button change.

Confirmed error removal in pyblish-lite by making the following changes in
view.py
from .vendor.Qt import QtCore, QtWidgets, QtCompat

view.py - Item.mousePressEvent()
if event.button() == QtCompat.Qt.MidButton:

mottosso · 2024-05-02T11:38:27Z

Great, thanks for this.

Considering that this PR does not affect existing use of Qt.py, I'll merge this now despite suspecting that there will be a number of bullet points needed for an upgrade guide. I'll add a section to the README now with what we now, then we can continue adding and updating as we continue our discovery. A new release will follow shortly.

Added PySide6 Support

80dc006

zoshua changed the title ~~Added PySide6 Support~~ Added PySide6 Support (squash) Feb 22, 2024

zoshua mentioned this pull request Feb 25, 2024

added PySide6 shiboken6 support - Pt 2 #393

Closed

mottosso mentioned this pull request Feb 25, 2024

Add PySide6 support #367

Open

martin-chatterjee mentioned this pull request Feb 26, 2024

Debug CI test run issues with PR #394. #398

Closed

martin-chatterjee mentioned this pull request Feb 26, 2024

Automatically run CI test jobs for every pull request. #399

Merged

Merge branch 'mottosso:master' into squash

822cac0

Create pyside6.yml

a25cc94

mottosso reviewed Feb 29, 2024

View reviewed changes

martin-chatterjee reviewed Feb 29, 2024

View reviewed changes

zoshua added 3 commits February 29, 2024 08:26

Updated pyside6.yml

55889ed

removed strategy block updated pip install step updated the run tests step

Update pyside6.yml

47ac768

added step Set entrypoint.sh script permissions

Update entrypoint.sh

f993695

changed nosetests${PYTHON} to python${PYTHON} -m nose

mottosso reviewed Feb 29, 2024

View reviewed changes

zoshua added 4 commits February 29, 2024 09:03

Update pyside6.yml

5209c24

updated pip install step to use nose2

Update entrypoint.sh

39c28dd

updated to use nose2

Update entrypoint.sh

c0d64e0

removed incompatible nose2 command line arguments

Update entrypoint.sh

d855ccf

more nose2 usage updates

zoshua added 8 commits April 5, 2024 08:44

Updated _common_members for PySide2

0cea915

removed: ['QSslCertificate', 'QSslCipher', 'QSslConfiguration', 'QSslError', 'QSslKey', 'QSslSocket', 'QUuid']

Updated _common_members for test_caveats.py

7ca0224

Update pyside6.yml - added Install EGL mesa step

af8af75

Update pyside6.yml - Added Install GUI Libs step, Removed Install EGL…

73a6ba4

… mesa step

Update pyside6.yml - Reverting back to Install EGL Mesa step, adding …

42395b6

…gui libs incrementally

Update pyside6.yml - Updated Install GUI libs step

5493aa0

Update pyside6.yml - Testing QT_QPA_PLATFORM=minimal env variable

93ab974

Update pyside6.yml - Added QT_VERBOSE=1 env variable

7351971

Updated _misplaced_members PySide6

d65eaf9

added QRegularExpressionValidator remap

zoshua added 3 commits April 6, 2024 10:34

Updated test_vendoring() to include PySide6 in QT_PREFERRED_BINDING_J…

fed4836

…SON testing

Updated pyside6.yml - Testing examples..

c4b202d

Added PySide6 to QT_PREFERRED_BINDING

e6edaa8

added PySide6 to update_misplaced_members() and update_compatibility_…

3967fe4

…members()

Update pyside6.yml - Testing examples.. Step

66e379b

Removed python3.10 -m nose2 --verbose examples.loadUi.baseinstance2

david-cattermole mentioned this pull request Apr 20, 2024

Build Tools - Support Maya 2025 david-cattermole/mayaMatchMoveSolver#251

Closed

updated _compatibility_members - added QFont.setWeight, Qt.MidButton

25e117d

updated _pyside6() - added QtCompat.QFont.setWeight functionality updated _misplaced_members PySide2 to restore parity with current release. updated _misplaced_members PySide6 to be consistent with PySide2.

mottosso merged commit 5a88175 into mottosso:master May 2, 2024
9 checks passed

mottosso mentioned this pull request May 9, 2024

QStringListModel not available in PySide2 #404

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added PySide6 Support (squash) #394

Added PySide6 Support (squash) #394

zoshua commented Feb 22, 2024

mottosso commented Feb 22, 2024

martin-chatterjee commented Feb 26, 2024

mottosso commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

mottosso commented Feb 26, 2024

mottosso commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

mottosso commented Feb 26, 2024

mottosso commented Feb 27, 2024

mottosso Feb 29, 2024

mottosso Feb 29, 2024

martin-chatterjee Feb 29, 2024

martin-chatterjee Feb 29, 2024

martin-chatterjee Feb 29, 2024

martin-chatterjee Feb 29, 2024

mottosso Feb 29, 2024

zoshua Feb 29, 2024

mottosso commented Apr 6, 2024

mottosso commented Apr 6, 2024

zoshua commented Apr 6, 2024

zoshua commented Apr 6, 2024

zoshua commented Apr 6, 2024

mottosso commented Apr 7, 2024

mottosso commented Apr 21, 2024

zoshua commented Apr 26, 2024

zoshua commented Apr 27, 2024

mottosso commented Apr 28, 2024

zoshua commented May 1, 2024

mottosso commented May 2, 2024

Added PySide6 Support (squash) #394

Added PySide6 Support (squash) #394

Conversation

zoshua commented Feb 22, 2024

mottosso commented Feb 22, 2024

martin-chatterjee commented Feb 26, 2024

For reference, here's what I did:

1. Add @zoshua's Qt.py fork as a remote, and fetch:

2. Create new branch review-zoshua-pyside6 off of master, and push:

3. Bring in @zoshua's work out of branch squash, and un-stage it:

4. Commit changes bit by bit, and push on every commit:

mottosso commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

mottosso commented Feb 26, 2024

mottosso commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

martin-chatterjee commented Feb 26, 2024

→ PR #399

mottosso commented Feb 26, 2024

mottosso commented Feb 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose pip explicitly, install needed dependencies.

Choose a reason for hiding this comment

I think, the strategy: block can go away.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mottosso commented Apr 6, 2024

mottosso commented Apr 6, 2024

zoshua commented Apr 6, 2024

zoshua commented Apr 6, 2024

zoshua commented Apr 6, 2024

mottosso commented Apr 7, 2024

mottosso commented Apr 21, 2024

zoshua commented Apr 26, 2024

zoshua commented Apr 27, 2024

mottosso commented Apr 28, 2024

Qt 6 Transition Guide

zoshua commented May 1, 2024

mottosso commented May 2, 2024

2. Create new branch `review-zoshua-pyside6` off of `master`, and push:

3. Bring in @zoshua's work out of branch `squash`, and un-stage it:

Choose `pip` explicitly, install needed dependencies.

I think, the `strategy:` block can go away.