Brodriguez: Create page

2022-11-12T02:31:31Z

Create page

New page

[https://coverage.readthedocs.io/ Python CodeCoverage] is a tool to measure UnitTest coverage for Python code.

It can be very useful for making sure your tests cover all relevant cases.

{{ note | Coverage (alone) is not necessarily all-encompassing.<br>
For example, it's possible to technically have "100% code coverage" (in that all lines are touched at least once), yet not actually be testing for important edge cases, etc.<br>
Having said that, high code coverage is one indicator (of many) that you can use to gauge effectiveness of your UnitTests. }}

=== Installation ===
Using the Python environment of choice, run:

pip install coverage

== Running Code Coverage ==
The base command is:
coverage run --source='<relative_path>' --omit='<relative_path>' -m <entity_to_run>

Where:
* {{ ic |entity_to_run}} - Indicates the testing method to execute with.
** Ex: {{ ic |manage.py test}} or {{ ic |pytest}}.
* {{ ic |source}} - The path to the directory to recursively check coverage within.
** Usually, this is the path to project root, such as {{ ic |--source<nowiki>=</nowiki>'.'}}.
* {{ ic |omit}} - The path to sub-directories of {{ ic |source}} to exclude.
** Ex: There's no point in checkout our environment so we can add {{ ic |--omit<nowiki>=</nowiki>'.venv/*'}}.

For example, a full example using [[Python/Testing | Pytest]] (to check coverage at project root, and exclude only the {{ ic |venv}} folder):

coverage run --source='.' --omit='.venv/*' -m pytest

== Viewing Coverage Results ==

Running Code Coverage will only generate results to files, not necessarily show them.

View basic results with:

coverage report

Optional useful args:

* {{ ic |-m}} - Display line numbers of missing coverage for each file.
* {{ ic |--skip-covered}} Skip output for any files at 100% coverage. Particularly useful for large projects with good coverage already.

Ex:

coverage report -m --skip-covered

Generate result as html with:

coverage html

Optional useful args:
* {{ ic |-d}} - Allows specifying a directory to generate html files to.

Python/Testing/CodeCoverage - Revision history

Brodriguez: Create page