1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
=============
Configuration
=============
This plugin provides a clean minimal set of command line options that are added to pytest. For
further control of coverage use a coverage config file.
For example if tests are contained within the directory tree being measured the tests may be
excluded if desired by using a .coveragerc file with the omit option set::
pytest --cov-config=.coveragerc
--cov=myproj
myproj/tests/
Where the .coveragerc file contains file globs::
[run]
omit = tests/*
For full details refer to the `coverage config file`_ documentation.
.. _`coverage config file`: https://coverage.readthedocs.io/en/latest/config.html
.. note:: Important Note
This plugin overrides the ``parallel`` option of coverage. Unless you also run coverage without pytest-cov it's
pointless to set those options in your ``.coveragerc``.
If you use the ``--cov=something`` option (with a value) then coverage's ``source`` option will also get overridden.
If you have multiple sources it might be easier to set those in ``.coveragerc`` and always use ``--cov`` (without a value)
instead of having a long command line with ``--cov=pkg1 --cov=pkg2 --cov=pkg3 ...``.
If you use the ``--cov-branch`` option then coverage's ``branch`` option will also get overridden.
If you wish to always add pytest-cov with pytest, you can use ``addopts`` under the ``pytest`` or ``tool:pytest`` section of
your ``setup.cfg``, or the ``tool.pytest.ini_options`` section of your ``pyproject.toml`` file.
For example, in ``setup.cfg``: ::
[tool:pytest]
addopts = --cov=<project-name> --cov-report html
Or for ``pyproject.toml``: ::
[tool.pytest.ini_options]
addopts = "--cov=<project-name> --cov-report html"
Caveats
=======
A unfortunate consequence of coverage.py's history is that ``.coveragerc`` is a magic name: it's the default file but it also
means "try to also lookup coverage configuration in ``tox.ini`` or ``setup.cfg``".
In practical terms this means that if you have your coverage configuration in ``tox.ini`` or ``setup.cfg`` it is paramount
that you also use ``--cov-config=tox.ini`` or ``--cov-config=setup.cfg``.
You might not be affected but it's unlikely that you won't ever use ``chdir`` in a test.
Reference
=========
The complete list of command line options is:
--cov=PATH Measure coverage for filesystem path. (multi-allowed)
--cov-report=type Type of report to generate: term, term-missing,
annotate, html, xml, json, lcov (multi-allowed). term, term-
missing may be followed by ":skip-covered". annotate,
html, xml, json and lcov may be followed by ":DEST" where DEST
specifies the output location. Use --cov-report= to
not generate any output.
--cov-config=path Config file for coverage. Default: .coveragerc
--no-cov-on-fail Do not report coverage if test run fails. Default:
False
--no-cov Disable coverage report completely (useful for
debuggers). Default: False
--cov-reset Reset cov sources accumulated in options so far.
Mostly useful for scripts and configuration files.
--cov-fail-under=MIN Fail if the total coverage is less than MIN.
--cov-append Do not delete coverage but append to current. Default:
False
--cov-branch Enable branch coverage.
--cov-context Choose the method for setting the dynamic context.
|
