在 GitHub 上展示 Python 项目代码覆盖率

在 GitHub 上展示 Python 项目代码覆盖率

代码覆盖率是衡量测试质量的重要指标之一，它可以帮助开发者了解代码的哪些部分被测试覆盖，哪些部分尚未覆盖。在 GitHub 上展示代码覆盖率，可以方便地监控项目代码的测试情况，并及时发现潜在的风险。本文将介绍如何利用 GitHub Actions 和 pytest-cov 工具，实现这一目标。

1. 安装 pytest-cov

首先，确保你的项目中安装了 pytest-cov 库。如果尚未安装，可以通过以下命令安装：

pip install pytest pytest-cov

或者，你可以将 pytest-cov 添加到 requirements.txt 文件中，并在 GitHub Actions 中安装依赖时自动安装它。

立即学习“Python免费学习笔记（深入）”；

2. 修改 GitHub Actions 工作流文件

接下来，需要修改你的 GitHub Actions 工作流文件（通常位于 .github/workflows/ 目录下）。找到运行测试的步骤，并修改 pytest 命令，添加 --cov 参数。例如，将以下代码：

- name: Test with pytest
  run: |
    pip install pytest pytest-cov
    pytest tests/

修改为：

- name: Test with pytest
  run: |
    pip install pytest pytest-cov
    pytest --cov tests/

--cov 参数告诉 pytest-cov 收集测试覆盖率数据。默认情况下，它会收集当前目录及其子目录下的所有 .py 文件的覆盖率数据。你也可以指定特定的源文件或目录，例如：pytest --cov=my_module tests/。

3. 上传覆盖率报告 (可选)

代码小浣熊

代码小浣熊是基于商汤大语言模型的软件智能研发助手，覆盖软件需求分析、架构设计、代码编写、软件测试等环节

51

查看详情

虽然 --cov 参数可以生成覆盖率数据，但它不会自动将其上传到 GitHub 或其他平台进行可视化展示。为了更方便地查看覆盖率报告，建议使用 Codecov 等服务。

首先，你需要注册一个 Codecov 账号，并获取你的仓库的 Codecov token。然后，在 GitHub Actions 工作流文件中添加一个步骤，用于上传覆盖率报告。

- name: Upload coverage to Codecov
  uses: codecov/codecov-action@v3
  with:
    token: ${{ secrets.CODECOV_TOKEN }}
    flags: unittests
    name: codecov-umbrella

在这个步骤中，uses: codecov/codecov-action@v3 指定使用 Codecov 的 GitHub Action。token: ${{ secrets.CODECOV_TOKEN }} 指定 Codecov token，你需要将 token 存储在 GitHub 仓库的 Secrets 中。flags 和 name 是可选参数，可以用于区分不同的覆盖率报告。

4. 完整示例

下面是一个完整的 GitHub Actions 工作流文件示例：

name: Python CI

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.11'
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt
    - name: Test with pytest
      run: |
        pip install pytest pytest-cov
        pytest --cov tests/
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v3
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        flags: unittests
        name: codecov-umbrella

5. 注意事项

• 确保你的测试用例覆盖了尽可能多的代码路径。
• 定期检查代码覆盖率报告，并根据报告改进测试用例。
• 可以将代码覆盖率作为代码审查的标准之一，确保新的代码都有相应的测试用例。
• 如果你的项目使用了不同的测试框架，可以查找相应的覆盖率工具，例如 coverage.py。

总结

通过简单的配置，你就可以在 GitHub 上展示 Python 项目的代码覆盖率。这可以帮助你更好地监控代码质量，并及时发现潜在的风险。记住，代码覆盖率只是衡量测试质量的一个指标，不能完全依赖它。还需要结合其他测试方法，例如单元测试、集成测试和端到端测试，才能保证代码的质量。

以上就是在 GitHub 上展示 Python 项目代码覆盖率的详细内容，更多请关注php中文网其它相关文章！