《Python:编程:从入门到实践》学习笔记_第11章 测试代码

第11章 测试代码

---

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()

程序names.py让用户输入名和姓，并显示整洁的全名：

from name_function import get_formatted_name 
print("Enter 'q' at any time to quit.") 
while True: 
 	first = input("\nPlease give me a first name: ") 
 	if first == 'q': 
 		break 
 	last = input("Please give me a last name: ") 
 	if last == 'q': 
 		break 
 
 	formatted_name = get_formatted_name(first, last) 
 	print("\tNeatly formatted name: " + formatted_name + '.') 

这个程序从name_function.py中导入get_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

11.1.1 单元测试和测试用例

Python标准库中的模块unittest提供了代码测试工具。单元测试用于核实函数的某个方面没有问题；测试用例是一组单元测试，这些单元测试一起核实函数在各种情形下的行为都符合要求。良好的测试用例考虑到了函数可能收到的各种输入，包含针对所有这些情形的测试。全覆盖式测试用例包含一整套单元测试，涵盖了各种可能的函数使用方式。对于大型项目，要实现全覆盖可能很难。通常，最初只要针对代码的重要行为编写测试即可，等项目被广泛使用时再考虑全覆盖。

11.1.2 可通过的测试

要为函数编写测试用例，可先导入模块unittest以及要测试的函数，再创建一个继承unittest.TestCase的类，并编写一系列方法对函数行为的不同方面进行测试。

import unittest 
from name_function import get_formatted_name 
class NamesTestCase(unittest.TestCase): 
 	"""测试name_function.py""" 
 
 	def test_first_last_name(self): 
 	"""能够正确地处理像Janis Joplin这样的姓名吗？""" 
		formatted_name = get_formatted_name('janis', 'joplin') 
		self.assertEqual(formatted_name, 'Janis Joplin') 
		
unittest.main()

这个类必须继承unittest.TestCase类，这样Python才知道如何运行你编写的测试。

我们运行test_name_function.py时，所有以test_打头的方法都将自动运行。

我们使用了unittest类最有用的功能之一：一个断言方法。断言方法用来核实得到的结果是否与期望的结果一致。在这里，我们知道get_formatted_name()应返回这样的姓名，即名和姓的首字母为大写，且它们之间有一个空格，因此我们期望formatted_name的值为Janis Joplin。为检查是否确实如此，我们调用unittest的方法assertEqual()，并向它传递formatted_ name和’Janis Joplin’。代码行self.assertEqual(formatted_name, ‘Janis Joplin’)的意思是说：“将formatted_name的值同字符串’Janis Joplin’进行比较，如果它们相等，就万事大吉，如果它们不相等，跟我说一声！”

代码行unittest.main()让Python运行这个文件中的测试。运行test_name_function.py时，得到的输出如下：

. 
---------------------------------------------------------------------- 
Ran 1 test in 0.000s 

OK

第1行的句点表明有一个测试通过了。接下来的一行指出Python运行了一个测试，消耗的时间不到0.001秒。最后的OK表明该测试用例中的所有单元测试都通过了。

11.1.3 不能通过的测试

下面是函数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时，输出如下：

E 
====================================================================== 
ERROR: test_first_last_name (__main__.NamesTestCase) 
---------------------------------------------------------------------- 
Traceback (most recent call last): 
   File "test_name_function.py", line 8, in test_first_last_name 
     formatted_name = get_formatted_name('janis', 'joplin') 
TypeError: get_formatted_name() missing 1 required positional argument: 'last' 
---------------------------------------------------------------------- 
Ran 1 test in 0.000s 

FAILED (errors=1) 

第1行输出只有一个字母E，它指出测试用例中有一个单元测试导致了错误。接下来，我们看到NamesTestCase中的test_first_last_name()导致了错误。测试用例包含众多单元测试时，知道哪个测试未通过至关重要。我们看到了一个标准的traceback，它指出函数调用get_formatted_name(‘janis’, ‘joplin’)有问题，因为它缺少一个必不可少的位置实参。我们还看到运行了一个单元测试。最后，还看到了一条消息，它指出整个测试用例都未通过，因为运行该测试用例时发生了一个错误。

11.1.4 测试未通过时怎么办

测试未通过时怎么办呢？如果你检查的条件没错，测试通过了意味着函数的行为是对的，而测试未通过意味着你编写的新代码有错。因此，测试未通过时，不要修改测试，而应修复导致测试不能通过的代码：检查刚对函数所做的修改，找出导致函数行为不符合预期的修改。

11.1.5 添加新测试

---

11.2 测试类

11.2.1 各种断言方法

Python在unittest.TestCase类中提供了很多断言方法。前面说过，断言方法检查你认为应该满足的条件是否确实满足。如果该条件确实满足，你对程序行为的假设就得到了确认，你就可以确信其中没有错误。如果你认为应该满足的条件实际上并不满足，Python将引发异常。

下表描述了6个常用的断言方法。使用这些方法可核实返回的值等于或不等于预期的值、返回的值为True或False、返回的值在列表中或不在列表中。你只能在继承unittest.TestCase的类中使用这些方法，

11.2.2 一个要测试的类

