pytest-dev/pytest-cov pytest-dev/pytest-cov

Web Debugging
  • Stars
    star
    1,647
  • Rank 27,184 (Top 0.6 %)
  • Language
    Python
  • License
    MIT License
  • Created about 10 years ago
  • Updated about 1 month ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
pytest-dev/pytest-cov
github

pytest-dev

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Coverage plugin for pytest.

Overview

docs Documentation Status
tests GitHub Actions Status
package PyPI Package latest release conda-forge PyPI Wheel Supported versions Supported implementations Commits since latest release

This plugin produces coverage reports. Compared to just using coverage run this plugin does some extras:

  • Subprocess support: you can fork or run stuff in a subprocess and will get covered without any fuss.
  • Xdist support: you can use all of pytest-xdist's features and still get coverage.
  • Consistent pytest behavior. If you run coverage run -m pytest you will have slightly different sys.path (CWD will be in it, unlike when running pytest).

All features offered by the coverage package should work, either through pytest-cov's command line options or through coverage's config file.

  • Free software: MIT license

Installation

Install with pip:

pip install pytest-cov

For distributed testing support install pytest-xdist:

pip install pytest-xdist

Upgrading from ancient pytest-cov

pytest-cov 2.0 is using a new .pth file (pytest-cov.pth). You may want to manually remove the older init_cov_core.pth from site-packages as it's not automatically removed.

Uninstalling

Uninstall with pip:

pip uninstall pytest-cov

Under certain scenarios a stray .pth file may be left around in site-packages.

  • pytest-cov 2.0 may leave a pytest-cov.pth if you installed without wheels (easy_install, setup.py install etc).
  • pytest-cov 1.8 or older will leave a init_cov_core.pth.

Usage

pytest --cov=myproj tests/

Would produce a report like:

-------------------- coverage: ... ---------------------
Name                 Stmts   Miss  Cover
----------------------------------------
myproj/__init__          2      0   100%
myproj/myproj          257     13    94%
myproj/feature4286      94      7    92%
----------------------------------------
TOTAL                  353     20    94%

Documentation

https://pytest-cov.readthedocs.io/en/latest/

Coverage Data File

The data file is erased at the beginning of testing to ensure clean data for each test run. If you need to combine the coverage of several test runs you can use the --cov-append option to append this coverage data to coverage data from previous test runs.

The data file is left at the end of testing so that it is possible to use normal coverage tools to examine it.

Limitations

For distributed testing the workers must have the pytest-cov package installed. This is needed since the plugin must be registered through setuptools for pytest to start the plugin on the worker.

For subprocess measurement environment variables must make it from the main process to the subprocess. The python used by the subprocess must have pytest-cov installed. The subprocess must do normal site initialisation so that the environment variables can be detected and coverage started.

Acknowledgements

Whilst this plugin has been built fresh from the ground up it has been influenced by the work done on pytest-coverage (Ross Lawley, James Mills, Holger Krekel) and nose-cover (Jason Pellerin) which are other coverage plugins.

Ned Batchelder for coverage and its ability to combine the coverage results of parallel runs.

Holger Krekel for pytest with its distributed testing support.

Jason Pellerin for nose.

Michael Foord for unittest2.

No doubt others have contributed to these tools as well.

More Repositories

1

pytest

The pytest framework makes it easy to write small tests, yet scales to support complex functional testing
Python
11,150
star
2

pytest-testinfra

Testinfra test your infrastructures
Python
2,306
star
3

pytest-mock

Thin-wrapper around the mock package for easier use with pytest
Python
1,725
star
4

pytest-xdist

pytest plugin for distributed testing and loop-on-failures testing modes.
Python
1,318
star
5

pytest-asyncio

Asyncio support for pytest
Python
1,293
star
6

pytest-django

A Django plugin for pytest.
Python
1,286
star
7

pytest-bdd

BDD library for the py.test runner
Python
1,248
star
8

pluggy

A minimalist production ready plugin system
Python
1,136
star
9

pytest-html

Plugin for generating HTML reports for pytest results
Python
649
star
10

pyfakefs

Provides a fake file system that mocks the Python file system modules.
Python
596
star
11

pytest-randomly

🎲 Pytest plugin to randomly order tests and control random.seed
Python
573
star
12

pytest-flask

A set of pytest fixtures to test Flask applications
Python
471
star
13

pytest-qt

pytest plugin for Qt (PyQt5/PyQt6 and PySide2/PySide6) application testing
Python
376
star
14

pytest-rerunfailures

a pytest plugin that re-runs failed tests up to -n times to eliminate flakey failures
Python
351
star
15

pytest-factoryboy

factory_boy integration the pytest runner
Python
348
star
16

