Skip to main content

pytest support for PyQt and PySide applications

Project description

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

Supported Python versions version conda-forge ci coverage docs black

Features

Requirements

Since version 4.0.0, pytest-qt requires Python 3.6+.

Works with either PySide6, PySide2, PyQt6 or PyQt5, picking whichever is available on the system, giving preference to the first one installed in this order:

  • PySide6
  • PySide2
  • PyQt6
  • PyQt5

To force a particular API, set the configuration variable qt_api in your pytest.ini file to pyqt6, 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).

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

Contributors

Many thanks to:

Powered by

pycharm

pydev

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-qt, version 4.0.2
Filename, size File type Python version Upload date Hashes
Filename, size pytest_qt-4.0.2-py2.py3-none-any.whl (33.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pytest-qt-4.0.2.tar.gz (113.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page