Get Your Back Covered! Coverage, CodeCov和Tox

最新推荐文章于 2025-12-28 07:10:27 发布

原创

最新推荐文章于 2025-12-28 07:10:27 发布 · 1k 阅读

15 ·

CC 4.0 BY-SA版权

文章标签：

#python #pytest #unit testing #tox #coverage.py

本文介绍了Python测试覆盖率工具coverage.py的使用，包括如何安装、收集覆盖率数据以及生成报告。此外，还详细讲解了Tox如何实现矩阵化测试，包括Tox的工作原理、配置方法和如何与CI集成。最后，提到了如何通过Codecov发布覆盖率报告，以提升开源项目的专业性和可信度。

1. Coverage - 衡量测试的覆盖率

我们已经掌握了如何进行单元测试。接下来，一个很自然的问题浮现出来，我们如何知道单元测试的质量呢？这就提出了测试覆盖率的概念。覆盖率测量通常用于衡量测试的有效性。它可以显示您的代码的哪些部分已被测试过，哪些没有。

coverage.py 是最常用的测量 Python 程序代码覆盖率的工具。它监视您的程序，记录代码的哪些部分已被执行，然后分析源代码以识别已执行和未执行的代码。

我们可以通过下面的方法来安装 coverage.py：

$ pip install coverage

要收集测试覆盖率数据，我们只需要在原来的测试命令前加上 coverage run 即可。比如，如果我们之前是使用pytest arg1 arg2 arg3来进行测试，则现在我们使用：

$ coverage run -m pytest arg1 arg2 arg3

当测试运行完成后，我们可以通过coverage report -m来查看测试覆盖率的报告：

Name                      Stmts   Miss  Cover   Missing
-------------------------------------------------------
my_program.py                20      4    80%   33-35, 39
my_other_module.py           56      6    89%   17-23
-------------------------------------------------------
TOTAL                        76     10    87%

如果希望得到更好的视觉效果，也可以使用 coverage html 命令来生成带注释的 HTML 报告，然后在浏览器中打开 htmlcov/index.html。
75%

不过，更多人选择使用 pytest-cov 插件来进行测试覆盖率的收集。这也是 ppw 的选择。通过 ppw 生成的工程，pytest-cov 已被加入到测试依赖中，因此也就自然安装到环境中去了。

因此，通过 ppw 配置的工程，我们一般不需要直接调用 coverage 命令，而是使用 pytest 命令来进行测试。pytest-cov 插件会自动收集测试覆盖率数据，然后在测试完成后，将测试覆盖率报告打印到控制台上。如果希望生成带注释的 HTML 报告，可以使用pytest --cov-report=html命令。

默认情况下，coverage.py 将测试行（语句）覆盖率，但通过配置，还可以测量分支覆盖率。我们通过下面的示例代码来说明这两种覆盖分别是什么意思。

def my_partial_fn(x):
    if x:
        y = 10
    return y

my_partial_fn(1)

在上面的代码中，第 2 行是一个 if 语句，根据 x 的取值，接下来可能运行到第 3 行，也可能运行到第 4 行。当 coverage 被配置为按语句计算覆盖时（这是默认的情况），只要该函数被执行，则 coverage 将统计为该函数的所有语句都已被执行过；但如果 coverage 被配置为按分支计算覆盖时，如果 x 求值的结果为 False，那么代码执行将从第 2 行直接跳到第 4 行。Coverage 将把第 2 行到第 4 行的代码标记为部分分支覆盖。

除了配置分支覆盖外，还有其它几种情况需要配置。接下来我们就介绍如何进行配置。

Coverage.py 配置文件的默认名称是。coveragerc，在