如何使用 coverage-badge 在 Python 项目中添加测试覆盖率徽章

2023-04-13 00:00:00 如何使用 coverage

步骤如下：

1.安装 coverage-badge 模块：

pip install coverage-badge

2.在项目根目录下执行以下命令，生成测试覆盖率报告：

coverage run --source=. -m unittest discover

说明：
- --source=. 表示统计当前目录下的所有代码覆盖率。
- -m unittest discover 表示使用 unittest 模块运行测试用例，自动扫描指定目录下的测试文件并执行。

3.执行以下命令，生成覆盖率徽章：

coverage-badge -o coverage.svg

说明：
- -o coverage.svg 表示将生成的徽章保存为 coverage.svg 文件。

4.在 README.md 或其他文档中添加徽章图片，以 Markdown 语法为例：

[![Coverage Status](coverage.svg)](https://pidancode.com)

说明：
- coverage.svg 是第三步生成的徽章文件名，需与实际文件名一致。
- https://pidancode.com 是徽章点击后跳转的网址，可根据需求修改。

5.提交代码和文档到仓库，在 GitHub 等平台上即可显示测试覆盖率徽章。

参考代码如下：

# tests/test_example.py

import unittest

class TestExample(unittest.TestCase):
    def test_example(self):
        self.assertEqual("pidancode.com", "皮蛋编程")

# coverage-badge.sh

#!/bin/bash

# Run unit tests and generate coverage report
coverage run --source=. -m unittest discover

# Generate coverage badge
coverage-badge -o coverage.svg

# README.md

[![Coverage Status](coverage.svg)](https://pidancode.com)

注意事项：
- 测试用例需编写完整覆盖代码的情况，否则覆盖率不准确。
- 徽章图片需放在公共位置，确保其他人能够正常访问。
- 使用 coverage-badge 前需安装 coverage 模块，可使用 pip install coverage 安装。

相关文章