Python代码覆盖率分析工具Coverage

article/2025/10/23 12:03:48

目录

简介

安装

命令行中使用

调用API使用


简介

Coverage是一个Python代码覆盖率分析工具,它可以用于衡量Python测试代码的质量。通过给代码执行带来的覆盖率数据,Coverage可以帮助开发人员找出被回归测试代码中的漏洞,并且指明哪些代码没有被测试到。

Coverage可以让你知道:哪些部分代码已经被测试,哪些部分没有被测试到,以及哪些代码相对缺失。使用Coverage可以有效地提高代码质量,减少出现质量问题的概率。Coverage可以很方便地集成到持续集成(CI)和持续交付(CD)流程中,以便更早地发现和解决质量问题。

安装

Coverage作为Python的一个第三方库,使用时需要先安装,使用pip命令进行安装。
安装命令:

C:\Users\TynamYang>pip install coverage
Collecting coverage
Downloading coverage-5.1-cp37-cp37m-win32.whl (204 kB)|████████████████████████████████| 204 kB 731 kB/s
Installing collected packages: coverage
Successfully installed coverage-5.1C:\Users\TynamYang>

安装完成后可以看到安装的版本:coverage-5.1
安装完成后使用coverage,coverage有两种使用方法,一种是在命令行中使用,一种是调用API使用。方便控制部分需要测试的代码。

命令行中使用

1、基本参数
命令行中使用时常用参数:

  • run – 运行Python程序并收集执行数据

  • report – 报告覆盖率结果

  • html – 生成HTML文件,内容含覆盖率结果列表

  • json – 生成JSON文件,内容含覆盖率结果

  • xml – 生成XML报告文件,内容含覆盖率结果

  • erase – 清除之前收集的覆盖率数据

  • combine – 合并多个数据文件

  • debug – 获取调试信息

可以使用help命令查看帮助:

coverage help

2、运行代码收集信息

在使用coverage时,基本需要两步运行,第一步运行源代码,收集被测试的源代码覆盖率的信息,第二步生成代码覆盖率的信息报告。
如下测试代码:

#test.py
# coding:utf-8
import unittest
def add_numb(a, b):return a + b
def division_numb(a, b):return a / b
class Test(unittest.TestCase):def test_add_1(self):self.assertEqual(add_numb(1,1), 2)def test_add_2(self):self.assertEqual(add_numb(2,0), 1)def test_division_1(self):self.assertEqual(division_numb(2,1), 2)def test_division_2(self):self.assertEqual(division_numb(2,0), 2)
if __name__ == "__main__":unittest.main(verbosity=2)

使用命令运行:

coverage run test.py
C:\Users\TynamYang\Desktop> coverage run test.py
test_add_1 (__main__.Test) ... ok
test_add_2 (__main__.Test) ... FAIL
test_division_1 (__main__.Test) ... ok
test_division_2 (__main__.Test) ... ERROR======================================================================
ERROR: test_division_2 (__main__.Test)
----------------------------------------------------------------------
Traceback (most recent call last):
File "test.py", line 22, in test_division_2
self.assertEqual(division_numb(2,0), 2)
File "test.py", line 9, in division_numb
return a / b
ZeroDivisionError: division by zero======================================================================
FAIL: test_add_2 (__main__.Test)
----------------------------------------------------------------------
Traceback (most recent call last):
File "test.py", line 16, in test_add_2
self.assertEqual(add_numb(2,0), 1)
AssertionError: 2 != 1----------------------------------------------------------------------
Ran 4 tests in 0.003sFAILED (failures=1, errors=1)
PS C:\Users\TynamYang\Desktop>

代码执行完成后会生成一个覆盖率统计结果文件:.coverage。该文件名可通过设置COVERAGE_FILE环境变量进行修改。

3、生成报告

查看报告有两种方式,一种是在当前命令行模式下查看,一种是生成HTML报告文件查看。
命令行模式下查看
根据运行代码后生成的.coverage文件,使用report参数可在命令行模式下查看覆盖率统计结果。
使用命令:

coverage report
PS C:\Users\TynamYang\Desktop> coverage report
Name      Stmts   Miss  Cover
-----------------------------
test.py      16      0   100%
PS C:\Users\TynamYang\Desktop>

