Skip to main content
Help us improve Python packaging – donate today!

pytest support for PyQt and PySide applications

Project Description

pytest-qt is a pytest plugin that allows programmers to write tests for PySide, PySide2 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.

Supported Python versions version anaconda travis appveyor coverage docs

Features

Requirements

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

  • PySide2
  • PyQt5
  • PySide
  • PyQt4

To force a particular API, set the configuration variable qt_api in your pytest.ini file to pyqt5, pyside, pyside2, 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:

Powered by

pycharm

pydev

Release history Release notifications

This version
History Node

2.3.1

History Node

2.3.0

History Node

2.2.1

History Node

2.2.0

History Node

2.1.2

History Node

2.1.1

History Node

2.1.0

History Node

2.0.0

History Node

1.11.0

History Node

1.10.0

History Node

1.9.0

History Node

1.8.0

History Node

1.7.0

History Node

1.6.0

History Node

1.5.1

History Node

1.5.0

History Node

1.4.0

History Node

1.3.0

History Node

1.2.3

History Node

1.2.2

History Node

1.2.1

History Node

1.2.0

History Node

1.2.0-rc.1

History Node

1.1.1

History Node

1.1

History Node

1.0.2

History Node

1.0.1

History Node

1.0

History Node

0.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pytest_qt-2.3.1-py2.py3-none-any.whl (34.7 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jan 5, 2018
pytest-qt-2.3.1.tar.gz (108.4 kB) Copy SHA256 hash SHA256 Source None Jan 5, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page