Python 单元测试框架系列:聊聊 Python 的单元测试框架(一):unittest
作者:HelloGitHub-Prodesire
HelloGitHub 的《讲解开源项目》系列,项目地址:https://github.com/HelloGitHub-Team/Article
前言
说到 Python 的单元测试框架,想必接触过 Python 的朋友脑袋里第一个想到的就是 unittest。
的确,作为 Python 的标准库,它很优秀,并被广泛用于各个项目。但你知道吗?其实在 Python 众多项目中,主流的单元测试框架远不止这一个。
本系列文章将为大家介绍目前流行的 Python 的单元测试框架,讲讲它们的功能和特点并比较其异同,以让大家在面对不同场景、不同需求的时候,能够权衡利弊,选择最佳的单元测试框架。
本文默认以 Python 3 为例进行介绍,若某些特性在 Python 2 中没有或不同,会特别说明。
一、介绍
unittest 单元测试框架最早受到 JUnit 的启发,和其他语言的主流单元测试框架有着相似的风格。
它支持测试自动化,多个测试用例共享前置(setUp)和清理(tearDown)代码,聚合多个测试用例到测试集中,并将测试和报告框架独立。
二、用例编写
下面这段简单的示例来自于官方文档,用来测试三种字符串方法:upper
、isupper
、split
:
import unittest class TestStringMethods(unittest.TestCase): def test_upper(self): self.assertEqual('foo'.upper(), 'FOO') def test_isupper(self): self.assertTrue('FOO'.isupper()) self.assertFalse('Foo'.isupper()) def test_split(self): s = 'hello world' self.assertEqual(s.split(), ['hello', 'world']) # check that s.split fails when the separator is not a string with self.assertRaises(TypeError): s.split(2) if __name__ == '__main__': unittest.main()
上述示例中,通过继承 unittest.TestCase 来创建一个测试用例。
在这个类中,定义以 test
开头的方法,测试框架将把它作为独立的测试去执行。
每个用例都采用 unittest
内置的断言方法来判断被测对象的行为是否符合预期,比如:
- 在
test_upper
测试中,使用 assertEqual 检查是否是预期值 - 在
test_isupper
测试中,使用 assertTrue 或 assertFalse 验证是否符合条件 - 在
test_split
测试中,使用 assertRaises 验证是否抛出一个特定异常
可能有人会好奇,为什么不使用内置断言语句 assert
,而要额外提供这么多断言方法并使用呢?原因是通过使用 unittest
提供的断言方法,测试框架在运行结束后,能够聚合所有的测试结果并产生信息丰富的测试报告。而直接使用 assert
虽然也可以达到验证被测对象是否符合预期的目的,但在用例出错时,报错信息不够丰富。
三、用例发现和执行
unittest
支持用例自动(递归)发现:
- 默认发现当前目录下所有符合
test*.py
测试用例- 使用
python -m unittest
或
- 使用