由结果可以得知,执行的test.py文件,代码覆盖率是100%
结果展示中的字段含义:

  • tmts:语句总数

  • Miss:未执行到的语句数

  • Cover:覆盖率,计算公式 Cover=(Stmts-Miss)/Stmts

生成HTML报告文件
使用命令生成HTML报告:

coverage html -d covhtml

其中参数-d是指定生成的html所在的文件夹名
命令执行完成后会生成一个covhtml文件。

文件中的index.html文件覆盖率数据统计。
也可以看一些示例:Cog coverage

各字段说明:

  • Stmts 总的有效代码行数(不包含空行和注释行)

  • Miss 未执行的代码行数(不包含空行和注释行)

  • Branch 总分支数

  • BrMiss 未执行的分支数

  • Cover 代码覆盖率

  • Missing 未执行的代码部分在源文件中行号

以执行的测试原文件命名的文件,可以高亮显示覆盖和未覆盖的代码。如test_py.html。
也可以看一些示例

调用API使用

调用API使用文档:http://coverage.readthedocs.org/en/latest/api.html
在python代码中通过调用coverage模块执行代码生成代码覆盖率的统计结果。使用方法也非常简单,如下示例:

if __name__ == "__main__":# 实例化对象cov = coverage.coverage()# 开始分析cov.start()suite = unittest.defaultTestLoader.discover(os.getcwd(), "test.py")unittest.TextTestRunner().run(suite)# 结束分析cov.stop()# 结果保存cov.save()# 命令行模式展示结果cov.report()# 生成HTML覆盖率报告cov.html_report(directory='covhtml')

作为一位过来人也是希望大家少走一些弯路,希望能对你带来帮助。(WEB自动化测试、app自动化测试、接口自动化测试、持续集成、自动化测试开发、大厂面试真题、简历模板等等),相信能使你更好的进步! 

留【自动化测试】即可【自动化测试交流】:574737577(备注ccc)icon-default.png?t=N5F7http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=hyGITtX0cD6EN96WzR_d5b1qRSZ-Dpyy&authKey=76TmCzaAQ%2BOwLn6umFFZeVxKheSwyaUVwymd%2FRvdARY6cvCSCgZ1qOSe3w%2Bsh61f&noverify=0&group_code=574737577

 


http://chatgpt.dhexx.cn/article/LKhuD1ZI.shtml

相关文章

coverage 测试代码覆盖率

测试覆盖率,简单的说,就是评价测试活动覆盖产品代码的指标。测试的目的,是确认产品代码按照预期一样工作,也可以看作是产品代码工作方式的说明文档。进一步考虑,测试覆盖率可以看作是产品代码质量的间接指标&#xff0…

GIS原理篇 Coverage

