PR: Choose Qt binding to install from SPYDER_QT_BINDING environment variable

[dpizetta]

Description of Changes

• Wrote at least one-line docstrings (for any new functions)
• Added unit test(s) covering the changes (if testable)

• Included a screenshot or animation (if affecting the UI, see Licecap)

This is a proposal to allow the user to choose the Qt binding to be installed when installing with PIP.

for example using PyQt6 (or PySide6 in the future).

Since the we could not rely on having other imports other thanstdlibavailable on setup.py when building and installing, we could not test if there is a binding already installed. For example, we could use QtPy to identify which one was installed, including it to setup_requires, and asking for qtpy.QT_API. But, also without success.
After testing some other ways to do that, I have implemented this version that checks the SPYDER_QT_BINDING environment variable to proper set the requirement during installation.

We can use like this:

SPYDER_QT_BINDING='pyqt6' pip install spyder

This is also compatible with test environments, where you can set the variable.

Not sure if this useful for conda also, I'm not familiar with it.

I want to hear from you guys, let me know your thoughts.

Links related to setup imports:

• [BUG] ModuleNotFoundError when importing additional local scripts in setup.py pypa/setuptools#3939
• https://peps.python.org/pep-0517/
• ModuleNotFound when using pip install -e . and setup.py uses additional third party packages pypa/pip#12030

Issue(s) Resolved

Part of #20201

Affirmation

By submitting this Pull Request or typing my (user)name below,
I affirm the Developer Certificate of Origin
with respect to all commits and content included in this PR,
and understand I am releasing the same under Spyder's MIT (Expat) license.

I certify the above statement is true and correct: dpizetta

[pep8speaks]

Hello @dpizetta! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file setup.py:

Line 150:27: E221 multiple spaces before operator

Comment last updated at 2024-12-02 16:48:07 UTC

[rear1019]

This is a proposal to allow the user to choose the Qt binding to be installed when installing with PIP.

This is something I thought about as well while working on PR #23118. I really like the proposal: Things work by default, users have the option to chose a binding and only a single binding is installed. Other options I came up with have drawbacks:

• Adding a pyside2/pyqt6/pyside6 section to extra_require while leaving pyqt5 in install_requires: Two bindings are installed.
• Remove Qt bindings from install_requires and let the packager/end-user handle the installation of a binding (as mentioned here [1]): Not user-friendly.

[1] #20201 (comment)

[ccordoba12]

Thanks for your work on this @dpizetta! Some small suggestions for you, the rest looks good to me.

Also, do you need help to fix the failing test?

[dpizetta]

Thank you for taking a look! It should be OK after these changes. I may need some help with the AST errors. Thanks

[ccordoba12]

Looks good to me now, thanks @dpizetta!

[ccordoba12]

@meeseeksdev please backport to 6.x