Differences Between PySide and PyQt
Attention: a port of PySide to Qt 5.x started in 2014, the progress and more details about this project can be found under PySide 2
- 1 API differences
- 1.1 Different import name (PySide instead of PyQt4)
- 1.2 PySide only supports PyQt's "API 2" (PSEP 101)
- 1.3 New-style signals and slots use slightly different syntax (PSEP 100)
- 1.4 Declaring Qt Properties is done using a slightly different syntax (PSEP 103)
- 1.5 Tool names different
- 1.6 Property Names
- 1.7 QThreads
- 2 Differences in the functionality of the bindings
- 2.1 Bindings for functions deprecated before Qt 4.5 are not generated
- 2.2 sender() method returns None when used within a partial or a lambda
- 2.3 When inheriting classes, parent class constructors need to be always called
- 2.4 Old style signals need use of parentheses
- 2.5 Only signals without arguments can be auto connected on constructor.
- 3 Supporting Both APIs
- 4 Converting PyQt4 code to PySide
Different import name (PySide instead of PyQt4)
PySide uses a different library name than PyQt. Instead of typing:
from PyQt4.QtCore import *
you have to do the following:
from PySide.QtCore import *
PySide only supports PyQt's "API 2" (PSEP 101)
PyQt provides two different APIs, the first of which provides QStrings, QVariants, etc as is in Python. The new API 2 provides automatic conversion between the Qt classes and respective native Python datatypes and is much more Pythonic in nature. PyQt on Python 2.x defaults to API 1, while PyQt on Python 3 defaults to API 2.
PySide only supports PyQt's API 2 (see PSEP 101) for details. Therefore Qt classes such as QStrings, QStringLists, and QVariants are not available on PySide. Instead, you should simply use native Python datatypes.
If you're porting code from PyQt, you might want to first modify the PyQt code to use API 2 (using a sip.setapi(class,ver) call before importing PyQt4), and only after getting that change working, change the imports to use PySide instead.
NB: Due to the API change, QFileDialog.getOpenFileName returns a tuple in PySide, which often is an issue when porting code from PyQt. See e.g. bug 343.
New-style signals and slots use slightly different syntax (PSEP 100)
PyQt unfortunately uses an implementation-specific naming scheme for its new-style signal and slot classes:
- Define a new signal called 'trigger' that has no arguments.
trigger = QtCore.pyqtSignal()
As described in PSEP 100, use QtCore.Signal() and QtCore.Slot() instead.
If you want to modify your PyQt code to use the PySide naming scheme, that can be done using a simple definition:
QtCore.Signal = QtCore.pyqtSignal
QtCore.Slot = QtCore.pyqtSlot
Declaring Qt Properties is done using a slightly different syntax (PSEP 103)
As with the signal/slot syntax change above, declaring Qt Properties is done using QtCore. Property instead of QtCore.pyqtProperty (see PSEP 103).
Tool names different
PySide uses different names for the tools scripts:
- pyuic4 -> pyside-uic
- pyrcc4-> pyside-rcc
- pylupdate4 -> pyside-lupdate
PySide uses connect and event in the QObject. Do not use these for anything in your code, and when moving code from PyQt look for any that exist.
In PySide you should .wait() on a thread after calling .stop() if you are quitting the application. Otherwise you may receive
QThread: Destroyed while thread is still running Segmentation fault
Differences in the functionality of the bindings
Bindings for functions deprecated before Qt 4.5 are not generated
Bindings for functions deprecated before Qt 4.5 are not generated in PySide.
If a function is not present in PySide, check the Qt Online Reference Documentation and see whether the function has been deprecated and what to use instead.
Example bug: bug 359
For example, this affects functions such as QColor.dark() and QColor.light(), instead of which QColor.darker() and QColor.lighter() need to be used.
sender() method returns None when used within a partial or a lambda
If a lambda is used as a slot, sender() cannot be used to acquire the object that emitted the signal. This works in PyQt, but their implementation behaves incorrectly in certain situations. See bug 344 for details.
When inheriting classes, parent class constructors need to be always called
PyQt in some cases allows code such as:
def init(self, parent=None): super(QtGui.QWidget, self).init(parent) […]
in which the direct parent class constructor is not called. PySide expects you to do the right thing:
def init(self, parent=None): super(Window, self).init(parent) […]
Old style signals need use of parentheses
PyQt allows the use of short-circuit signals without parentheses such as:
self.emit(SIGNAL ('text_changed_cb'), text)
Since this is an old and deprecated feature, and the effort to fix this is not worth it, we decided to not implement it. In PySide code you need to use something like:
self.emit(SIGNAL ('text_changed_cb(QString)'), text)
You can check the complete discussion on bug #314
Only signals without arguments can be auto connected on constructor.
If you use:
action = QtGui.QAction(None, triggered=handler)
The triggered() signal will be connected to the slot handler instead of the triggered(bool) signal.
Supporting Both APIs
qt_compat.py is an example of centralizing the knowledge of PySide and PyQt without using monkey-patching. It serves both to point out what differences exist as well as keeping your code binding-agnostic. This is important for when needing to support both bindings, usually when transitioning from one to the other and needing to continue to support older distributions that do not yet come with PySide.
python_qt_binding is a Python package from the ROS middleware which gives a more extensive example of how to keep your code agnostic of the actual Python-Qt binding used. It offers a very transparent abstraction, allowing you to write standard import lines like from python_qt_binding.QtCore import QObject Furthermore it provides a substitute loadUi function for simple loading of ui files that work the same with both bindings. For usage examples see rqt_gui