第二十七节 测试类

11.1 测试类

在本章前半部分，你编写了针对单个函数的测试，下面来编写针对类的测试。很多程序中都会用到类，因此证明你的类能够正确工作大有裨益。如果针对类的测试通过了，你就能确信对类所做的改进没有意外地破坏其原有的行为。

11.1.1 各种断言方法

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

表11-1描述了6个常用的断言方法。使用这些方法可核实返回的值等于或不等于预期的值，返回的值为True 或False ，以及返回的值在列表中或不在列表中。只能在继承unittest.TestCase 的类中使用这些方法，随后来看看如何在测试类时使用其中之一。

表11-1unittest模块中的断言方法

方法	用途
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 中

11.1.2 一个要测试的类

类的测试与函数的测试相似，你所做的大部分工作是测试类中方法的行为。不过还是存在一些不同之处，下面编写一个要测试的类。来看一个帮助管理匿名调查的类：

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)
    def show_results(self):❹
        """显示收集到的所有答卷。"""
        print("Survey results:")
        for response in self.responses:
            print(f"- {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.\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()

这个程序定义了一个问题（"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: chinese
Language: english
Language: france
Language: q

Thank you to everyone who participated in the survey!
Survey results:
- chinese
- english
- france

AnonymousSurvey 类可用于进行简单的匿名调查。假设我们将它放在了模块survey 中，并想进行改进：让每位用户都可输入多个答案；编写一个方法，只列出不同的答案并指出每个答案出现了多少次；再编写一个类，用于管理非匿名调查。

进行上述修改存在风险，可能影响AnonymousSurvey 类的当前行为。例如，允许每位用户输入多个答案时，可能会不小心修改处理单个答案的方式。要确认在开发这个模块时没有破坏既有行为，可以编写针对这个类的测试。

11.1.3 测试AnonymousSurvey 类

下面来编写一个测试，对AnonymousSurvey 类的行为的一个方面进行验证：如果用户面对调查问题只提供一个答案，这个答案也能被妥善地存储。为此，我们将在  这个答案被存储后，使用方法assertIn() 来核实它确实在答案列表中：

test_survey.py

import unittest
from survey import AnonymousSurvey

class TestAnonymousSurvey(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)❹
        
if __name__ == '__main__':
    unittest.main()

首先导入模块unittest和要测试的类AnonymousSurvey。将测试用例命名为TestAnonymousSurvey，它也继承了unittest.TestCase（见❶）。第一个测试方法验证：调查问题的单个答案被存储后，会包含在调查结果列表中。对于这个方法，一个不错的描述性名称是test_store_single_response()（见

❷）。如果这个测试未通过，我们就能通过输出中的方法名得知，在存储单个调查答案方面存在问题。

要测试类的行为，需要创建其实例。在❸处，使用问题"What language did you first learn to speak?" 创建一个名为my_survey 的实例，然后使用方法store_response() 存储单个答案English 。接下来，检查English 是否包含在列表my_survey.responses 中，以核实这个答案是否被妥善地存储了（见❹）。

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

.
----------------------------------------------------------------------
Ran 1 test in 0.011s

OK

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

import unittest
from survey import AnonymousSurvey

class TestAnonymousSurvey(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)
 ❶       
    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)
        
if __name__ == '__main__':
    unittest.main()

我们将该方法命名为test_store_three_responses() ，并像对test_store_single_response() 所做的一样，在其中创建一个调查对象。定义一个包含三个不同答案的列表（见❶），再对其中每个答案调用store_response() 。存储这些答案后，使用一个循环来确认每个答案都包含在my_survey.responses 中（见❷）。再次运行test_survey.py时，两个测试（针对单个答案的测试和针对三个答案的测试）都通过了：

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

OK

前述做法的效果很好，但这些测试有些重复的地方。下面使用unittest 的另一项功能来提高其效率。

11.2.4 方法setUp()

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

下面使用setUp() 来创建一个调查对象和一组答案，供方法test_store_single_response() 和test_store_three_responses() 使用：

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_response(self):
        #测试三个答案会被妥善地存储。
        for response in self.responses:
            self.my_survey.store_response(response)
        for response in self.responses:
            self.assertIn(response,self.my_survey.responses)
if __name__ == '__main__':
    unittest.main()

方法setUp() 做了两件事情：创建一个调查对象（见❶），以及创建一个答案列表（见❷）。存储这两样东西的变量名包含前缀self（即存储在属性中），因此可在这个类的任何地方使用。这让两个测试方法都更简单，因为它们都不用创建调查对象和答案了。方法test_store_single_response() 核实self.responses 中的第一个答案self.responses[0] 被妥善地存储，而方法test_store_three_response() 核实self.responses 中的全部三个答案都被妥善地存储。

再次运行test_survey.py时，这两个测试也都通过了。如果要扩展AnonymousSurvey ，使其允许每位用户输入多个答案，这些测试将很有用。修改代码以接受多个答案后，可运行这些测试，确认存储单个答案或一系列答案的行为未受影响。

测试自己编写的类时，方法setUp() 让测试方法编写起来更容易：可在setUp() 方法中创建一系列实例并设置其属性，再在测试方法中直接使用这些实例。相比于在每个测试方法中都创建实例并设置其属性，这要容易得多。

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

动手试一试

练习11-3：雇员

编写一个名为Employee 的类，其方法__init__() 接受名、姓和年薪，并将它们存储在属性中。编写一个名为give_raise() 的方法，它默认将年薪增加5000美元，但也能够接受其他的年薪增加量。

为Employee 编写一个测试用例，其中包含两个测试方法： test_give_default_raise() 和test_give_custom_raise() 。使用方法setUp() ，以免在每个测试方法中都新建雇员实例。运行这个测试用例， 确认两个测试都通过了。

11.2 小结

在本章中，你学习了：

如何使用模块unittest 中的工具来为函数和类编写测试；

如何编写继承unittest.TestCase 的类，以及如何编写测试方法，以核实函数和类的行为符合预期；

如何使用方法setUp() 来根据类高效地创建实例并设置其属性，以便在类的所有测试方法中使用。

测试是很多初学者不熟悉的主题。作为初学者，并非必须为你尝试的所有项目编写测试。然而参与工作量较大的项目时，你应该对自己所编写函数和类的重要行为进行测试。这样你就能够更加确定自己所做的工作不会破坏项目的其他部分，从而自由地改进既有代码。如果不小心破坏了原来的功能，你马上就会知道，而且能够轻松地修复问题。比起等到不满意的用户报告bug后再采取措施，在测试未通过时采取措施要容易得多。

如果你在项目中包含了初步测试，将得到其他程序员的尊敬。他们不仅能够更得心应手地使用你编写的代码，也更愿意与你合作开发项目。如果要跟其他程序员开发的项目共享代码，就必须证明你编写的代码通过了既有测试，通常还需要为你添加的新行为编写测试。

请通过多开展测试来熟悉代码测试过程。对于自己编写的函数和类，请编写针对其重要行为的测试。不过不要在项目早期试图编写全覆盖的测试用例，除非有充分的理由。