The main usage is to use the
qtbot fixture, responsible for handling
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.
- qtbot fixture to simulate user interaction with
- Automatic capture of
- 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.
Since version 4.0.0,
pytest-qt requires Python 3.6+.
To force a particular API, set the configuration variable
qt_api in your
pytest.ini file to
Alternatively, you can set the
variable to the same values described above (the environment variable wins over the configuration
if both are set).
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. :)
To prepare your environment, create a virtual environment and install
pytest-qt in editable mode with
$ pip install --editable .[dev]
After that install
pre-commit for pre-commit checks:
$ pre-commit install
Tests are run using tox:
$ tox -e py37-pyside2,py37-pyqt5
$ pip install pre-commit $ pre-commit install
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)