Coverage 用法详解

什么是 Coverage？

Coverage（通常指 coverage.py）是一个用于测量 Python 程序测试覆盖率的工具。它能告诉你哪些代码被测试覆盖了，哪些没有，从而帮助你提高测试质量。

安装 Coverage

使用 pip 安装非常简单：

pip install coverage

基本用法

假设你有一个 Python 项目，包含以下文件：

• mymath.py：待测试的模块
• test_mymath.py：对应的单元测试

运行测试并生成覆盖率报告：

coverage run -m pytest

coverage report -m

上述命令会：

1. 使用 coverage 执行 pytest 测试
2. 生成详细覆盖率报告（-m 显示缺失行号）

生成 HTML 报告

可视化你的覆盖率结果：

coverage html

执行后会在 htmlcov/ 目录下生成交互式 HTML 报告，打开 index.html 即可查看。

配置文件 .coveragerc

你可以通过配置文件自定义行为。在项目根目录创建 .coveragerc：

[run]

source = myproject

omit = 

    */tests/*

    */venv/*



[report]

exclude_lines =

    pragma: no cover

    def __repr__

    raise AssertionError

    raise NotImplementedError

该配置指定源码路径、忽略测试和虚拟环境，并排除某些不计入覆盖率的代码行。

常用命令速查

• coverage run script.py：运行单个脚本
• coverage run -m unittest：运行 unittest
• coverage report：终端显示覆盖率摘要
• coverage html：生成 HTML 报告
• coverage xml：生成 Cobertura 兼容的 XML 报告（用于 CI）

最佳实践建议

• 将 coverage 集成到 CI/CD 流程中
• 设定最低覆盖率阈值（如 90%）
• 合理使用 # pragma: no cover 忽略无法测试的代码
• 定期审查未覆盖代码，补充测试用例