编写函数或类时,还可为其编写测试。通过测试,可确定代码面对各种输入都能够按要求的那样工作。在程序中添加新代码时,你也可以对其进行测试,确认它们不会破坏程序既有的行为。
在本章中,你将学习如何使用Python模块unittest中的工具来测试代码。
重点学习对象:
1. 编写测试用例,核实一系列输入都将得到预期的输出。
2. 测试通过和测试未通过的场景
3. 测试未通过如何有助于改进代码
4. 如何测试函数和类
5. 该为项目编写多少个测试。
11.1 测试函数
Python提供了一种自动测试函数输出的高效方式。
11.1.1 单元测试和测试用例
Python标准库中的模块unittest提供了代码测试工具。
单元测试:
单元测试用于核实函数的某个方面没有问题。
测试用例:
测试用例是一组单元测试,这些单元测试一起核实函数在各种情形下的行为都符合要求。
全覆盖式测试用例:
全覆盖式测试用例包含一整套单元测试,涵盖了各种可能的函数使用方式。
11.1.2 可通过的测试
测试用例创建后,再添加针对函数的单元测试就很简单了。
要为函数编写测试用例,可先导入模块unittest以及要测试的函数,再创建一个继承unittest.TestCase的类,并编写一系列方法对函数行为的不同方面进行测试。
1. 首先,导入了模块unittest和要测试的函数
2. 创建一个名为NamesTestCase的类,用于包含针对函数的单元测试,必须包含字样Test。这个类必须继承unittest.TestCase类,这样Python才知道如何运行你编写的测试。
3. NamesTestCase只包含一个方法,用于测试get_formatted_name()的一个方面。我们将这个方法命名为test_first_last_name(),因为我们要核实的是只有名和姓的姓名能否被正确地格式化。
4. 我们运行test_name_function.py时,所有以test_打头的方法都将自动运行。在这个方法中,我们调用了要测试的函数,并存储了要测试的返回值
5. ,我们使用实参'janis'和'joplin'调用get_formatted_name(),并将结果存储到变量formatted_name中
6. 使用了unittest类最有用的功能之一:断言方法
断言方法:
断言方法用来核实得到的结果是否与期望的结果一致。
为检查是否确实如此,我们调用unittest的方法assertEqual(),并向它传递formatted_name和'Janis Joplin'。
代码行self.assertEqual(formatted_name, 'Janis Joplin')的意思是说:
“将formatted_name的值同字符串'Janis Joplin'进行比较,如果它们相等,就万事大吉,如果它们不相等,跟我说一声!”
7. 代码行unittest.main()让Python运行这个文件中的测试。
运行后的测试结果如下:
第1行的句点表明有一个测试通过了。
接下来的一行指出Python运行了一个测试,消耗的时间不到0.001秒。
最后的OK表明该测试用例中的所有单元测试都通过了。
11.1.3 不能通过的测试
第1行输出只有一个字母E(见Ø),它指出测试用例中有一个单元测试导致了错误。
第2行我们看到NamesTestCase中的test_first_last_name()导致了错误。
测试用例包含众多单元测试时,知道哪个测试未通过至关重要。
第3行我们看到了一个标准的traceback,它指出函数调用get_formatted_name('janis', 'joplin')有问题,因为它缺少一个必不可少的位置实参。
第4行我们还看到运行了一个单元测试。
第5行指出整个测试用例都未通过,因为运行该测试用例时发生了一个错误。
11.1.4 测试未通过时怎么办
测试未通过时,测试未通过意味着你编写的新代码有错,不要修改测试,而应修复导致测试不能通过的代码:检查刚对函数所做的修改,找出导致函数行为不符合预期的修改。
11.2 测试类
编写针对类的测试,如果针对类的测试通过了,你就能确信对类所做的改进没有意外地破坏其原有的行为。
11.2.1 各种断言方法
Python在unittest.TestCase类中提供了很多断言方法
断言方法检查你认为应该满足的条件是否确实满足。
如果该条件确实满足,你对程序行为的假设就得到了确认,你就可以确信其中没有错误。
如果你认为应该满足的条件实际上并不满足,Python将引发异常。
6个常用的断言方法,你只能在继承unittest.TestCase的类中使用这些方法
11.2.2 一个要测试的类
类的测试与函数的测试相似——你所做的大部分工作都是测试类中方法的行为
AnonymousSurvey类可用于进行简单的匿名调查,
编写一个方法,它只列出不同的答案,并指出每个答案出现了多少次;再编写一个类,用于管理非匿名调查。
要确认在开发这个模块时没有破坏既有行为,可以编写针对这个类的测试。
11.2.3 测试AnonymousSurvey 类
下面来编写一个测试,对AnonymousSurvey类的行为的一个方面进行验证:如果用户面对调查问题时只提供了一个答案,这个答案也能被妥善地存储。为此,我们将在这个答案被存储后,使用方法assertIn()来核实它包含在答案列表中:
11.2.4 方法setUp()
unittest.TestCase类包含方法setUp(),让我们只需创建这些对象一次,并在每个测试方法中使用它们。
如果在TestCase类中包含了方法setUp(),Python将先运行它,再运行各个以test_打头的方法。
测试自己编写的类时,方法setUp()让测试方法编写起来更容易:可在setUp()方法中创建一系列实例并设置它们的属性,再在测试方法中直接使用这些实例。相比于在每个测试方法中都创建实例并设置其属性,这要容易得多。
注意
运行测试用例时,每完成一个单元测试,Python都打印一个字符:测试通过时打印一个句点;测试引发错误时打印一个E;测试导致断言失败时打印一个F。这就是你运行测试用例时,在输出的第一行中看到的句点和字符数量各不相同的原因。如果测试用例包含很多单元测试,需要运行很长时间,就可通过观察这些结果来获悉有多少个测试通过了。
本章学习小结:
1. 使用模块unittest中的工具来为函数和类编写测试
2. 编写继承unittest.TestCase的类
3. 编写测试方法,以核实函数和类的行为符合预期
4. 使用方法setUp()来根据类高效地创建实例并设置其属性,以便在类的所有测试方法中都可使用它们。