coverage
overage 是一个用于测量Python程序代码覆盖率的工具。它监视您的程序,注意代码的哪些部分已经执行,然后分析源代码,以确定哪些代码本可以执行,但没有执行。
覆盖率测量通常用于衡量测试的有效性。它可以显示代码的哪些部分正在由测试执行,哪些部分没有。
最新版本是coverage 7.3.2,发布于2023年10月2日。它支持于:
- Python 版本3.8到3.12。
- Python 版本3.8到3.10。
参考文章
官网:https://coverage.readthedocs.io/en/latest/config.html
代码说明
目录结构说明
业务代码
class CalcDemo:def __init__(self, x, y):self.x = xself.y = ydef plus(self):return self.x + self.ydef subtract(self):return self.x - self.ydef multiply(self):return self.x * self.ydef divide(self):return self.x / self.y
测试代码
import unittestfrom src.Demo import CalcDemoclass TestDemo(unittest.TestCase):def test_plus(self):self.assertEquals(CalcDemo(6, 4).plus(), 10)def test_subtract(self):self.assertEquals(CalcDemo(6, 4).subtract(), 2)def test_multiply(self):self.assertEquals(CalcDemo(1, 5).multiply(), 5)
配置文件
[run]
# 是否统计条件语句的分支覆盖情况。if 条件语句中的判断通常有 True 和 False 两种情况,设置 branch = True 后,Coverage 会测量这两种情况是否都被测试到。
branch = True
# 指定需统计的源代码目录,这里设置为当前目录(即项目根目录)。
source = src[report]
# 在生成的统计报告中显示未被测试覆盖到的代码行号。
show_missing = True
执行生成报告文件
import unittest
import coverageif __name__ == "__main__":# 测试目录testPath = ['test', 'test/demo', 'test/system']# 实例化对象cov = coverage.coverage()# 开始分析cov.start()# 创建用例集suite = unittest.TestSuite()for path in testPath:suite.addTest(unittest.defaultTestLoader.discover(path, "*.py", path))unittest.TextTestRunner().run(suite)# 结束分析cov.stop()# 结果保存cov.save()# 命令行模式展示结果cov.report()# 生成HTML覆盖率报告cov.html_report(directory='ResultHtml')