测试函数
要学习测试，得有要测试的代码。下面是一个简单的函数，它接受名和姓并返回整洁的姓名：
name_function.py
# coding:utf-8
def get_formatted_name(first, last):
"""Generate a neatly formatted full name."""
full_name = first + ' ' + last
return full_name.title()
names.py
# coding:utf-8
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 + '.')
☁ test python names.py
Enter 'q' at any time to quit.
Please give me a first name: 曹
Please give me a last name: 孟德
Neatly formatted name: 曹 孟德.
单元测试和测试用例
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):
formatted_name = get_formatted_name('janis', 'joplin')
self.assertEqual(formatted_name, 'Janis Joplin') # 断言方法
unittest.main()
你可随便给这个类命名，但最好让它看起来与要测试的函数相关，并包含字样 Test 。这个类必须继承 unittest.TestCase 类，这样 Python 才知道如何运行你编写的测试。
NamesTestCase 只包含一个方法，用于测试 get_formatted_name() 的一个方面。我们将这个方法命名为 test_first_last_name() ，因为我们要核实的是只有名和姓的姓名能否被正确地格式化。我们运行 testname_function.py 时，所有以 test 打头的方法都将自动运行。在这个方法中，我们调用了要测试的函数，并存储了要测试的返回值。
在这个示例中，我们使用实参 'janis' 和 'joplin' 调用 get_formatted_name() ，并将结果存储到变量 formatted_name 中。
断言方法用来核实得到的结果是否与期望的结果一致。在这里，我们知道 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 时，得到的输出如下：
☁ test python test_name_function.py
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
第 1 行的句点表明有一个测试通过了。接下来的一行指出 Python 运行了一个测试所消耗的时间。最后的 OK 表明该测试用例中的所有单元测试都通过了。
上述输出表明，给定包含名和姓的姓名时，函数 get_formatted_name() 总是能正确地处理。修改 get_formatted_name() 后，可再次运行这个测试用例。如果它通过了，我们就知道在给定 Janis Joplin 这样的姓名时，这个函数依然能够正确地处理。
不能通过的测试
测试未通过时结果是什么样的呢？我们来修改 get_formatted_name() ，使其能够处理中间名，但这样做时，故意让这个函数无法正确地处理像 Janis Joplin 这样只有名和姓的姓名。
下面是函数 get_formatted_name() 的新版本，它要求通过一个实参指定中间名：
name_function.py
# coding:utf-8
def get_formatted_name(first, middle, last):
full_name = first + ' ' + middle + ' ' + last
return full_name.title()
这次运行程序 test_name_function.py 时，输出如下：
☁ test python test_name_function.py
E
======================================================================
ERROR: test_first_last_name (__main__.NamesTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
File "test_name_function.py", line 5, 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.001s
FAILED (errors=1)
添加新测试
编写一个测试，用于测试包含中间名的姓名。为此，我们在 NamesTestCase 类中再添加一个方法：
name_function.py
# coding:utf-8
def get_formatted_name(first, last, middle=''):
if middle:
full_name = first + ' ' + middle + ' ' + last
else:
full_name = first + ' ' + last
return full_name.title()
test_name_function.py
import unittest
from name_function import get_formatted_name
class NameTestCase(unittest.TestCase):
def test_first_last_name(self):
formatted_name = get_formatted_name('janis', 'joplin')
self.assertEqual(formatted_name, 'Janis Joplin')
def test_first_last_middle_name(self):
formatted_name = get_formatted_name('wolfgang', 'mozart', 'amadeus')
self.assertEqual(formatted_name, 'Wolfgang Amadeus Mozart')
unittest.main()
☁ test python test_name_function.py
..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK
测试类
各种断言方法
| 方法 | 用途 |
|---|---|
| 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
# coding:utf-8
class AnonymousSurvey():
""" 收集匿名调查问题的答案 """
def __init__(self, question):
""" 存储一个问题，并为存储答案做准备 """
self.question = question
self.response = []
def show_question(self):
"""显示调查问卷"""
print(self.question)
def store_response(self, new_response):
"""存储单份调查问卷"""
self.response.append(new_response)
def show_results(self):
"""显示收集到的所有答卷"""
print("Survey results:")
for response in self.response:
print('- ' + response)
为证明 AnonymousSurvey 类能够正确地工作，我们来编写一个使用它的程序：
language_survey.py
# coding:utf-8
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("\nThink you to everyone who participated in the survey!")
my_survey.show_results()
☁ test python language_survey.py
What language did you first learn to speak?
Enter 'q' at any time to quit.
Language: 潮汕话
Language: 普通话
Language: 粤语
Language: q
Think you to everyone who participated in the survey!
Survey results:
- 潮汕话
- 普通话
- 粤语
AnonymousSurvey 类可用于进行简单的匿名调查。假设我们将它放在了模块 survey 中，并想进行改进：让每位用户都可输入多个答案；编写一个方法，它只列出不同的答案，并指出每个答案出现了多少次；再编写一个类，用于管理非匿名调查。
进行上述修改存在风险，可能会影响 AnonymousSurvey 类的当前行为。例如，允许每位用户输入多个答案时，可能不小心修改了处理单个答案的方式。要确认在开发这个模块时没有破坏既有行为，可以编写针对这个类的测试。
测试 AnonymousSurvey 类
下面来编写一个测试，对 AnonymousSurvey 类的行为的一个方面进行验证：如果用户面对调查问题时只提供了一个答案，这个答案也能被妥善地存储。为此，我们将在这个答案被存储后，使用方法 assertIn() 来核实它包含在答案列表中：
test_survey.py
# coding:utf-8
import unittest
from survey import AnonymousSurvey
class TestAnonmyousSurvey(unittest.TestCase):
"""针对AnonymousSurvey类的测试"""
def test_store_single_response(self):
question = "What language dis you first learn to speak?"
my_survey = AnonymousSurvey(question)
my_survey.store_response('潮汕话')
self.assertIn('潮汕话', my_survey.response)
unittest.main()
☁ test python test_survey.py
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
测试通过，但只能收集一个答案的调查用途不大。下面来核实用户提供三个答案时，它们也将被妥善地存储。为此，我们在 TestAnonymousSurvey 中再添加一个方法：
test_survey.py
# coding:utf-8
import unittest
from survey import AnonymousSurvey
class TestAnonmyousSurvey(unittest.TestCase):
"""针对AnonymousSurvey类的测试"""
def test_store_single_response(self):
question = "What language dis you first learn to speak?"
my_survey = AnonymousSurvey(question)
my_survey.store_response('潮汕话')
self.assertIn('潮汕话', my_survey.response)
def test_store_three_response(self):
"""测试三个答案会被妥善地存储"""
question = "What language did you first learn to speak?"
my_survey = AnonymousSurvey(question)
responses = ['潮汕话', '普通话', '粤语']
for response in responses:
my_survey.store_response(response)
for response in responses:
self.assertIn(response, my_survey.response)
unittest.main()
☁ test python test_survey.py
..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK
前述做法的效果很好，但这些测试有些重复的地方。下面使用 unittest 的另一项功能来提高它们的效率。
方法 setUp()
在前面的 test_survey.py 中，我们在每个测试方法中都创建了一个 AnonymousSurvey 实例，并在每个方法中都创建了答案。 unittest.TestCase 类包含方法 setUp() ，让我们只需创建这些对象一次，并在每个测试方法中使用它们。如果你在 TestCase 类中包含了方法 setUp() ， Python 将先运行它，再运行各个以 test_ 打头的方法。这样，在你编写的每个测试方法中都可使用在方法 setUp() 中创建的对象了。
下面使用 setUp() 来创建一个调查对象和一组答案，供方法 test_store_single_response() 和 test_store_three_responses() 使用：
test_survey.py
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.response = ['潮汕话', '普通话', '粤语']
def test_store_single_response(self):
"""测试单个答案会被妥善地存储"""
self.my_survey.store_response(self.response[0])
self.assertIn(self.response[0], self.my_survey.response)
def test_store_three_responses(self):
"""测试三个答案会被妥善地存储"""
for response in self.response:
self.my_survey.store_response(response)
for response in self.response:
self.assertIn(response, self.my_survey.response)
unittest.main()
☁ test python test_survey.py
..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK
方法 setUp() 做了两件事情：创建一个调查对象；创建一个答案列表。存储这两样东西的变量名包含前缀 self （即存储在属性中），因此可在这个类的任何地方使用。这让两个测试方法都更简单，因为它们都不用创建调查对象和答案
测试自己编写的类时，方法 setUp() 让测试方法编写起来更容易：可在 setUp() 方法中创建一系列实例并设置它们的属性，再在测试方法中直接使用这些实例。相比于在每个测试方法中都创建实例并设置其属性，这要容易得多。
