pytest-qt is a pytest plugin that allows programmers to write tests for PyQt5, PyQt6, PySide2 and PySide6 applications.
The main usage is to use the qtbot
fixture, responsible for handling qApp
creation as needed and provides methods to simulate user interaction,
like key presses and mouse clicks:
def test_hello(qtbot):
widget = HelloWidget()
qtbot.addWidget(widget)
# click in the Greet button and make sure it updates the appropriate label
qtbot.mouseClick(widget.button_greet, qt_api.QtCore.Qt.MouseButton.LeftButton)
assert widget.greet_label.text() == "Hello!"
This allows you to test and make sure your view layer is behaving the way you expect after each code change.
- qtbot fixture to simulate user interaction with
Qt
widgets. - Automatic capture of
qDebug
,qWarning
andqCritical
messages; - waitSignal and waitSignals functions to block test execution until specific signals are emitted.
- Exceptions in virtual methods and slots are automatically captured and fail tests accordingly.
Since version 4.1.0, pytest-qt
requires Python 3.7+.
Works with either PySide6, PySide2, PyQt6 or PyQt5.
If any of the above libraries is already imported by the time the tests execute, that library will be used.
If not, pytest-qt will try to import and use the Qt APIs, in this order:
PySide6
PySide2
PyQt6
PyQt5
To force a particular API, set the configuration variable qt_api
in your pytest.ini
file to
pyside6
, pyside2
, pyqt6
or pyqt5
:
[pytest]
qt_api=pyqt5
Alternatively, you can set the PYTEST_QT_API
environment
variable to the same values described above (the environment variable wins over the configuration
if both are set).
Full documentation and tutorial available at Read the Docs.
Please consult the changelog page.
Please report any issues or feature requests in the issue tracker.
Contributions are welcome, so feel free to submit a bug or feature request.
Pull requests are highly appreciated! If you can, include some tests that exercise the new code or test that a bug has been fixed, and make sure to include yourself in the contributors list. :)
To prepare your environment, create a virtual environment and install pytest-qt
in editable mode with dev
extras:
$ pip install --editable .[dev]
After that install pre-commit
for pre-commit checks:
$ pre-commit install
Tests are run using tox:
$ tox -e py37-pyside2,py37-pyqt5
pytest-qt
is formatted using black and uses
pre-commit for linting checks before commits. You
can install pre-commit
locally with:
$ pip install pre-commit $ pre-commit install
- pytest-xvfb allows to run a virtual xserver (Xvfb) on Linux to avoid GUI elements popping up on the screen or for easy CI testing
- pytest-qml allows running QML tests from pytest
Many thanks to:
- Igor T. Ghisi (@itghisi);
- John David Reaver (@jdreaver);
- Benjamin Hedrich (@bh);
- Benjamin Audren (@baudren);
- Fabio Zadrozny (@fabioz);
- Datalyze Solutions (@datalyze-solutions);
- Florian Bruhin (@The-Compiler);
- Guilherme Quentel Melo (@gqmelo);
- Francesco Montesano (@montefra);
- Roman Yurchak (@rth)
- Christian Karl (@karlch)
Powered by