pytest-qt

pytest-qt is a pytest plugin that allows programmers to write tests for PySide and PyQt 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, QtCore.Qt.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 PySide or PyQt (PyQt5 and PyQt4) picking whichever is available on the system, giving preference to the first one installed in this order:

PyQt5
PySide
PyQt4

To force a particular API, set the configuration variable qt_api in your pytest.ini file to pyqt5, pyside, pyqt4 or pyqt4v2. pyqt4v2 sets the PyQt4 API to version 2.

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

Running tests

Tests are run using tox. The simplest way to test is with PySide, as it is available on pip and can be installed by tox automatically:

$ tox -e py34-pyside,py27-pyside,docs

If you want to test against PyQt, install it into your global python installation and use the py27-pyqt4, py34-pyqt4 or py34-pyqt5 testing environments, and tox will copy the appropriate files into its virtual environments to ensure isolation.

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

montefra/pytest-qt