survey.py（文件名，非代码） 
class AnonymousSurvey(): 
	"""收集匿名调查问卷的答案""" 
 
	def __init__(self, question): 
 		"""存储一个问题，并为存储答案做准备""" 
 		self.question = question 
 		self.responses = [] 
 
	def show_question(self): 
 		"""显示调查问卷""" 
 		print(question) 
 
	def store_response(self, new_response): 
 		"""存储单份调查答卷""" 
 		self.responses.append(new_response) 
 
	def show_results(self): 
 		"""显示收集到的所有答卷""" 
 		print("Survey results:") 
 		for response in responses: 
 			print('- ' + response) 

为证明AnonymousSurvey类能够正确地工作，我们来编写一个使用它的程序：

from survey import AnonymousSurvey 

#定义一个问题，并创建一个表示调查的AnonymousSurvey对象
question = "What language did you first learn to speak?" 
my_survey = AnonymousSurvey(question) 

#显示问题并存储答案
my_survey.show_question() 
print("Enter 'q' at any time to quit.\n") 
while True: 
 	response = input("Language: ") 
 	if response == 'q': 
 		break 
 	my_survey.store_response(response) 

# 显示调查结果
print("\nThank you to everyone who participated in the survey!") 
my_survey.show_results() 

用户输入所有答案（输入q要求退出）后，调用show_results()来打印调查结果：

What language did you first learn to speak? 
Enter 'q' at any time to quit. 

Language: English 
Language: Spanish
Language: English 
Language: Mandarin 
Language: q 

Thank you to everyone who participated in the survey! 
Survey results: 
- English 
- Spanish 
- English 
- Mandarin 

11.2.3 测试 AnonymousSurvey 类

import unittest 
from survey import AnonymousSurvey 

class TestAnonmyousSurvey(unittest.TestCase): 
 	"""针对AnonymousSurvey类的测试""" 
 
	def test_store_single_response(self): 
 		"""测试单个答案会被妥善地存储""" 
 		question = "What language did you first learn to speak?" 
		my_survey = AnonymousSurvey(question) 
 		my_survey.store_response('English') 
 
	self.assertIn('English', my_survey.responses) 
	
unittest.main()

当我们运行test_survey.py时，测试通过了：

. 
---------------------------------------------------------------------- 
Ran 1 test in 0.001s 
OK 

这很好，但只能收集一个答案的调查用途不大。下面来核实用户提供三个答案时，它们也将被妥善地存储。为此，我们在TestAnonymousSurvey中再添加一个方法：

import unittest 
from survey import AnonymousSurvey 

class TestAnonymousSurvey(unittest.TestCase): 
 """针对AnonymousSurvey类的测试""" 
 
 	def test_store_single_response(self): 
 		"""测试单个答案会被妥善地存储""" 
 		--snip-- 
 
 	def test_store_three_responses(self): 
 		"""测试三个答案会被妥善地存储""" 
 		question = "What language did you first learn to speak?" 
 		my_survey = AnonymousSurvey(question) 
		responses = ['English', 'Spanish', 'Mandarin'] 
 		for response in responses: 
 			my_survey.store_response(response) 
 
		for response in responses: 
 		self.assertIn(response, my_survey.responses) 
 		
unittest.main()

我们再次运行test_survey.py时，两个测试（针对单个答案的测试和针对三个答案的测试）都通过了：

.. 
---------------------------------------------------------------------- 
Ran 2 tests in 0.000s 
OK 

11.2.4 方法 setUp()

unittest.TestCase类包含方法setUp()，让我们只需创建这些对象一次，并在每个测试方法中使用它们。如果你在TestCase类中包含了方法setUp()，Python将先运行它，再运行各个以test_打头的方法。这样，在你编写的每个测试方法中都可使用在方法setUp()中创建的对象了

import unittest 
from survey import AnonymousSurvey 

class TestAnonymousSurvey(unittest.TestCase): 
 	"""针对AnonymousSurvey类的测试""" 
 
 	def setUp(self): 
 		""" 
 		创建一个调查对象和一组答案，供使用的测试方法使用
 		""" 
 		question = "What language did you first learn to speak?" 
		self.my_survey = AnonymousSurvey(question) 
		self.responses = ['English', 'Spanish', 'Mandarin'] 
 
 	def test_store_single_response(self): 
 		"""测试单个答案会被妥善地存储""" 
 		self.my_survey.store_response(self.responses[0]) 
 		self.assertIn(self.responses[0], self.my_survey.responses) 
 
 	def test_store_three_responses(self): 
 		"""测试三个答案会被妥善地存储""" 
 		for response in self.responses: 
 			self.my_survey.store_response(response) 
 		for response in self.responses: 
 			self.assertIn(response, self.my_survey.responses) 

unittest.main() 

方法setUp()做了两件事情：创建一个调查对象；创建一个答案列表。存储这两样东西的变量名包含前缀self（即存储在属性中），因此可在这个类的任何地方使用。这让两个测试方法都更简单，因为它们都不用创建调查对象和答案。

注：运行测试用例时，每完成一个单元测试，Python都打印一个字符：测试通过时打印一个句点；测试引发错误时打印一个E；测试导致断言失败时打印一个F。这就是你运行测试用例时，在输出的第一行中看到的句点和字符数量各不相同的原因。如果测试用例包含很多单元测试，需要运行很长时间，就可通过观察这些结果来获悉有多少个测试通过了。

---

11.3 小结

在本章中，你学习了：如何使用模块unittest中的工具来为函数和类编写测试；如何编写继承unittest.TestCase的类，以及如何编写测试方法，以核实函数和类的行为符合预期；如何使用方法setUp()来根据类高效地创建实例并设置其属性，以便在类的所有测试方法中都可使用它们。