《Python编程：从入门到实践》第 11 章 测试代码

目录

11.1 测试函数

11.1.1 单元测试和测试用例

11.1.2 可通过的测试

11.1.3 未通过的测试

11.1.4 测试未通过时怎么办

11.1.5 添加新测试

11.1.6 练习

练习11-1：城市和国家

练习11-2：人口数量

11.2 测试类

11.2.1 各种断言方法

11.2.2 一个要测试的类

11.2.3 测试AnonymousSurvey 类

11.2.4 方法setUp()

11.2.5 练习

练习11-3：雇员

---

 

11.1 测试函数

要学习测试，必须有要测试的代码。下面是一个简单的函数，它接受名和姓并返回整洁的姓名：

def get_formatted_name(first, last):
    """生成整洁的姓名。"""
    full_name = f"{first} {last}"
    return full_name.title()

 

函数 get_formatted_name() 将名和姓合并成姓名：在名和姓之间加上一个空格并将其首字母大写，再返回结果。为核实get_formatted_name() 像期望的那样工作，我们来编写一个使用该函数的程序。程序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(f"\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

从上述输出可知，合并得到的姓名正确无误。现在假设要修改get_formatted_name() ，使其还能够处理中间名。这样做时，要确保不破坏这个函数处理只含有名和姓的姓名的方式。为此，可在每次修改get_formatted_name() 后都进行测试：运行程序names.py，并输入像Janis Joplin这样的姓名。不过这太烦琐了。所幸Python提供了一种自动测试函数输出的高效方式。倘若对g et_formatted_name() 进行自动测试，就能始终确信当提供试过的姓名时，该函数都能正确工作。

11.1.1 单元测试和测试用例

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

11.1.2 可通过的测试

你需要一段时间才能习惯创建测试用例的语法，但创建测试用例之后，再添加针对函数的单元测试就很简单了。要为函数编写测试用例，可先导入模块 unittest 和要测试的函数，再创建一个继承unittest.TestCase 的类，并编写一系列方法对函数行为的不同方面进行测试。

下面的测试用例只包含一个方法，它检查函数 get_formatted_name() 在给定名和姓时能否正确工作：

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

if __name__ == '__main__':
    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_ 打头的方法都将自动运行。在这个方法中，调用了要测试的函数。在本例中，使用实参 'janis' 和 'joplin' 调用 get_formatted_name() ，并将结果赋给变量formatted_name 。

使用了 unittest 类最有用的功能之一： 断言 方法。断言方法核实得到的结果是否与期望的结果一致。在这里，我们知道 get_formatted_name() 应返回名和姓首字母大写且之间有一个空格的姓名，因此期望 formatted_name 的值为Janis Joplin 。为检查是否确实如此，我们调用 unittest 的方法assertEqual() ，并向它传递 formatted_name 和 'Janis Joplin' 。代码行

self.assertEqual(formatted_name, 'Janis Joplin')

的意思是：“将 formatted_name 的值与字符串 'Janis Joplin' 比较。如果它们相等，那么万事大吉；如果它们不相等，就告诉我一声！”

我们将直接运行这个文件，但需要指出的是，很多测试框架都会先导入测试文件再运行。导入文件时，解释器将在导入的同时执行它。 if 代码块检查特殊变量__name__ ，这个变量是在程序执行时设置的。如果这个文件作为主程序执行，变量 __name__ 将被设置为 '__main__' 。在这里，调用 unittest.main() 来运行测试用例。如果这个文件被测试框架导入，变量 __name__ 的值将不是 '__main__' ，因此不会调用 unittest.main() 。

运行test_name_function.py时，得到的输出如下：

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

OK

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

上述输出表明，给定包含名和姓的姓名时，函数 get_formatted_name() 总是能正确地处理。修改 get_formatted_name() 后，可再次运行这个测试用例。如果它通过了，就表明给定Janis Joplin这样的姓名时，该函数依然能够正确地处理。

11.1.3 未通过的测试

测试未通过时结果是什么样的呢？我们来修改get_formatted_name() ，使其能够处理中间名，但同时故意让该函数无法正确处理像Janis Joplin这样只有名和姓的姓名。

下面是函数 get_formatted_name() 的新版本，它要求通过一个实参指定中间名：

def get_formatted_name(first, middle, last):
    """生成整洁的姓名。"""
    full_name = f"{first} {middle} {last}"
    return full_name.title()

这个版本应该能够正确处理包含中间名的姓名，但对其进行测试时，我们发现它不再能正确处理只有名和姓的姓名。这次运行程序test_name_function.py时，输出如下：

❶ E
 =======================