测试代码
在本章中，将学习如何使用Python模块unittest中的工具来测试代码。我们将学习编写测试用例，核实一系列输入都将得到预期的输出。我们将看到测试通过了是什么样子，测试未通过又是什么样子，还将知道测试未通过如何有助于改进代码。我们将学习如何测试函数和类，并将知道该为项目编写多少个测试。
一、测试函数
name_function.py
def get_formatted_name(first, last):
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':
print("Program Quit!")
break
last = input("Please give me a last name : ")
if last == 'q':
print("Program Quit!")
break
full_name = get_formatted_name(first, last)
print("Neatly formatted name: " + full_name + '.')
输出：
Enter 'q' at any time to quit!
Please give me a first name : wang
Please give me a last name : yuan
Neatly formatted name: Wang Yuan.
Please give me a first name : q
Program Quit!
单元测试和测试用例
Python标准库中的模块unittest提供了代码测试工具。
单元测试用于核实函数的某个方面没有问题；测试用例是一组单元测试，这些单元测试一起核实函数在各种情形下的行为都符合要求。良好的测试用例考虑到了函数可能收到的各种输入，包含针对所有这些情形的测试。
全覆盖式测试用例包含一整套单元测试，涵盖了各种可能的函数使用方式。对于大型项目，要实现全覆盖可能很难。通常，最初只要针对代码的重要行为编写测试即可，等项目被广泛使用时再考虑全覆盖。
可通过的测试
创建测试用例的语法需要一段时间才能习惯，但测试用例创建后，再添加针对函数的单元测试就很简单了。要为函数编写测试用例，可先导入模块unittest以及要测试的函数，再创建一个继承unittest.TestCase的类，并编写一系列方法对函数行为的不同方面进行测试。
下面是一个只包含一个方法的测试用例，它检查函数get_formatted_name()在给定名和姓时能否正确地工作：
test_name_function.py
import unittest
from name_function import get_formatted_name
class NamesTestCase(unittest.TestCase):
def test_first_last_name(self):
full_name = get_formatted_name('wang', 'yuan')
self.assertEqual(full_name, 'Wang Yuan')
unittest.main()
首先我们要导入模块unittest和要测试的函数get_formatted_name()。
我们创建一个名为NamesTestCase的类，用于包含一系列针对get_formatted_name()的单元测试。可以随便给这个类命名，但最好让它看起来与要测试的函数相关，并包含字样Test。这个类必须继承unittest.TestCase类，这样Python才知道如何运行编写的测试。
NamesTestCase只包含一个方法，用于测试get_formatted_name()的一个方面。我们将这个方法命名为test_first_last_name()，因为我们要核实的是只有名和姓的姓名能否被正确地格式化。我们运行test_name_function.py时，所有以test_打头的方法都将自动运行。在这个方法中，我们调用了要测试的函数，并存储了要测试的返回值。
我们使用了unittest类最有用的功能之一：一个断言方法。断言方法用来核实得到的结果是否与期望的结果一致。代码行self.assertEqual(full_name, ‘Lin Jun Jie’)的意思是说：“ 将full_name的值同字符串 “ Lin Jun Jie ” 进行比较，如果相等就万事大吉；如果不相等跟我说一声！”
代码行unittest.main()让Python运行这个文件中的测试。运行test_name_function.py时，看到的输出如下：
.
----------------------------------------------------------------------
Ran 1 test in 0.001s
OK
第一行的句点表明有一个测试通过了。接下来的一行指出Python运行了一个测试，消耗的时间为0.001秒。最后的OK表明该测试用例中的所有单元测试都通过了。
不能通过的测试
下面是函数get_formatted_name()的新版本，它要求通过一个实参指定中间名：
name_function.py
def get_formatted_name(first, middle, last):
if middle:
full_name = first + ' ' + middle + ' ' + last
else:
full_name = first + ' ' + 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 6, in test_first_last_name
full_name = get_formatted_name('wang', 'yuan')
TypeError: get_formatted_name() missing 1 required positional argument: 'last'
----------------------------------------------------------------------
Ran 1 test in 0.001s
FAILED (errors=1)
其中包含的信息很多，因为测试未通过时，需要让你知道的事情可能有很多。
第一行输出只有一个字母E，它指出测试用例中有一个单元测试导致了错误。
接下来我们看到NamesTestCases中的test_first_last_name()导致了错误。测试用例包含众多单元测试时，知道哪个测试未通过至关重要。
接下来我们看到了一个标准的traceback，它指出函数调用get_formatted_name(‘wang’, ‘yuan’)有问题，因为它缺少一个必不可少的位置实参。
我们还看到运行了一个单元测试。最后，还看到了一条消息，它指出整个测试用例都未通过，因为运行该测试用例时发生了一个错误。这条消息位于输出末尾，让你一眼就能看到——你可不希望为获悉有多少测试未通过而翻阅长长的输出。
测试未通过时怎么办
测试未通过时怎么办呢？如果你检查的条件没错，测试通过了意味着函数的行为是对的，而测试未通过意味着你编写的新代码有错。因此，测试未通过时，不要修改测试，而应修复导致测试不能通过的代码：检查刚对函数所做的修改，找出导致函数行为不符合预期的修改。
在这个示例中，get_formatted_name()以前只需要两个实参——名和姓，但现在它要求提供名、中间名和姓。新增的中间名参数是必不可少的，这导致get_formatted_name()的行为不符合预期。就这里而言，最佳的选择是让中间名变为可选的。这样做后，使用类似于Wang Yuan的姓名进行测试时，测试就会通过了，同时这个函数还能接受中间名。下面来修改 get_formatted_name()，将中间名设置为可选的，然后再次运行这个测试用例。如果通过了，我们接着确认这个函数能够妥善地处理中间名。
要将中间名设置为可选的，可在函数定义中将形参middle移到形参列表末尾，并将其默认值指定为一个空字符串。我们还要添加一个 if 测试，以便根据是否提供了中间名相应地创建姓名:
name_function.py
def get_formatted_name(first, last, middle=''):
if middle:
full_name = first + ' ' + middle + ' ' + last
else:
full_name = first + ' ' + last
return full_name.title()
在get_formatted_name()的这个新版本中，中间名是可选的。如果向这个函数传递了中间名 (if middle:)，姓名将包含名、中间名和姓，否则姓名将只包含名和姓。现在，对于两种不同的姓名，这个函数都应该能够正确地处理。为确定这个函数依然能够正确地处理像Janis Joplin这样的姓名，我们再次运行test_name_function.py:
.
----------------------------------------------------------------------
Ran 1 test in 0.002s
OK
现在，测试用例通过了。太好了，这意味着这个函数又能正确地处理像Wang Yuan这样的姓名了，而且我们无需手工测试这个函数。这个函数很容易就修复了，因为未通过的测试让我们得知新代码破坏了函数原来的行为。
添加新测试
确定get_formatted_name()又能正确地处理简单的姓名后，我们再编写一个测试，用于测试包含中间名的姓名。为此，我们在NamesTestCase类中再添加一个方法：
import unittest
from name_function import get_formatted_name
class NamesTestCase(unittest.TestCase):
def test_first_last_name(self):
full_name = get_formatted_name('wang', 'yuan')
self.assertEqual(full_name, 'Wang Yuan')
def test_first_last_middle_name(self):
full_name = get_formatted_name("wang", 'kai', 'jun')
self.assertEqual(full_name, 'Wang Jun Kai')
unittest.main()
我们将这个方法命名为test_first_last_middle_name()。方法名必须以test_打头，这样它才会在我们运行test_name_function.py时自动运行。
..
----------------------------------------------------------------------
Ran 2 tests in 0.001s
OK
这表明这个函数又能正确地处理像Wang Yuan这样的名字了，也可以正确地处理像Wang Jun Kai这样的姓名。
二、测试类
很多程序中都会用到类，因此能够证明你的类能够正确地工作会大有裨益。如果针对类的测试通过了，就能确保对类所做的改进没有意外地破坏了其原有的行为。
各种断言方法
Python在unittest.TestCase类中提供了很多断言方法。前面说过，断言方法检查你认为应该满足的条件是否确实满足。如果该条件确实满足，你对程序行为的假设就得到了确认，你就可以确信其中没有错误。如果你认为应该满足的条件实际上并不满足，Python将引发异常。
| 方法 | 用途 |
|---|---|
| assertEqual(a, b) | 核实a == b |
| assertNotEqual(a, b) | 核实a != b |
| assertTrue(x) | 核实x为True |
| assertFalse(x) | 核实x为False |
| assertIn(item, list) | 核实item在list中 |
| assertNotIn(item, list) | 核实item不在list中 |
一个要测试的类
类的测试与函数的测试相似，下面来编写一个类进行测试。
来看一个帮助管理匿名调查的类：
survey.py
class AnonymousSurvey():
def __init__(self, question):
self.question = question
self.responses = []
def show_question(self):
print(self.question)
def store_response(self, new_response):
self.responses.append(new_response.title())
def show_results(self):
print("Survey results:")
for response in self.responses:
print(response)
这个类首先存储了一个指定的调查问题，并创建了一个空列表，用于存储答案。
这个类包含打印调查问题的方法、在答案列表中添加新答案的方法以及将存储在列表中的答案都打印出来的方法。
要创建这个类的实，只需提供一个问题即可。有了表示调查的实例后，就可使用show_question()来显示其中的问题，可使用store_response()来存储答案，并使用show_results()来显示调查结果。
为证明AnonymousSurvey类能够正确地工作，我们来编写一个使用它的程序：
language_survey.py
from survey import 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!" )
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()
这个程序定义了一个问题（“What language did you first learn to speak?”）,并使用这个问题创建了一个AnonymousSurvey对象。接下来，这个程序调用show_question()来显示问题，并提示用户输入答案。收到每个答案的同时将其存储起来。用户输入所有答案（输入q要求退出）后，调用show_results()来打印调查结果：
What language did you first learn to speak?
Enter 'q' at any time to quit!
Language: english
Language: chinese
Language: q
Thank you to everyone who participated in the survey!
Survey results:
English
Chinese
测试AnonymousSurvey类
下面来编写一个测试，对AnonymousSurvey类的行为的一个方面进行验证：如果用户面对调查问题时只提供了一个答案，这个答案也能被妥善地存储。为此，我们将在这个答案被存储后，使用方法assertIn()来核实它包含在答案列表中：
test_survey.py
import unittest
from survey import AnonymousSurvey
class TestAnonymousSurvey(unittest.TestCase):
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()
我们首先导入了模块unittest以及要测试的类AnonymousSurvey。我们将测试用例命名为TestAnonymousSurvey，它也继承了unittest.TestCase。
第一个测试方法验证调查问题的单个答案被存储后，会包含在调查结果列表中。对于这个方法，一个不错的描述性名称是test_store_single_response()。如果这个测试未通过，我们就能通过输出中的方法名得知，在存储单个调查答案方面存在问题。
当我们运行时，测试通过了：
.
----------------------------------------------------------------------
Ran 1 test in 0.001s
OK
下面来核实用户提供三个答案时，它们也将被妥善地存储
import unittest
from survey import AnonymousSurvey
class TestAnonymousSurvey(unittest.TestCase):
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)
def test_store_three_responses(self):
question = "What language did you first learn to speak?"
my_survey = AnonymousSurvey(question)
responses = ["english", "chinese", "spanish"]
for response in responses:
my_survey.store_response(response)
for response in responses:
self.assertIn(response.title(), my_survey.responses)
unittest.main()
运行后，两个测试都通过了：
..
----------------------------------------------------------------------
Ran 2 tests in 0.003s
OK
方法setUp()
在前面的test_survey.py中，我们在每个测试方法中都创建了一个AnonymousSurvey实例，并在每个方法中都创建了答案。
unittest.TestCase类包含方法setUp()，让我们只需创建这些对象一次，并在每个测试方法中使用它们。如果你在TestCase类中包含了方法setUp()，Python将先运行它，再运行各个以test_打头的方法。这样，在你编写的每个测试方法中都可使用在方法setUp()中创建的对象了。
下面使用setUp()来创建一个调查对象和一组答案，供方法test_store_single_response()和test_store_three_response()使用：
import unittest
from survey import AnonymousSurvey
class TestAnonymousSurvey(unittest.TestCase):
def setUp(self):
question = "What language did you first learn to speak?"
self.my_survey = AnonymousSurvey(question)
self.responses = ['English', 'Chinese', 'Spanish']
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.responses)
unittest.main()
方法setUp()做了两件事情：创建一个调查对象；创建一个答案列表。存储这两样东西的变量名包含前缀self（即存储在属性中），因此可在这个类的任何地方使用。
运行后，两个测试都通过了：
..
----------------------------------------------------------------------
Ran 2 tests in 0.002s
OK
