如何通过Pytest获取Python CLI应用的代码覆盖率

我完全懂你的困扰——当测试通过pip安装的CLI应用时，用常规的coverage.py或pytest-cov确实拿不到覆盖率数据，毕竟测试代码里只是通过命令行调用，没直接导入应用的模块，工具自然追踪不到子进程里的代码执行。别慌，有两个实用的方法能解决这个问题：

方法一：用coverage run包裹CLI调用，跨进程追踪覆盖率 #

这个方法的核心是让coverage直接追踪CLI启动的Python子进程，步骤很清晰：

1. 首先确保你已经安装了coverage工具：

pip install coverage

2. 创建一个.coveragerc配置文件，指定要追踪的目标包（替换成你的CLI应用的包名，比如你pip安装的包叫mycli_app，就写这个）：

[run]
source = mycli_app
parallel = true  # 开启并行模式，支持多进程覆盖率合并

3. 修改你的pytest测试用例，把直接调用CLI的代码改成用coverage run来启动CLI。比如之前你可能用subprocess.run(["mycli", "mycommand"])，现在改成：

import subprocess

def test_mycli_command():
    # 用coverage run启动CLI，--append参数确保数据追加不覆盖
    result = subprocess.run(
        ["coverage", "run", "--rcfile=.coveragerc", "--append", "-m", "mycli_app.main", "mycommand"],
        capture_output=True,
        text=True
    )
    # 验证命令执行成功
    assert result.returncode == 0
    assert "预期输出内容" in result.stdout

这里的-m mycli_app.main是指CLI对应的入口模块，你可以通过查看应用的setup.py或pyproject.toml里的console_scripts配置找到，比如如果entry是mycli = mycli_app.main:cli，那入口模块就是mycli_app.main。

4. 运行所有测试后，合并覆盖率数据并生成报告：

coverage combine
coverage report  # 生成文本报告
# 或者生成HTML可视化报告
coverage html

方法二：通过环境变量自动开启子进程覆盖率追踪 #

这个方法更优雅，不用修改每个测试用例的调用方式，通过设置环境变量让所有子进程自动被coverage追踪：

1. 同样先创建.coveragerc配置文件，内容和方法一一样：

[run]
source = mycli_app
parallel = true

2. 在你的测试项目根目录创建conftest.py，添加一个自动生效的session级fixture，用来设置环境变量并初始化coverage：

import os
import pytest
import coverage

@pytest.fixture(scope="session", autouse=True)
def setup_global_coverage():
    # 设置环境变量，告诉子进程启动coverage
    os.environ["COVERAGE_PROCESS_START"] = ".coveragerc"
    # 初始化主进程的coverage
    cov = coverage.Coverage(config_file=".coveragerc")
    cov.start()
    # 测试执行完后停止并合并数据
    yield
    cov.stop()
    cov.combine()
    cov.save()

3. 测试用例可以保持原来的调用方式，比如：

import subprocess

def test_mycli_another_command():
    result = subprocess.run(["mycli", "anothercommand"], capture_output=True, text=True)
    assert result.returncode == 0

4. 直接运行pytest，之后生成覆盖率报告：

pytest
coverage report

关键注意事项 #

• 一定要搞清楚你的CLI应用对应的Python包名，别猜！可以用pip show 你的CLI包名查看，输出里的Name字段就是包名。
• 如果你的CLI是通过console_scripts定义的入口，比如mycli = some_package.cli:main，那source就设为some_package才能覆盖整个应用的代码。
• 如果你在虚拟环境里测试，确保coverage和你的CLI应用都在同一个虚拟环境中，不然可能追踪不到。

备注：内容来源于stack exchange，提问作者Payal Chaurasiya