freeai logo
<<返回python首页 python

《Python 应用案例》

Python代码覆盖率检查库Coverage

单元测试代码覆盖率作为一种度量方式，可以计算单元测试用例对于被测代码的覆盖程度，即：被执行的代码数量和代码总数量的比值。统计代码覆盖率，经常在单元测试后再进行，可以为测试结果提供评判依据。本节将介绍 Python 项目最常使用的代码覆盖率统计工具就是：Coverage

Python代码覆盖率检查库Coverage

Coverage是用于统计 Python 代码覆盖率的工具，不仅支持分支覆盖率统计，生成 HTML 格式的统计报告，而且可以集成到 Jenkins 中使用。安装Coverage依赖同样是使用 pip 安装

Coverage 安装

pip3 install coverage -i https://pypi.tuna.tsinghua.edu.cn/simple

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

1、Coverage 命令行

2、Coverage API

更详细的介绍可以参考官方文档：https://coverage.readthedocs.io/en/latest/

实例

首先，创建测试文件main.py，包含一段简单被测代码，内容如下：

cat >> main.py << EOF
# 被测代码 
# 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 "差"
EOF

然后，编写单元测试用例文件test_get_level.py。根据上面的被测方法，这里使用 Python 自带的unittest依赖库来编写 2 个简单的测试用例。

并且，特意只覆盖到了上面方法的 2 个分支，即：优秀和良好

cat >> test_get_level.py << EOF
# 单元测试 
# 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)
EOF

#运行单元测试，会发现两个测试用例都是通过的
python3 test_get_level.py

接下来，分别使用 Coverage 命令和 API 在本地生成代码覆盖率统计报告

1、Coverage命令

# 1、搜集被测代码覆盖率信息，保存到 .coverage 文件中
# 在项目根目录下，运行 coverage run 命令，生成 .coverage 文件，搜集被测试源代码覆盖率的信息。
coverage run test_get_level.py

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

开启一个简单的web服务器用以浏览html文件的报告，&用于不阻塞当前会话

python3 -m http.server 80 &

然后在右侧实验区上方的+号，点击open http项后，点开统计报告文件夹coverage_result中的 index.html 文件，其中：

statements：代码总行数，不包含空行和注释行

missing：未执行的代码行数

coverage：代码覆盖率

Python代码覆盖率检查库Coverage

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

Python代码覆盖率检查库Coverage

Coverage API

使用 Coverage API生成代码覆盖率统计报告更方便

只需要使用查找测试套件并运行，然后使用 Coverage API 进行分析、保存、展示即可

cat >> exec_api.py << EOF
# 使用 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')
EOF

## 使用Python解释器执行
python3 exec_api.py

应会得到如下结果

root@freeaihub:~# python3 exec_api.py
----------------------------------------------------------------------
Ran 2 tests in 0.000s

OK
Name                Stmts   Miss  Cover
---------------------------------------
main.py                10      5    50%
test_get_level.py      18      4    78%
---------------------------------------
TOTAL                  28      9    68%

总结：

上面只是通过一个简单的 Python 方法结合unittest 单元测试框架，展示了 Coverage 获取代码覆盖率统计报告的方法。实际项目中，更多应用场景是： Python自动化、Django/Flask Web项目统计单元测试用例的代码覆盖率，以提升产品的质量。

本文转载自：https://mp.weixin.qq.com/s?__biz=MzU1OTI0NjI1NQ==&mid=2247485932&idx=1&sn=e2598469ba40e13054bea8a62b9673bf

原创作者:星安果，来源公众号:AirPython

关注该作者公众号，第一时间关注 Python 技术干货！

本转载已获授权

移动端设备除iPad Pro外，其它移动设备仅能阅读基础的文本文字。
建议使用PC或笔记本电脑，浏览器使用Chrome或FireFox进行浏览，以开启左侧互动实验区来提升学习效率，推荐使用的分辨率为1920x1080或更高。
我们坚信最好的学习是参与其中这一理念，并致力成为中文互联网上体验更好的学练一体的IT技术学习交流平台。
您可加QQ群：575806994，一起学习交流技术,反馈网站使用中遇到问题。
内容、课程、广告等相关合作请扫描右侧二维码添加好友。

狐狸教程 Copyright 2021

进入全屏