Class - 11 测试函数

Posted 2021-01-07 mack-yang

编写函数或类时，还可为其编写测试。通过测试，可确定代码面对各种输入都能够按要求的那样工作。测试让你信心满满，深信即便有更多的人使用你的程序，它也能正确地工作。在程序中添加新代码时，你也可以对其进行测试，确认它们不会破坏程序既有的行为。程序员都会犯错，因此每个程序员都必须经常测试其代码，在用户发现问题前找出它们。
本章中，将学习如何使用 Python 模块 unittest 中的工具来测试代码。将学习编写测试用例，核实一系列输入都将得到预期的输出。你将看到测试通过了是什么样子，测试未通过又是什么样子，还将知道测试未通过如何有助于改进代码。你将学习如何测试函数和类，并将知道该为项目编写多少个测试。

11.1 测试函数

下面是一个简单的函数，它接受名和姓并返回整洁的姓名：

name_function.py

def get_formatted_name(first, last):
    """Generate a neatly formatted full name"""
    full_name = 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("
Please 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("	Neatly formatted name: "+ formatted_name +".")

输出：
Enter ‘q‘ at any time to quit.

Please give me a first name: Yang
Please give me a last name: Mack
        Neatly formatted name: Yang Mack.

Please give me a first name: q

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

11.1.1 单元测试和测试用例

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

11.1.2 可通过的测试

创建测试用例的语法需要一段时间才能习惯，但测试用例创建后，再添加针对函数的单元测试就很简单了。要为函数编写测试用例，可先导入模块 unittest 以及要测试的函数，再创建一个继承 unittest.TestCase 的类，并编写一系列方法对函数行为的不同方面进行测试。
下面是一个只包含一个方法的测试用例，它检查函数 get_formatted_name() 在给定名和姓时能否正确地工作：

test_name_function.py

import unittest
from name_function import get_formatted_name

class NameTestCase(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‘)
unittest.main()

首先，我们导入了模块 unittest 和要测试的函数 get_formatted_name() 。在class NamesTestCase(unittest.TestCase)处，我们创建了一个名为 NamesTestCase 的类，用于包含一系列针对get_formatted_name() 的单元测试。你可随便给这个类命名，但最好让它看起来与要测试的函数相关，并包含字样 Test 。这个类必须继承 unittest.TestCase 类，这样 Python 才知道如何运行你编写的测试。

NamesTestCase 只包含一个方法，用于测试 get_formatted_name() 的一个方面。我们将这个方法命名为 test_first_last_name() ，因为我们要核实的是只有名和姓的姓名能否被正确地格式化。我们运行 testname_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‘ 进行比较，如果它们相等，就万事大吉，如果它们不相等，跟我说一声！ ”
代码行 unittest.main() 让 Python 运行这个文件中的测试。运行 test_name_function.py 时，得到的输出如下：

.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

第 1 行的句点表明有一个测试通过了。接下来的一行指出 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):
    """Generate a neatly formatted full name."""
    full_name = first +‘ ‘+middle+‘ ‘+last
    return full_name.title()

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

E
======================================================================
ERROR: test_first_last_name (__main__.NameTestCase)                  ------- 2
----------------------------------------------------------------------
Traceback (most recent call last):
  File "test_name_funtcion.py", line 9, 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)   --------------- 5

其中包含的信息很多，因为测试未通过时，需要让你知道的事情可能有很多。第 1 行输出只有一个字母 E，它指出测试用例中有一个单元测试导致了错误。我们看到 NamesTestCase 中的 test_first_last_name() 导致了错误（见2）。测试用例包含众多单元测试时，知道哪个测试未通过至关重要。接下来，我们看到了一个标准的 traceback，它指出函数调用 get_formatted_name(‘janis‘, ‘joplin‘) 有问题，因为它缺少一个必不可少的位置实参。
最后，还看到了一条消息，它指出整个测试用例都未通过，因为运行该测试用例时发生了一个错误（见5）。这条消息位于输出末尾，让你一眼就能看到.

11.1.4 测试未通过时处理办法

测试未通过时，不要修改测试，而应修复导致测试不能通过的代码：检查刚对函数所做的修改，找出导致函数行为不符合预期的修改。

在这个示例中， get_formatted_name() 以前只需要两个实参 —— 名和姓，但现在它要求提供名、中间名和姓。新增的中间名参数是必不可少的，这导致 get_formatted_name() 的行为不符合预期。就这里而言，最佳的选择是让中间名变为可选的。这样做后，使用类似于 Janis Joplin 的姓名进行测试时，测试就会通过了，同时这个函数还能接受中间名。下面来修改 get_formatted_name() ，将中间名设置为可选的，然后再次运行这个测试用例。如果通过了，我们接着确认这个函数能够妥善地处理中间名。
要将中间名设置为可选的，可在函数定义中将形参 middle 移到形参列表末尾，并将其默认值指定为一个空字符串。我们还要添加一个 if 测试，以便根据是否提供了中间名相应地创建姓名：

