pytest-qt is a
pytest plugin that allows programmers to write tests
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:
.. code-block:: python
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!"
.. _PySide2: https://pypi.org/project/PySide2/ .. _PySide6: https://pypi.org/project/PySide6/ .. _PyQt5: https://pypi.org/project/PyQt5/ .. _PyQt6: https://pypi.org/project/PyQt6/ .. _pytest: http://pytest.org
This allows you to test and make sure your view layer is behaving the way you expect after each code change.
.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pytest-qt.svg :target: https://anaconda.org/conda-forge/pytest-qt
.. |coverage| image:: http://img.shields.io/coveralls/pytest-dev/pytest-qt.svg :target: https://coveralls.io/r/pytest-dev/pytest-qt
.. |docs| image:: https://readthedocs.org/projects/pytest-qt/badge/?version=latest :target: https://pytest-qt.readthedocs.io
.. |python| image:: https://img.shields.io/pypi/pyversions/pytest-qt.svg :target: https://pypi.python.org/pypi/pytest-qt/ :alt: Supported Python versions
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black
|python| |version| |conda-forge| |ci| |coverage| |docs| |black|
qtbot_ fixture to simulate user interaction with
Automatic capture_ of
Exceptions in virtual methods and slots_ are automatically captured and fail tests accordingly.
.. _qtbot: https://pytest-qt.readthedocs.io/en/latest/reference.html#module-pytestqt.qtbot .. _Automatic capture: https://pytest-qt.readthedocs.io/en/latest/logging.html .. _waitSignal: https://pytest-qt.readthedocs.io/en/latest/signals.html .. _waitSignals: https://pytest-qt.readthedocs.io/en/latest/signals.html .. _Exceptions in virtual methods and slots: https://pytest-qt.readthedocs.io/en/latest/virtual_methods.html
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:
To force a particular API, set the configuration variable
qt_api in your
pytest.ini file to
pyqt6 or `
.. code-block:: ini
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_.
.. _Read The Docs: https://pytest-qt.readthedocs.io
Please consult the
.. _changelog page: https://pytest-qt.readthedocs.io/en/latest/changelog.html
Please report any issues or feature requests in the
.. _issue tracker: https://github.com/pytest-dev/pytest-qt/issues
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 -e py37-pyside2,py37-pyqt5
pytest-qt is formatted using
black <https://github.com/ambv/black> and uses
pre-commit <https://github.com/pre-commit/pre-commit> for linting checks before commits. You
pre-commit locally with::
$ pip install pre-commit $ pre-commit install
pytest-xvfb <https://github.com/The-Compiler/pytest-xvfb/>_ allows to run a virtual xserver (Xvfb) on Linux to avoid GUI elements popping up on the screen or for easy CI testing
pytest-qml <https://github.com/jgirardet/pytest-qml>_ allows running QML tests from pytest
Many thanks to:
.. |pycharm| image:: https://www.jetbrains.com/pycharm/docs/logo_pycharm.png :target: https://www.jetbrains.com/pycharm
.. _tox: https://tox.readthedocs.io