如何为 pytest 启动的子进程精准收集代码覆盖率

秋静小哥_9419

秋静小哥_9419

2026-04-30

744人浏览

原创

本文详解如何正确配置 coverage.py,使其捕获 pytest 所启动的子进程(如 GUI 应用、独立 Python 脚本等)的执行路径,解决“no-data-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”警告。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1711

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4364

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1689

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

25457

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3107

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3127

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1163

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2423

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习