怎么在Python中使用pytest-cov统计覆盖率

落涛君_9229

落涛君_9229

2026-10-27

552人浏览

原创

pytest-cov需单独安装,安装后通过pytest --help | grep cov验证;基本命令为pytest --cov=my_module tests/,可生成终端或HTML覆盖率报告;建议用.coveragerc配置source、omit和exclude_lines以提高准确性。

怎么在python中使用pytest-cov统计覆盖率

安装 pytest-cov 并确认是否生效

pytest-cov 是一个插件,不是 pytest 自带功能,必须显式安装。不装它,加 --cov 参数会直接报错:ERROR: unknown option: --cov。

  • 运行 pip install pytest-cov(推荐用虚拟环境,避免污染全局)
  • 安装后执行 pytest --help | grep cov,能看到 --cov、--cov-report 等选项才说明装对了
  • 注意:如果你用的是 Poetry 或 Pipenv,得确保在激活环境中运行安装命令,否则 pytest 可能找不到插件

最简命令跑出覆盖率报告

不需要配置文件也能快速出结果,适合临时验证或 CI 单次检查。

  • 基本命令:pytest --cov=my_module tests/
    其中 my_module 是你要统计的源码包名(对应目录名),不是文件路径,也不是 .py 后缀
  • 如果源码在 src/ 下(常见于现代 Python 项目结构),要写成 --cov=src.my_module,否则会显示 “No data was collected”
  • 默认输出是终端 summary(如 123 statements 94% covered),想看更细的行级覆盖,加 --cov-report=term-missing

生成 HTML 报告并定位未覆盖代码

HTML 报告能直观看到哪行没执行,比终端数字有用得多,尤其调试分支逻辑时。

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
  • 加参数:pytest --cov=my_module --cov-report=html tests/
  • 执行完会在当前目录生成 htmlcov/ 文件夹,打开 htmlcov/index.html 即可浏览
  • 注意点:
    • htmlcov/ 是默认输出目录,可改用 --cov-report=html:reports/htmlcov 指定路径
    • 如果报告里全是灰色(0%),大概率是 --cov=xxx 的模块名和实际 import 路径不一致,比如你写了 --cov=utils,但测试里是 from src.utils import foo,就得改成 --cov=src.utils
    • HTML 报告不自动打开浏览器,需要手动点开,别等它弹窗

忽略测试文件和空行以避免干扰判断

默认情况下,pytest-cov 会把 tests/ 目录也纳入扫描(如果它被 import 过),导致覆盖率虚高;空行、docstring、pass 行也会计入“statements”,拉低数值。

  • 推荐建一个 .coveragerc 文件放在项目根目录:
    [run]
    source = my_module
    omit = */tests/*,*/test_*.py,*/__pycache__/*
    exclude_lines =
      pragma: no cover
      def __repr__
      raise AssertionError
      raise NotImplementedError
    
  • source 显式限定只统计目标模块,比 --cov=xxx 更可靠
  • omit 防止测试文件被误算;注意路径通配符用的是 Unix 风格,Windows 下也一样写 <em>/tests/</em>
  • exclude_lines 里的正则会跳过匹配行,不参与统计——这对写了很多 raise NotImplementedError 的抽象基类特别有用

覆盖率数字本身容易误导人,真正关键的是:没覆盖的那些行,是不是业务逻辑的关键分支?有没有漏掉异常路径?别盯着 100% 看,先确保 if/else、try/except、边界值都进了测试。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

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

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

2023.07.20

1811

4

python能做什么
python能做什么

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

2023.07.25

4804

7

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

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

2023.07.31

1769

3

python教程
python教程

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

2023.08.03

28657

23

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

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

2023.08.04

3427

5

python eval
python eval

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

2023.08.04

3447

5

scratch和python区别
scratch和python区别

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

2023.08.11

1223

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2683

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习