Introduction

pytest-qt is a pytest plugin that provides fixtures to help programmers write tests for PySide and PyQt.

The main usage is to use the qtbot fixture, which 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!'

Requirements

Python 2.7 or later, including Python 3+.

Requires pytest version 2.7 or later.

Works with either PySide, PyQt4 or 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, pyqt4v2 or pyqt5. pyqt4v2 sets the PyQt4 API to version 2

Installation

The package may be installed by running:

pip install pytest-qt

Or alternatively, download the package from pypi, extract and execute:

python setup.py install

Both methods will automatically register it for usage in py.test.

Development

If you intend to develop pytest-qt itself, use virtualenv to activate a new fresh environment and execute:

git clone https://github.com/pytest-dev/pytest-qt.git
cd pytest-qt
python setup.py develop
pip install pyside # or pyqt4/pyqt5

Versioning

This projects follows semantic versioning.