pytest-selenium

Plugin for running Selenium with pytest
Python
325
star
17

cookiecutter-pytest-plugin

A Cookiecutter template for pytest plugins 💻
Python
281
star
18

pytest-splinter

pytest splinter and selenium integration for anyone interested in browser interaction in tests
Python
250
star
19

pytest-describe

Describe-style plugin for the pytest framework
Python
201
star
20

pytest-timeout

Python
185
star
21

pytest-subtests

unittest subTest() support and subtests fixture
Python
177
star
22

pytest-repeat

pytest plugin for repeating test execution
Python
158
star
23

pytest-order

pytest plugin that allows to customize the test execution order
Python
145
star
24

pytest-instafail

py.test plugin to show failures instantly
Python
130
star
25

unittest2pytest

helps rewriting Python `unittest` test-cases into `pytest` test-cases
Python
125
star
26

pytest-cpp

Use pytest's runner to discover and execute C++ tests
C++
111
star
27

pytest-github-actions-annotate-failures

Pytest plugin to annotate failed tests with a workflow command for GitHub Actions
Python
109
star
28

pytest-env

pytest plugin to set environment variables in pytest.ini or pyproject.toml file
Python
103
star
29

pytest-xprocess

pytest external process plugin
Python
94
star
30

pytest-reportlog

Replacement for the --resultlog option, focused in simplicity and extensibility
Python
75
star
31

pytest-variables

Plugin for providing variables to pytest tests/fixtures
Python
73
star
32

execnet

distributed Python deployment and communication
Python
72
star
33

pytest-play

pytest plugin that let you automate actions and assertions with test metrics reporting executing plain YAML files
Python
68
star
34

pytest-messenger

Pytest-messenger report plugin for all popular messengers like: Slack, DingTalk, Telegram
Python
67
star
35

py

Python development support library (note: maintenance only)
Python
66
star
36

pytest-random-order

pytest plugin to randomise the order of tests with some control over the randomness
Python
64
star
37

pytest-print

pytest-print adds the printer fixture you can use to print messages to the user (directly to the pytest runner, not stdout)
Python
63
star
38

pytest-mimesis

Mimesis integration with the pytest test runner. This plugin provider useful fixtures based on providers from Mimesis.
Python
62
star
39

pytest-services

Collection of fixtures and utility functions to run service processes for your tests
Python
58
star
40

pytest-forked

extracted --boxed from pytest-xdist to ensure backward compat
Python
58
star
41

pytest-runner

Python
57
star
42

pytest-metadata

Plugin for accessing test session metadata
Python
55
star
43

iniconfig

Python
49
star
44

apipkg

Python
48
star
45

pytest-twisted

test twisted code with pytest
Python
45
star
46

pytest-stress

A Pytest plugin that allows you to loop tests for a user defined amount of time.
Python
40
star
47

pytest-incremental

py-test plugin: an incremental test runner
Python
40
star
48

pytest-faker

faker integration the pytest test runner
Python
38
star
49

nose2pytest

Scripts to convert Python Nose tests to PyTest
Python
35
star
50

pytest-base-url

pytest plugin for URL based tests
Python
35
star
51

pytest-cloud

Distributed tests planner plugin for pytest testing framework.
Python
35
star
52

pytest-freezer

Pytest plugin providing a fixture interface for spulec/freezegun
Python
35
star
53

plugincompat

Test execution and compatibility checks for pytest plugins
CSS
34
star
54

pytest-fixture-tools

Pytest fixture tools
Python
32
star
55

pytest-faulthandler

py.test plugin that activates the fault handler module during testing
Python
27
star
56

pytest-echo

pytest plugin to dump environment variables, package version and generic attributes.
Python
21
star
57

pytest-localserver

py.test plugin to test server connections locally. This repository was migrated from Bitbucket.
Python
19
star
58

pytest-inline

pytest-inline is a pytest plugin for writing inline tests.
Python
14
star
59

pytest-nunit

An Nunit output plugin for Pytest
Python
10
star
60

design

Graphic design for Pytest project
9
star
61

pytest-plus

pytest-plus adds new features to pytest
Python
9
star
62

pytest-bpdb

pytest plugin for dropping to bpdb on test failures
Python
6
star
63

blog.pytest.org

Repository for the official pytest blog
Python
4
star
64

pytest-tcpclient

pytest mocking of TCP clients
Python
3
star
65

meta

Used for generic pytest organization issues, stuff that can impact multiple projects.
2
star
66

pytest-talks

public pytest talks and workshops - meant to help user groups spin up talks and workshops
HTML
1
star
67

regendoc

Python
1
star
68

sprint

pytest development sprint 2024
1
star