A pytest plugin for testing QGIS python plugins
A pytest plugin for testing QGIS python plugins.
This plugin makes it easier to write QGIS plugin tests with the help of some fixtures and hooks:
qgis_appreturns and eventually exits fully configured
QgsApplication. This fixture is called automatically on the start of pytest session.
QgisBot, which holds common utility methods for interacting with QGIS.
qgis_parentreturns the QWidget used as parent of the
qgis_new_projectmakes sure that all the map layers and configurations are removed. This should be used with tests that add stuff to
qgis_processinginitializes the processing framework. This can be used when testing code that calls
qgis_versionreturns QGIS version number as integer.
qgis_world_map_geopackagereturns Path to the world_map.gpkg that ships with QGIS
qgis_countries_layerreturns Natural Earth countries layer from world.map.gpkg as QgsVectorLayer
qgis_show_maplets developer inspect the QGIS map visually during the test and also at the teardown of the test. Full signature of the marker is:
@pytest.mark.qgis_show_map(timeout: int = 30, add_basemap: bool = False, zoom_to_common_extent: bool = True, extent: QgsRectangle = None)
timeoutis the time in seconds until the map is closed. If timeout is zero, the map will be closed in teardown.
add_basemapwhen set to True, adds Natural Earth countries layer as the basemap for the map.
zoom_to_common_extentwhen set to True, centers the map around all layers in the project.
extentis alternative to
zoom_to_common_extentand lets user specify the extent as
pytest_configurehook is used to initialize and configure
QgsApplication. With QGIS >= 3.18 it is also used to patch
Be careful not to import modules importing
qgis.utils.ifacein the root of conftest, because the
pytest_configurehook has not yet patched
ifacein that point. See this issue for details.
pytest_runtest_teardownhook is used to ensure that all layer fixtures of any scope are cleaned properly without causing segmentation faults. The layer fixtures that are cleaned automatically must have some of the following keywords in their name: "layer", "lyr", "raster", "rast", "tif".
Command line options
--qgis_disable_guican be used to disable graphical user interface in tests. This speeds up the tests that use Qt widgets of the plugin.
--qgis_disable_initcan be used to prevent QGIS (QgsApplication) from initializing. Mainly used in internal testing.
qgis_qui_enabledwhether the QUI will be visible or not. Defaults to
True. Command line option
--qgis_disable_guiwill override this.
qgis_canvas_widthwidth of the QGIS canvas in pixels. Defaults to 600.
qgis_canvas_heightheight of the QGIS canvas in pixels. Defaults to 600.
Class to hold common utility methods for interacting with QGIS. Check test_qgis_bot.py for usage examples. Here are some of the methods:
create_feature_with_attribute_dialogmethod can be used to create a feature with default values using QgsAttributeDialog. This ensures that all the default values are honored and for example boolean fields are either true or false, not null.
get_qgs_attribute_dialog_widgets_by_namefunction can be used to get dictionary of the
QgsAttributeDialogwidgets. Check the test test_qgis_ui.py::test_attribute_dialog_change for a usage example.
This pytest plugin requires QGIS >= 3.16 to work though it might work with older versions.
pip install pytest-qgis
# Create a virtual environment with qgis and dependencies available $ python -m venv .venv --system-site-packages # Activate the virtual environment $ source .venv/bin/activate # Update pip and setuptools $ python -m pip install -U pip setuptools $ pip install pip-tools # Install dependencies $ pip-sync requirements.txt requirements-dev.txt # Install pre-commit hooks $ pre-commit install
pip-compile --upgrade requirements-dev.in
Contributions are very welcome.
Distributed under the terms of the
GNU GPL v2.0 license, "pytest-qgis" is free and open source software.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for pytest_qgis-2.0.0-py3-none-any.whl