pytest-qt

pytest-qt is a pytest plugin that allows programmers to write tests for PyQt5, PyQt6, 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.

Features

qtbot fixture to simulate user interaction with Qt widgets.
Automatic capture of qDebug, qWarning and qCritical 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.

Requirements

Works with either PySide6, 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
PyQt6
PyQt5

To force a particular API, set the configuration variable qt_api in your pytest.ini file to pyside6, pyqt6 or pyqt5:

[pytest]
qt_api=pyqt6

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).

Documentation

Full documentation and tutorial available at Read the Docs.

Change Log

Please consult the changelog page.

Bugs/Requests

Please report any issues or feature requests in the issue tracker.

Contributing

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

Running tests

Tests are run using tox:

$ tox -e py-pyside6,py-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

Contributors

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

Release files for pytest-qt 4.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytest-qt 4.5.0
File	Size	Uploaded
pytest_qt-4.5.0.tar.gz	128.7 kB	Jul 1, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for pytest-qt 4.5.0
File	Interpreter	ABI	Platform	Reset
pytest_qt-4.5.0-py3-none-any.whl 37.2 kB Jul 1, 2025	Python 3	none	any	Details

Total release size: 165.9 kB

Release files / pytest_qt-4.5.0.tar.gz

Download URL	pytest_qt-4.5.0.tar.gz
Size	128.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`51620e01c488f065d2036425cbc1cbcf8a6972295105fd285321eb47e66a319f`
BLAKE2b-256 checksum How to use checksums	`d3618bdec02663c18bf5016709b909411dce04a868710477dc9b9844ffcf8dd2`
Upload date	Jul 1, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.8`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/pytest-dev/pytest-qt
Publishing commit: github.com/pytest-dev/pytest-qt/tree/372ab6853bdbecea0883d5486409dcaa16062eba

Workflow

Publishing configuration: github.com/pytest-dev/pytest-qt/blob/372ab6853bdbecea0883d5486409dcaa16062eba/.github/workflows/deploy.yml
Publishing logs: github.com/pytest-dev/pytest-qt/actions/runs/16006017010/attempts/1

Artifact

Subject: pytest_qt-4.5.0.tar.gz
SHA-256 checksum: 51620e01c488f065d2036425cbc1cbcf8a6972295105fd285321eb47e66a319f Verifying attestations

Release files / pytest_qt-4.5.0-py3-none-any.whl

Download URL	pytest_qt-4.5.0-py3-none-any.whl
Size	37.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ed21ea9b861247f7d18090a26bfbda8fb51d7a8a7b6f776157426ff2ccf26eff`
BLAKE2b-256 checksum How to use checksums	`ccd08339b888ad64a3d4e508fed8245a402b503846e1972c10ad60955883dcbb`
Upload date	Jul 1, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.8`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/pytest-dev/pytest-qt
Publishing commit: github.com/pytest-dev/pytest-qt/tree/372ab6853bdbecea0883d5486409dcaa16062eba

Workflow

Publishing configuration: github.com/pytest-dev/pytest-qt/blob/372ab6853bdbecea0883d5486409dcaa16062eba/.github/workflows/deploy.yml
Publishing logs: github.com/pytest-dev/pytest-qt/actions/runs/16006017010/attempts/1

Artifact

Subject: pytest_qt-4.5.0-py3-none-any.whl
SHA-256 checksum: ed21ea9b861247f7d18090a26bfbda8fb51d7a8a7b6f776157426ff2ccf26eff Verifying attestations