11 测试代码
编写函数或类时,还可为其编写测试。通过测试,可确定代码面对各种输入都能够按要求的那样工作。在程序中添加新代码时,你也可以对其进行测试,确认它们不会破坏程序既有的行为。
在本章中,你将学习如何使用Python模块unittest
中的工具来测试代码。你将学习编写测试用例,核实一系列输入都将得到预期的输出。你将看到测试通过了是什么样子,测试未通过又是什么样子,还将知道测试未通过如何有助于改进代码。你将学习如何测试函数和类,并将知道该为项目编写多少个测试。
"""11.1 测试函数"""
"""
下面是一个简单的函数,它接受名和姓并返回整洁的姓名:
"""
"""name_function.py"""
def get_formatted_name(first, last):
"""Generate a neatly formatted full name."""
full_name = first + ' ' + last
return full_name.title()
"""
为核实get_formatted_name()像期望的那样工作,我们来编写一个
使用这个函数的程序。程序names.py让用户输入名和姓,并显示整洁的全名:
"""
"""names.py"""
from name_function import get_formatted_name
print "Enter 'q' at any time to quit."
while True:
first = raw_input("\nPlease give me a first name: ")
if first == 'q':
break
last = raw_input("Please give me a last name: ")
if last == 'q':
break
formatted_name = get_formatted_name(first, last)
print("\tNeatly formatted name: " + formatted_name + '.')
Enter 'q' at any time to quit.
Please give me a first name: janis
Please give me a last name: joplin
Neatly formatted name: Janis Joplin.
Please give me a first name: bob
Please give me a last name: dylan
Neatly formatted name: Bob Dylan.
Please give me a first name: q
从上述输出可知,合并得到的姓名正确无误。现在假设我们要修改get_formatted_name()
,使其还能够处理中间名。这样做时,我们要确保不破坏这个函数处理只有名和姓的姓名的方式。为此,我们可以在每次修改get_formatted_name()
后都进行测试:运行程序names.py,并输入像Janis Joplin这样的姓名,但这太烦琐了。
所幸Python提供了一种自动测试函数输出的高效方式。倘若我们对get_formatted_name()
进行自动测试,就能始终信心满满,确信给这个函数提供我们测试过的姓名时,它都能正确地工作。
11.1.1 单元测试和测试用例
Python标准库中的模块unittest
提供了代码测试工具。
单元测试用于核实函数的某个方面没有问题;测试用例是一组单元测试,这些单元测试一起核实函数在各种情形下的行为都符合要求。
良好的测试用例考虑到了函数可能收到的各种输入,包含针对所有这些情形的测试。全覆盖式测试用例包含一整套单元测试,涵盖了各种可能的函数使用方式。对于大型项目,要实现全覆盖可能很难。通常,最初只要针对代码的重要行为编写测试即可,等项目被广泛使用时再考虑全覆盖。
11.1.2 可通过的测试
要为函数编写测试用例,可先导入模块unittest
以及要测试的函数,再创建一个继承unittest.TestCase
的类,并编写一系列方法(需要以test或Test开头)对函数行为的不同方面进行测试。 下面是一个只包含一个方法的测试用例,它检查函数get_formatted_name()
在给定名和姓时能否正确地工作:
"""test_name_function.py"""
import unittest
#from name_function import get_formatted_name
def get_formatted_name(first, last):
"""Generate a neatly formatted full name."""
full_name = first + ' ' + last
return full_name.title()
class NamesTestCase(unittest.TestCase): # 这个类必须继承unittest.TestCase类
"""测试name_function.py"""
def test_first_last_name(self):
formatted_name = get_formatted_name('janis', 'joplin')
# ①
self.assertEqual(formatted_name, 'Janis Joplin')
if __name__ == '__main__':
# unittest.main()
unittest.main(argv=['first-arg-is-ignored'], exit=False)
.
Janis Joplin
----------------------------------------------------------------------
Ran 1 test in 0.002s
OK
①处,我们使用了unittest
类最有用的功能之一:一个断言方法。断言方法用来核实得到的结果是否与期望的结果一致。
在这里,我们期望formatted_name
的值为"Janis Joplin"
。为检查是否确实如此,我们调用unittes
t的方法assertEqual()
,并向它传递formatted_name
和"Janis Joplin"
进行比较。代码行unittest.main()
让Python运行这个文件中的测试。
说明:
书中原代码在本地可以运行,但是在jupyter notebook中运行报错”AttributeError: ‘module’ object has no attribute”,看到Stack Overflow上的问答,参考修改后可以在jupyter notebook中运行。
unittest.main(argv=['first-arg-is-ignored'], exit=False)
unittest.main(argv=['ignored', '-v'], exit=False)
1.1.3 不能通过的测试
修改get_formatted_name(),使其能够处理中间名,但这样做时,故意让这个函数无法正确地处理像Janis Joplin这样只有名和姓的姓名。
下面是函数get_formatted_name()的新版本,它要求通过一个实参指定中间名:
"""name_function.py"""
def get_formatted_name(first, middle, last):
"""生成整洁的姓名"""
full_name = first + ' ' + middle + ' ' + last
return full_name.title()
运行程序test_name_function.py
"""test_name_function.py"""
import unittest
#from name_function import get_formatted_name
def get_formatted_name(first, middle, last):
"""生成整洁的姓名&#