一、什么是 Coverage Coverage 是一种用于存储矢量数据的地理相关数据模型,它包含地理要素的空间(位置)数据和属性(描述性)数据。Coverage 使用一组要素类来表示地理要素。每个要素类存储一组点、线(弧&am…

Python:代码覆盖率工具coverage

简介:覆盖率测量通常用于衡量测试的有效性。它可以显示您的代码的哪些部分正在被测试执行,哪些不是。coverage是一个测量 Python 程序代码覆盖率的工具。它监视您的程序,注意代码的哪些部分已被执行,然后分析源代码以识别可能已执…

configure--prefix

本文主要说明--prefix参数的作用,其主要用在编译安装源代码应用中的./configure环节。 ./configure --help 查看详细的说明帮助 1、源码安装一般包括几个步骤:配置(configure),编译(make)&…

路由策略 匹配工具 IP-Prefix

⦁ p-prefix-name:指定地址前缀列表的名称。字符串形式,长度范围是1~169,不支持空格,区分大小写。 ⦁ index index-number:指定本匹配项在地址前缀列表中的序号。整数形式,取值范围是1&am…

CondaValueError: The target prefix is the base prefix. Aborting.

报错截图 错误原因 conda命令错误 正确做法 conda create -n py38 python3.8

zuul 里面的 prefix 和 strip-prefix 怎么使用

首先两个是配置路由前缀的, 下面是我网上找的一段话: prefix :前缀,当请求匹配前缀时会进行代理strip-prefix :代理前缀默认会从请求路径中移除,通过该设置关闭移除功能, 当 stripPrefixtrue …

Trie树(Prefix Tree)介绍

本文用尽量简洁的语言介绍一种树形数据结构 —— Trie树。 一、什么是Trie树 Trie树,又叫字典树、前缀树(Prefix Tree)、单词查找树 或 键树,是一种多叉树结构。如下图: 上图是一棵Trie树,表示了关键字集…

configure --prefix=/的作用和用法

非root用户安装python和gcc的时候,总是需要设定这个,只知道是个路径,具体是什么路径,代表什么不清楚。 不明白就百度: configure --prefix/是干啥用的?这个路径代表了什么? Configure是一个可…

前缀和(Prefix Sum)

前缀和指一个数组的某下标之前的所有数组元素的和(包含其自身)。前缀和分为一维前缀和,以及二维前缀和。前缀和是一种重要的预处理,能够降低算法的时间复杂度,可以在 O ( 1 ) O(1) O(1)的时间复杂度内求出区间和。 一…

CMAKE_INSTALL_PREFIX

一、定义 CMAKE_INSTALL_PREFIX为cmake的内置变量,用于指定cmake执行install命令时,安装的路径前缀。Linux下的默认路径是/usr/local ,Windows下默认路径是 C:/Program Files/${PROJECT_NAME} 二、用…

IP-Prefix List

地址前缀列表 一、IP-Prefix List二、语法及匹配规则1、语法2、匹配规则 三、配置案例1、拓扑2、分析ACL实现IP-Prefix List实现 四、IE考试题思考题 在进行配置案例前先了解一下基础知识 一、IP-Prefix List IP-Prefix List:能够同时匹配网络号和前缀长度 性能及可…

【脚本】更新依赖库pkgconfig文件中的prefix设置

在本地编译和安装了某个库后,如果其lib目录下存在pkgconfig子目录,则子目录下会存在若干.pc文件,文件中会有prefix的配置(该配置标识当前库的安装路径),当要把该库拷贝到其他机器上时,如果库的路…

Elasticsearch学习--查询(prefix、wildcard、regexp、fuzzy)

一、前缀搜索 prefix 不计算相关度评分性能较差前缀搜索匹配的是分词后的词项前缀搜索没有缓存前缀搜索尽可能把前缀长度设置的更长 GET product/_search {"query": {"fuzzy": {"name": {"value": "product1"}}} } index…

bgp 使用route-map设置Local perference(本地优先属性)配置与详解

实验目的: 1、掌握基于route-map的本地优先配置方法。 2、使用route-map配置可以定置基于目标网络的本地优先。 实验拓扑: 接口IP配置及bgp基础配置详见 CSDNhttps://mp.csdn.net/mp_blog/creation/editor?spm1001.2014.3001.5352 查看R3与R4的路由…

使用route-map 配置BGP本地优先级

一、实验目的: 1、掌握基于route-map的本地优先配置方法。 2、使用route-map配置可以定置基于目标网络的本地优先级。 二、拓扑图: 三、配置BGP基本的配置: 1、配置各路由器的IP地址和BGP协议。配置完之后,查看一下R3和R4的路由表…

Cisco route-map 源地址路由配置

拓朴图: 案例: 公司内部使用的是一条拨号光纤和一条固定专线光纤,默认是指向拨号光纤出口那个网关出去,现在2网段有两台服务器(WEB、Mail)映射到公网,让外部来访问。 办公区因工作需要&#xf…

bgp route-map应用 配置 学习笔记

先全运行bgp R2 router bgp 2 no auto-summary no synchronzation bgp router-id 2.2.2.2 neighbor 12.1.1.1 remtotes as 10 neighbor 24.1.1.4 remote-as 10r1: router bgp 10 no auto-summary no synchronization bgp router-id 1.1.1.1 neighbor 12.1.1.2…

重分布和Route-MAP

一般在做重分布的时候用route-map较多,当然也可以用分发列表或者前缀列表等等,重分布的时候为了干掉不需要的路由,节约路由器CPU和转发效率可以使用route-map,当然route-map也可以用在其他的场景。 本次实验将ospf与rip重分布来使…

使用Route-Map过滤BGP的路由

实验目的 1、掌握使用Route-Map过滤BGP的路由。 实验拓扑 接口ip配置与bgp基础配置详见: CSDNhttps://mp.csdn.net/mp_blog/creation/editor/125210020查看R3的路由表: R3#show ip route Gateway of last resort is not set1.0.0.0/24 is subnetted…