首页 文章详情

聊聊 Python 代码覆盖率工具 - Coverage

Python爬虫与数据挖掘 | 154 2020-08-11 00:15 0 0 0

点击上方“Python爬虫与数据挖掘”,进行关注

回复“书籍”即可获赠Python从入门到进阶共10本电子书

如何匡国分,不与夙心期。



1. 代码覆盖率

单元测试代码覆盖率作为一种度量方式,可以计算单元测试用例对于被测代码的覆盖程度,即:被执行的代码数量和代码总数量的比值

统计代码覆盖率,经常在单元测试后再进行,可以为测试结果提供评判依据

Python 项目最常使用的代码覆盖率统计工具就是:Coverage

2. Coverage

Coverage 是用于统计 Python 代码覆盖率的工具,不仅支持分支覆盖率统计,生成 HTML 格式的统计报告,而且可以集成到 Jenkins 中使用

安装 Coverage 依赖同样是使用 pip 安装

# 安装 Coverage 依赖
pip3 install coverage

Coverage 官方提供了 2 种方式,用于统计代码覆盖率,分别是:

1、Coverage 命令行

2、Coverage API 

更详细的介绍可以参考官方文档:

https://coverage.readthedocs.io/en/latest/

3. 实战一下

首先,用 Python 编写一段简单被测代码,如下:
# 被测代码 
# main.py
def get_level(cource):
    """
    自定义的方法
    :param cource:成绩
    :return:
    """

    if cource >= 90:
        return "优秀"
    elif cource >= 80:
        return "良好"
    elif cource >= 60:
        return "合格"
    elif cource >= 40:
        return "不合格"
    else:
        return "差"
然后,编写单元测试用例
根据上面的被测方法,这里使用 Python 自带的unittest 依赖库来编写 2 个简单的测试用例
并且,特意只覆盖到了上面方法的 2 个分支,即:优秀和良好
# 单元测试 
# test_get_level.py 
import unittest

from main import *


class GetLevel(unittest.TestCase):

    def test_get_level1(self):
        self.assertEquals(get_level(90), "优秀")

    def test_get_level2(self):
        self.assertEquals(get_level(80), "良好")


if __name__ == '__main__':
    unittest.main(verbosity=2)
右键运行单元测试,会发现两个测试用例都是通过的
接下来,分别使用 Coverage 命令和 API 在本地生成代码覆盖率统计报告
1、Coverage命令
在项目根目录下,运行 coverage run 命令,生成 .coverage 文件,搜集被测试源代码覆盖率的信息
# 1、搜集被测代码覆盖率信息,保存到 .coverage 文件中
coverage run test_get_level.py

# 2、生成覆盖率统计结果报告
coverage html -d coverage_result
然后,使用 coverage html -d  命令在同级目录下生成代码覆盖率统计报告



用浏览器打开统计报告文件夹中的 index.html 文件,其中:
statements:代码总行数,不包含空行和注释行
missing:未执行的代码行数
coverage:代码覆盖率



点击 test_get_level.py 文件,可以非常直观地查看到,哪些代码执行了,哪些代码没有被执行



2、Coverage API
使用 Coverage API生成代码覆盖率统计报告更方便
只需要使用查找测试套件并运行,然后使用 Coverage API 进行分析、保存、展示即可
# 使用 API 生成代码覆盖率统计报告
# exec_api.py

import coverage
import unittest

# 实例化一个对象
cov = coverage.coverage()
cov.start()

# 测试套件
suite = unittest.defaultTestLoader.discover("./""test_get_level.py")
unittest.TextTestRunner().run(suite)


# 结束分析
cov.stop()

# 结果保存
cov.save()

# 命令行模式展示结果
cov.report()

# 生成HTML覆盖率报告
cov.html_report(directory='result_html')

4. 最后

上面只是通过一个简单的 Python 方法结合 unittest 单元测试框架,展示了 Coverage 获取代码覆盖率统计报告的方法

实际项目中,更多应用场景是: Python自动化Django/Flask Web项目统计单元测试用例的代码覆盖率,以提升产品的质量

------------------- End -------------------

往期精彩文章推荐:

欢迎大家点赞,留言,转发,转载,感谢大家的相伴与支持

想加入Python学习群请在后台回复【入群

万水千山总是情,点个【在看】行不行

/今日留言主题/

随便说一两句吧~~

good-icon 0
favorite-icon 0
收藏
回复数量: 0
    暂无评论~~
    Ctrl+Enter