Provides an abstraction layer on top of the various Qt bindings (PyQt5/6 and PySide2/6).
QtPy: Abstraction layer for PyQt5/PySide2/PyQt6/PySide6
Copyright © 2009–2022 The Spyder Development Team
QtPy is a small abstraction layer that lets you write applications using a single API call to either PyQt or PySide.
It provides support for PyQt5, PyQt6, PySide6, PySide2 using the Qt5 layout (where the QtGui module has been split into QtGui and QtWidgets).
Basically, you can write your code as if you were using PyQt or PySide directly,
but import Qt modules from
qtpy instead of
Accordingly, when porting code between different Qt bindings (PyQt vs PySide) or Qt versions (Qt5 vs Qt6), QtPy makes this much more painless, and allows you to easily and incrementally transition between them. QtPy handles incompatibilities and differences between bindings or Qt versions for you while keeping your project running, so you can focus more on your own code and less on keeping track of supporting every Qt version and binding. Furthermore, when you do want to upgrade or support new bindings, it allows you to update your project module by module rather than all at once. You can check out examples of this approach in projects using QtPy, like git-cola.
Attribution and acknowledgments
pyqode.qt this is not a namespace package, so it is not tied
to a particular project or namespace.
This project is released under the MIT license.
You need PyQt5, PySide2, PyQt6 or PySide6 installed in your system to make use
of QtPy. If several of these packages are found, PyQt5 is used by
default unless you set the
QT_API environment variable.
QT_API can take the following values:
pyqt5(to use PyQt5).
pyside2(to use PySide2).
pyqt6(to use PyQt6).
pyside6(to use PySide6).
Module aliases and constants
QtCore.pyqtProperty(available on PyQt5/6) are instead exposed as
QtCore.Property, respectively, following the Qt5 module layout.
The Qt version being used can be checked with
QtCore.QT_VERSION_STR) as well as from
For PyQt6 enums, unscoped enum access was added by promoting the enums of the
Compatibility is added between the
QtOpenGLmodules for the
To check the current binding version, you can use
qtpy.PYSIDE_VERSIONfor PySide2/6 and
qtpy.PYQT_VERSIONfor PyQt5/6. If the respective binding is not being used, the value of its attribute will be
To check the current selected binding, you can use
There are boolean values to check if Qt5/6, PyQt5/6 or PySide2/6 are being used:
Trueif currently being used,
qtpy.compat module, you can find wrappers for
QFileDialog static methods and SIP/Shiboken functions, such as:
pip install qtpy
conda install qtpy
Type checker integration
A Command Line Interface (CLI) is offered to help with usage of QtPy. Presently, its only feature is to generate command line arguments for Mypy that will enable it to process the QtPy source files with the same API as QtPy itself would have selected.
If you run
QtPy will output a string of Mypy CLI args that will reflect the currently selected Qt API. For example, in an environment where PyQt5 is installed and selected (or the default fallback, if no binding can be found in the environment), this would output the following:
--always-true=PYQT5 --always-false=PYSIDE2 --always-false=PYQT6 --always-false=PYSIDE6
Using Bash or a similar shell, this can be injected into the Mypy command line invocation as follows:
mypy --package mypackage $(qtpy mypy-args)
For Pyright support and other usage notes, see this comment.
Everyone is welcome to contribute!
QtPy is funded thanks to the generous support of
and the donations we have received from our users around the world through Open Collective:
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.