name_function.py

def get_formatted_name(first, last, middle=‘‘):
    """Generate a neatly formatted full name"""
    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.000s

OK

测试用例通过了，这意味着这个函数又能正确地处理像 Janis Joplin 这样的姓名了，而且无需手工测试这个函数。这个函数很容易就修复了，因为未通过的测试让我们得知新代码破坏了函数原来的行为。

11.1.5 添加新测试

确定 get_formatted_name() 又能正确地处理简单的姓名后，我们再编写一个测试，用于测试包含中间名的姓名。为此，我们在 NamesTestCase 类中再添加一个方法：

import unittest
from name_function import get_formatted_name

class NmaeTestCase(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‘)
    
    def test_first_last_name(self):
        """能够正确处理像Wolfgang Amadeus Mozart这样的姓名？"""
        formatted_name = get_formatted_name(
            ‘wolfgang‘, ‘mozart‘, ‘amadeus‘)
        self.assertEqual(formatted_name, ‘Wolfgang Amadeus Mozart‘)
        
unittest.main()

我们将这个方法命名为 test_first_last_middle_name() 。方法名必须以 test_ 打头，这样它才会在我们运行 test_name_function.py 时自动运行。这个方法名清楚地指出了它测试的是 get_formatted_name() 的哪个行为，这样，如果该测试未通过，我们就会马上知道受影响的是哪种类型的姓名。在 TestCase 类中使用很长的方法名是可以的；这些方法的名称必须是描述性的，这才能让你明白测试未通过时的输出；这些方法由 Python 自动调用，你根本不用编写调用它们的代码。
为测试函数 get_formatted_name() ，我们使用名、姓和中间名调用它（见?），再使用 assertEqual() 检查返回的姓名是否与预期的姓名（名、中间名和姓）一致。我们再次运行 test_name_function.py 时，两个测试都通过了：

.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

11.2 测试类

很多程序中都会用到类，因此能够证明你的类能够正确地工作会大有裨益。如果针对类的测试通过了，你就能确信对类所做的改进没有意外地破坏其原有的行为。

11.2.1 各种断言方法

Python 在 unittest.TestCase 类中提供了很多断言方法。前面说过，断言方法检查你认为应该满足的条件是否确实满足。如果该条件确实满足，你对程序行为的假设就得到了确认，你就可以确信其中没有错误。如果你认为应该满足的条件实际上并不满足， Python 将引发异常。
表 11-1 描述了 6 个常用的断言方法。使用这些方法可核实返回的值等于或不等于预期的值、返回的值为 True 或 False 、返回的值在列表中或不在列表中。你只能在继承 unittest.TestCase 的类中使用这些方法，下面来看看如何在测试类时使用其中的一个。

表 11-1 　 unittest Module 中的断言方法 

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

 

 

 

 

 

 

 

 

 

 

12.3 小结

在本章中，你学习了：如何使用模块 unittest 中的工具来为函数和类编写测试；如何编写继承 unittest.TestCase 的类，以及如何编写测试方法，以核实函数和类的行为符合预期；如何使用方法 setUp() 来根据类高效地创建实例并设置其属性，以便在类的所有测试方法中都可使用它们。
测试是很多初学者都不熟悉的主题。作为初学者，并非必须为你尝试的所有项目编写测试；但参与工作量较大的项目时，你应对自己编写的函数和类的重要行为进行测试。这样你就能够更加确定自己所做的工作不会破坏项目的其他部分，你就能够随心所欲地改进既有代码了。如果不小心破坏了原来的功能，你马上就会知道，从而能够轻松地修复问题。相比于等到不满意的用户报告 bug 后再采取措施，在测试未通过时采取措施要容易得多。
如果你在项目中包含了初步测试，其他程序员将更敬佩你，他们将能够更得心应手地尝试使用你编写的代码，也更愿意与你合作开发项目。如果你要跟其他程序员开发的项目共享代码，就必须证明你编写的代码通过了既有测试，通常还需要为你添加的新行为编写测试。
请通过多开展测试来熟悉代码测试过程。对于自己编写的函数和类，请编写针对其重要行为的测试，但在项目早期，不要试图去编写全覆盖的测试用例，除非有充分的理由这样做。