python_qt_binding

This stack provides Python bindings for Qt. There are two providers: pyside and pyqt. PySide2 is available under the GPL, LGPL and a commercial license. PyQt is released under the GPL.

Both the bindings and tools to build bindings are included from each available provider. For PySide, it is called “Shiboken”. For PyQt, this is called “SIP”.

Also provided is adapter code to make the user’s Python code independent of which binding provider was actually used.

Contributing

For ROS 2 changes, please open pull requests on the branch main. For ROS 1 changes, please open pull requests on the melodic-devel branch. If you would like changes made to older ROS distro branches, backporting will be considered once the changes are made to the latest branch. Changes will only be made to active ROS Distros.

Branches

The branches on this repo are for different ROS distros.

• main - ROS Rolling
• galactic_devel - ROS Galactic
• crystal-devel - ROS Foxy, ROS Eloquent, ROS Dashing, ROS Crystal
• melodic-devel - ROS Noetic, ROS Melodic
• kinetic-devel - ROS Lunar, ROS Kinetic
• groovy-devel - ROS Jade, ROS Indigo, ROS Hydro, ROS Groovy
• fuerte-devel - ROS Fuerte

Changelog for package python_qt_binding

2.3.1 (2024-06-25)

• Skip running the tests on Windows Debug. (#142)
• Contributors: Chris Lalancette

2.3.0 (2024-04-26)

• Only suppress Python warnings on new enough CMake (#139)
  • Older CMake doesn't have the policy, so skip it there.
• Suppress warning from Shiboken2. (#137) The comment has more information on why we are doing this.
• Contributors: Alejandro Hernández Cordero, Chris Lalancette

2.2.0 (2024-03-28)

• Switch to C++17 for SIP and Shiboken (#135)
• Set hints to find the python version we actually want. (#134)
• Contributors: Chris Lalancette, Christophe Bedard

2.1.1 (2024-02-07)

• Remove unnecessary parentheses around assert. (#133)
• Contributors: Chris Lalancette

2.1.0 (2024-01-24)

• Switch to FindPython3 in the shiboken_helper.cmake. (#132)
• Contributors: Chris Lalancette

2.0.0 (2023-12-26)

• Cleanup of the sip_configure.py file. (#131)
• Update the SIP support so we can deal with a broken RHEL-9. (#129)
• Contributors: Chris Lalancette

1.3.0 (2023-04-28)

1.2.3 (2023-04-11)

• Fix to allow ninja to use make for generators (#123)
• Fix flake8 linter regression (#125)
• Remove pyqt from default binding order for macOS (#118)
• Contributors: Christoph Hellmann Santos, Cristóbal Arroyo, Michael Carroll, Rhys Mainwaring

1.2.2 (2023-02-24)

• Demote missing SIP message from WARNING to STATUS (#122)
• Contributors: Scott K Logan

1.2.1 (2023-02-14)

• [rolling] Update maintainers - 2022-11-07 (#120)
• Contributors: Audrow Nash

1.2.0 (2022-05-10)

1.1.1 (2021-12-06)

• Replace PythonInterp to Python3 COMPONENTS (#108)
• Use PyQt5 module path to find SIP bindings (#106)
• Contributors: Ben Wolsieffer, Homalozoa X

1.1.0 (2021-11-02)

• Make FindPythonInterp dependency explicit (#107)
• Add note about galactic branch (#104)
• fuerte-devel is too new for ROS Electric (#101)
• Contributors: Shane Loretz

1.0.7 (2021-03-18)

• Add repo README
• Shorten some long lines of CMake (#99)
• Contributors: Scott K Logan, Shane Loretz

1.0.6 (2021-01-25)

• Update maintainers (#96) (#98)
• Add pytest.ini so local tests don't display warning (#93)
• Contributors: Chris Lalancette, Shane Loretz

1.0.5 (2020-05-26)

• allow a list of INCLUDE_PATH (#92)
• Use magic $(MAKE) variable to suppress build warning (#91)
• Fix linking with non framework builds of qt (e.g. from conda-forge) (#84)
• Contributors: Anton Matosov, Dirk Thomas, Robert Haschke

1.0.4 (2020-05-05)

• remove obsolete function used for backward compatibility (#88)
• disable Shiboken with CMake < 3.14 (#87)
• fix case of CMake function (#86)
• restore QUIET which was reverted in #79
• use PySide2 and Shiboken2 targets for variables (#79)
• Contributors: Dirk Thomas, Hermann von Kleist

1.0.3 (2019-11-12)

• check if Shiboken2Config.cmake defines a target instead of a variable (#77)

1.0.2 (2019-09-30)

• replace Qt variable in generated Makefile (#64)
• don't add -l prefix if it already exists (#59)
• if present, use the sipconfig suggested sip program (#70)
• replace Qt variable in generated Makefile (#64) (#67)
• fixing trivial accidental string concatenation (#66)

1.0.1 (2018-12-11)

• no warnings for unavailable PySide/Shiboken (#58)

1.0.0 (2018-12-10)

• check for Homebrew's PyQt5 install path (#57)
• port to Windows (#56)
• fix lint tests (#55)
• update sip_configure to handle improper lib names (#54)
• port to ROS 2 (#52)
• autopep8 (#51)
• remove :: from shiboken include path (#48)

0.3.4 (2018-08-03)

• add support for additional Qt5 modules (#45)

0.3.3 (2017-10-25)

• Prefer qmake-qt5 over qmake when available (#43)

0.3.2 (2017-01-23)

• Fix problems on OS X (#40)

0.3.1 (2016-04-21)

• support for the Qt 5 modules QtWebEngine and QtWebKitWidgets (#37)

0.3.0 (2016-04-01)

• switch to Qt5 (#30)
• print full stacktrace

0.2.18 (2016-03-17)

• remove LGPL and GPL from licenses, all code is BSD (#27)

0.2.17 (2015-09-19)

• change import order of builtins to work when the 'future' package is installed in Python 2 (#24)

0.2.16 (2015-05-04)

• use qmake with QT_SELECT since qmake-qt4 is not available on all platforms (#22)

0.2.15 (2015-04-23)

• support PyQt4.11 and higher when built with configure-ng.py (#13)
• __builtin__ became builtins in Python 3 (#16)

0.2.14 (2014-07-10)

• add Python_ADDITIONAL_VERSIONS and ask for specific version of PythonInterp
• fix finding specific version of PythonLibs with CMake 3 (#11)
• fix sip_helper to use python header dirs on OS X (#12)

0.2.13 (2014-05-07)

• fix sip arguments when path contains spaces

0.2.12 (2014-01-08)

• python 3 compatibility
• fix sip bindings when paths contain spaces (#9)

0.2.11 (2013-08-21)

• allow overriding binding order
• allow to release python_qt_binding as a standalone package to PyPI (#5)

0.2.10 (2013-06-06)

• refactor loadUi function to be documentable (#2)

0.2.9 (2013-04-19)

0.2.8 (2013-01-13)

0.2.7 (2012-12-21)

• first public release for Groovy