Installing and Using plugins¶
This section talks about installing and using third party plugins. For writing your own plugins, please refer to Writing plugins.
Installing a third party plugin can be easily done with
pip install pytest-NAME pip uninstall pytest-NAME
If a plugin is installed,
pytest automatically finds and integrates it,
there is no need to activate it.
Here is a little annotated list for some popular plugins:
- pytest-django: write tests for django apps, using pytest integration.
- pytest-twisted: write tests for twisted apps, starting a reactor and processing deferreds from test functions.
- pytest-catchlog: to capture and assert about messages from the logging module
- pytest-cov: coverage reporting, compatible with distributed testing
- pytest-xdist: to distribute tests to CPUs and remote hosts, to run in boxed mode which allows to survive segmentation faults, to run in looponfailing mode, automatically re-running failing tests on file changes, see also xdist: pytest distributed testing plugin
- pytest-instafail: to report failures while the test run is happening.
- pytest-bdd and pytest-konira to write tests using behaviour-driven testing.
- pytest-timeout: to timeout tests based on function marks or global definitions.
--pep8option to enable PEP8 compliance checking.
- pytest-flakes: check source code with pyflakes.
To see a complete list of all plugins with their latest testing status against different py.test and Python versions, please visit plugincompat.
You may also discover more plugins through a pytest- pypi.python.org search.
Requiring/Loading plugins in a test module or conftest file¶
You can require plugins in a test module or a conftest file like this:
pytest_plugins = "myapp.testsupport.myplugin",
When the test module or conftest plugin is loaded the specified plugins will be loaded as well.
pytest_plugins = “myapp.testsupport.myplugin”
which will import the specified module as a
Finding out which plugins are active¶
If you want to find out which plugins are active in your environment you can type:
and will get an extended test header which shows activated plugins and their names. It will also print local plugins aka conftest.py files when they are loaded.
Deactivating / unregistering a plugin by name¶
You can prevent plugins from loading or unregister them:
py.test -p no:NAME
This means that any subsequent try to activate/load the named plugin will not work.
If you want to unconditionally disable a plugin for a project, you can add
this option to your
[pytest] addopts = -p no:NAME
Alternatively to disable it only in certain environments (for example in a
CI server), you can set
PYTEST_ADDOPTS environment variable to
See Finding out which plugins are active for how to obtain the name of a plugin.
Pytest default plugin reference¶
You can find the source code for the following plugins in the pytest repository.
||support for presenting detailed information in failing assertions.|
||merged implementation of the cache provider|
||per-test stdout/stderr capturing mechanism.|
||command line options, ini-file and conftest.py processing.|
||discover and run doctests in modules and test files.|
||(deprecated) generate a single-file self-contained version of pytest|
||version info, help messages, tracing configuration.|
||report test results in JUnit-XML format,|
||generic mechanism for marking and selecting python functions.|
||monkeypatching and mocking functionality.|
||run test suites written for nose.|
||submit failure or test session information to a pastebin service.|
||(disabled by default) support for testing pytest and pytest plugins.|
||Python test discovery, setup and run of test functions.|
||recording warnings during test function execution.|
||log machine-parseable test session result information in a plain|
||basic collect and runtest protocol implementations|
||core implementation of testing process: init, session, runtest loop.|
||support for skip/xfail functions and markers.|
||terminal reporting of the full testing process.|
||support for providing temporary directories to test functions.|
||discovery and running of std-library “unittest” style tests.|