测试代码：

编写函数或类时，还可以为其编写测试。

通过测试，可确定代码面对各种输入都能按要求的那样工作。

本章中，你将学习如何使用Python模块unittest中的工具来测试代码。

你将学习编写测试用例，核实一系列输入都将得到预期的输出。

你将看到测试通过了是什么样子，测试未通过又是什么样子；还将知道测试未通过如何有助于改进代码。

你将学习如何测试函数和类，并将知道改为项目编写多少个测试。

1、测试函数：

下例是一段被测试代码，他接受名和姓并返回简洁的姓名：

例1、name_function.py:

def get_formatted_name(first,last):
    """Generate a neatly formatted full name."""
    full_name = first + ' ' + last
    return full_name.title()

下面程序name.py让用户输入名和姓，并显示整洁的全名：

例2、name.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("\ tNeatly formatted name: " + formatted_name + '.')

1.1、单元测试和测试用例：

Python标准库中的模块unittest提供了代码测试工具。

单元测试用于核实函数的某个方面没有问题；

测试用例是一组单元测试，这些单元测试一起核实函数在各种情形下的行为都符合要求。良好的测试用例考虑到了函数可能收到的各种输入，包含针对这些情形的测试；

全覆盖式测试用例包含一整套单元测试，涵盖了各种可能的函数使用方式。

对于大型项目，要实现全覆盖可能很难。通常，最初只要针对代码的重要行为编写测试即可，等项目被广泛使用时在考虑全覆盖。

1.2、可通过的测试：

创建测试用例的语法需要一段时间才能习惯，但测试用例创建后，再添加针对函数的单元测试就很简单了。

要为函数编写测试用例，可先导入模块unittest以及要测试的函数；再创建一个继承unnittest.TestCase的类，并编写一系列方法对函数行为的不同方面进行测试。

例3、test_name_function.py

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')
        unittest.main()

程序分析：

• 首先导入模块unittest和要测试的函数get_formatted_name()。

• 在①处，我们创建了一个名为NamesTestCase的类，用于包含一系列针对get_formatted_name()的单元测试。这个类必须继承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。

• 为检查是否确实如此，我们调用unitest的方法assertEqual()，并向它传递formatted_name和'Janis Joplin'。代码行self.assertEqual(formatted_name,'Janis Joplin')的意思时说：“将formatted_name的值同字符串’Janis Joplin’进行比较，如果它们相等，就万事大吉，如果它们不相等，跟我说一声。”

• 输出结果：

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

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

上述输出表明，给定包含名和姓的姓名时，函数get_formatted_name()总能正确地处理。

1.3、不能通过的测试：

修改get_formatted_name(),使其能够处理中间名，但这样做时，故意让函数无法正确处理想Janis Joplin这样只有名和姓的姓名。

修改后的name_function.py:

def get_formatted_name(first,middle,last):
    """生成整洁的姓名"""
    full_name = first + ' ' + middle + ' ' + last
    return full_name.title()

运行程序test_name_function.py

❶ E 
= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
❷ ERROR: test_first_last_name (__main__. NamesTestCase)
    ----------------------------------------------------------------------
❸ Traceback (most recent call last): 
    File "test_name_function.py", line 8, 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.000s
        
❺ FAILED (errors = 1)

运行结果输出分析：

• 第1行输出只有一个字母E(见①)，它指出测试用例中有一个单元测试导致了错误。
• 接下来，我们看到NamesTestCase中的test_first_last_nmae()导致了错误。(见②)
• 测试测试用例包含众多单元测试时，知道那个测试未通过至关重要。
• 在③处，我们看到了一个标准的traceback,它指出函数调用get_formatted_nmae('janis','joplin')有问题，因为它缺少一个必不可少的位置实参。
• 在④处，我们还看到运行了一个单元测试。
• 最后⑤处，还看到了一条消息，它指出整个测试用例都未通过，因为运行该测试用例时发生了一个错误。

1.4、测试未通过时怎么办：

测试未通过时，不要修改测试，而应修复导致测试不能通过的代码:

检查刚对函数所做的修改，找出导致函数行为不符合预期的修改。

修改后的name_function.py:

def get_formatted_name(first,last,middle=''):
    """生成整洁的姓名"""
    if middle:
        full_name = first + ' ' + middle + ' ' + last
    else:
        full_name = first + ' ' + last
    return full_name.title()

在 get_formatted_name() 的 这 个 新 版 本 中， 中 间名 是 可 选 的。 如 果 向 这 个 函 数 传 递 了 中 间 名（ if middle: ）， 姓 名 将 包 含 名、 中 间 名 和 姓， 否 则 姓 名 将 只 包 含 名 和 姓。 现 在， 对 于 两 种 不 同 的 姓 名， 这 个 函 数 都 应 该 能 够 正 确 地 处 理。

1.5、添加新测试：

再 编 写 一 个 测 试， 用 于 测 试 包 含 中 间 名 的 姓 名。 为 此， 我 们 在 NamesTestCase 类 中 再 添 加 一 个 方 法：

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

本章代码示例来自：[美] Eric Matthes. Python编程：从入门到实践