Pytest 子进程覆盖率精准收集方法

本文深入解析了 pytest 测试中子进程（如 GUI 应用、独立脚本）覆盖率“失联”的根本原因与精准解决方案，直击 COVERAGE_PROCESS_START 配置误区、sitecustomize.py 环境错配、路径匹配失效等高频痛点，手把手教你通过正确设置环境变量、精准部署启动模块、合并并行数据及优化 .coveragerc 配置，让 coverage.py 真正穿透主进程边界，完整捕获子进程中每一行业务代码的执行轨迹，彻底告别“No data was collected”警告和仅显示 __init__.py 的假覆盖率幻觉。

本文详解如何正确配置 coverage.py，使其捕获 pytest 所启动的子进程（如 GUI 应用、独立 Python 脚本等）的执行路径，解决“no-data-collected”警告及覆盖率仅显示 `__init__.py` 的常见陷阱。

在使用 pytest 测试涉及多进程或外部 Python 子进程（例如通过 subprocess.run(['python', 'app.py']) 或 multiprocessing.Process 启动的 GUI 应用）的场景时，标准的 coverage run -m pytest 仅能覆盖主测试进程，无法自动追踪子进程中的代码执行。虽然你已尝试通过 sitecustomize.py 和 COVERAGE_PROCESS_START 启用子进程覆盖，但核心问题在于环境变量值配置错误——COVERAGE_PROCESS_START 必须指向配置文件路径，而非布尔值 True。

✅ 正确配置步骤

1. 修正环境变量值
   将：

   export COVERAGE_PROCESS_START=True

   改为（假设你的配置文件名为 .coveragerc，且位于项目根目录）：

   export COVERAGE_PROCESS_START=.coveragerc

2. 确保 sitecustomize.py 正确安装且被所有子进程加载
   该模块必须位于子进程 Python 解释器的 site-packages 路径中（即与被测子进程使用的 Python 环境一致）。若子进程使用虚拟环境（如 3.10_env），请将 sitecustomize.py 放入该环境的 site-packages/ 下（例如：3.10_env/lib/python3.10/site-packages/sitecustomize.py），内容保持不变：

   # sitecustomize.py
   import coverage
   coverage.process_startup()

3. 启用并合并并行数据
   因子进程会生成独立的 .coverage.* 数据文件（如你观察到的 .coverage.Ubuntu-22.5371.XcjyqXNx），需在运行后显式合并：

   coverage combine  # 自动合并当前目录下所有 .coverage.* 文件
   coverage report   # 查看汇总报告
   coverage html     # 生成完整 HTML 报告

4. .coveragerc 配置优化建议
   补充 source 和 include 以明确覆盖范围，并启用子进程支持：

   [run]
   source = src/
   include = src/**.py
   parallel = True
   relative_files = True
   omit = **/tests/*, **/__pycache__/*
   
   [paths]
   source = 
       src/
       */src/
   
   [report]
   exclude_lines =
       pragma: no cover
       def __repr__
       raise AssertionError
       raise NotImplementedError

⚠️ 常见陷阱与验证技巧

• 子进程未加载 sitecustomize.py？
  在子进程中插入调试语句验证：

  # app.py（被子进程执行的入口）
  import sys
  print("Python path:", sys.path)
  print("sitecustomize loaded?", "coverage" in sys.modules)

  若未输出 coverage，说明 sitecustomize.py 未生效——检查 Python 解释器路径、权限及是否被其他 sitecustomize 覆盖。

• 为何只有 __init__.py 有覆盖率？
  这通常表明子进程确实启动了 coverage，但因 source/include 路径不匹配，导致实际业务代码未被识别为“受监控源文件”。确保 .coveragerc 中的 source 路径与子进程实际导入的模块路径完全一致（推荐使用绝对路径或 paths 段映射）。

• 跨环境调试提示
  使用 coverage debug sys 和 coverage debug config 分别检查子进程内 coverage 的运行时环境与配置解析结果，快速定位路径或配置加载失败问题。

完成上述配置后，再次运行：

COVERAGE_PROCESS_START=.coveragerc coverage run --rcfile=.coveragerc -m pytest tests/gui/test_screenshots.py
coverage combine
coverage report -m

你将获得包含子进程真实业务代码（非仅 __init__.py）的完整覆盖率统计，彻底解决“No data was collected”警告。

终于介绍完啦！小伙伴们，这篇关于《Pytest 子进程覆盖率精准收集方法》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识，快来关注吧！