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(window.button_greet, QtCore.Qt.LeftButton)

    assert window.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.

Python 2.6 or later, including Python 3+.

Works with either PySide, PyQt (PyQt4 and PyQt5) picking whichever is available on the system, giving preference to the first one installed in this order:

• PySide
• PyQt4
• PyQt5

To force a particular API, set the environment variable PYTEST_QT_API to pyside, pyqt4 or pyqt5.

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

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

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.

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

Powered by