Python:测试代码

Python : 测试代码

• 编写函数或类时，还可为其编写测试
• 通过测试，可确定代码面对各种输入都能够按要求的那样工作

1 测试函数

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

name_function.py

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

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

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("\nPlease give me a last name: ")
    if last == 'q':
        break
    
    formatted_name = get_formatted_name(first, last)
    print("\tNeatly formatted name: " + formatted_name + ".")

执行程序，得到的输出结果正确无误：

• 现在假设要修改get_formatted_name()，使其还能处理中间名。这样做时，我们要确保不破坏这个函数处理只有名和姓的姓名的方式。为此，可以再每次修改get_formatted_name()后都进行测试：运行names.py，输入first、last，但这太繁琐了
• 所幸Python提供了一种自动测试函数输出的高效方式

1.1 单元测试和测试用例

• Python标准库中的模块unittest提供了代码测试工具
• 单元测试用于核实函数的某个方面没有问题
• 测试用例是一组单元测试，这些单元测试一起核实函数在各种情形下的行为都符合要求
• 全覆盖式测试用例包含一整套单元测试，涵盖了各种可能的函数使用方式

1.2 可通过的测试

• 要为函数编写测试用例，可先导入模块unittest以及要测试的函数，再创建一个继承unittest.TestCase的类，并编写一系列方法对函数行为的不同方面进行测试
• 下面时一个只包含一个方法的测试用例，它检查函数get_formatted_name()在给定名和姓时能否正确地工作：

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()的单元测试；NamesTestCase类必须继承unittest.TestCase类，这样Python才知道如何运行你编写的测试
  注： 你可随便给这个类命名，但最好有意义，并包含Test字样
• NamesTestCase只包含一个方法，用于测试get_formatted_name()的一个方面
  • 我们将这个方法命名为test_first_last_name()，因为我们要核实的是只有名和姓的姓名能否被正确地格式化
• 我们运行test_name_function.py时，所有以test_打头的方法都将自动运行
• 使用实参'janis'和'joplin'调用get_formatted_name()，并将结果存储到变量formatted_name中
• unittest类最用的功能之一： 一个 断言方法
  • 断言方法用来核实得到的结果是否与期望的结果一致
  • 为检查是否确实如此，调用unittest的方法assertEqual()
• self.assertEqual(formatted_name, 'Janis Joplin')的意思是说：将formatted_name的值同字符串’Janis Joplin’ 进行比较，如果它们相等，就大吉大利，如果不相等就告诉我一声
• unittest.main()让Python运行这个文件中的测试
  
• 第一行的句点表面有一个测试通过了；接下来的一行指出Python运行了一个测试，消耗的时间不到0.001s；最后的Ok表明该测试用例中的所有单元测试都通过了

1.3 不能通过的测试

• 测试未通过时结果是啥样的呢？
• 下面时函数get_formatted_name()的新版本，它要求通过一个实参指定中间名:

name_function.py

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

• 这个版本应该能正确处理包含中间名的姓名，但它再也不能正确地处理只有名和姓地姓名。所以这次的输出如下：
  
  • 测试未通过时，需要让你知道的事情可能有很多
  • 第1行输出只有一个字母E，它指出测试用例中有一个单元测试导致了错误
  • 接下来，我们看到NameTestCase中的test_first_last_name()导致了错误
  • 测试用例包含众多单元测试时，知道哪个测试未通过至关重要
  • 我们看到了一个标准的traceback，它指出函数调用get_formatted_name(‘janis’, ‘joplin’)有问题，因为它缺少一个必不可少的位置实参
  • 最后还看到了一条信息，它指出整个测试用例都未通过，因为运行该测试用例时发生了一个错误FAILED (errors=1)

1.4 测试未通过时怎么办

• 测试未通过时怎么办呢？
• 答： 不要修改测试，而应修复导致测试不能通过的代码——检查刚对函数所做的修改，找出导致函数行为不符合预期的修改
• get_formatted_name()以前只需要两个实参——名和姓，但现在它要求提供名、中间名和姓。新增的中间名参数是必不可少的，这导致get_formatted_name()的行为不符合预期。目前最佳的选择是让中间名变为可选的
• 下面来修改get_formatted_name(0，将中间名设置为可选的，然后再次运行这个测试用例
  • 要将中间名设置为可选，可在函数定义中将形参middle移到形参列表末尾，并将其默认值指定为一个空字符串：

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

• 现在，测试用例通过了。

1.5 添加新测试

• 确定get_test_name() 又能正确地处理简单的姓名后，我们再编写一个测试，用于测试包含中间名的姓名:

class NamesTestCase(unittest.TestCase):
    """测试name_function.py"""
    
    def test_first_last_name(self):
        formatted_name = get_formatted_name('janis', 'joplin')
        self.assertEqual(formatted_name, 'Janis Joplin')
        
    def test_first_last_middle_name(self):
        formatted_name = get_formatted_name(
            'wolfgang', 'mozart', 'amadeus')
        self.assertEqual(formatted_name, 'Wolfgang Amadeus Mozart')
        
unittest.main()

• 我们将这个方法命名为test_first_middle_last_name() 。方法名必须以test_打头, 这样它才会在我们运行.py时自动运行
  注1： 在TestCase类中使用很长的方法名是可以的；这些方法的名称必须是描述性的，这才能让你明白测试未通过时的输出
  注2： 这些方法由Python自动调用，你根本不用编写调用它们的代码
  
• 后面两个练习（11-1、11-2）难度不大，学习过上述示例就可以比较轻松完成，这里就不放出来了。

2 测试类

• 上半部分，编写了针对单个函数的测试，下面来编写针对类的测试

2.1 各种断言方法

• Python在unittest.TestCase类中提供了很多断言方法
  • 断言方法检查你认为应该满足的条件是否确实满足
• 下面描述了6个常用的断言方法
  • 使用这些方法可核实返回的值等于或不等于预期的值、返回的值为True或False、返回的值在不在列表中
  • 只能在继承unittest.TestCase的类中使用这些方法

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

2.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 responses:
            print('- ' + response)

• 为证明AnonymousSurvey类能够正确地工作，下面来编写一个使用它的程序：

language_survey.py

from survey import AnonymousSurvey

# 定义一个问题，并创建一个表示调查的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()

• 输出调查结果：

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

• 我们首先导入了模块unittest以及要测试地类AnonymousSurvey
  • 将测试用例命名为TestAnonymousSurvey，它也继承了unittest.TestCase
  • 第一个测试方法验证调查问题地单个答案被存储后，会包含在调查结果列表中
  • 要测试类的行为，需要创建其实例
  • 使用方法store_response()存储了单个答案English
  • 接下来，我们检查English是否包含在列表my_survey.responses中，以核实这个答案是否被妥善地存储了
• 下面, 来核实用户提供三个答案时，它们也将被妥善地存储
• 为此，我们在TestAnonymousSurvey中再添加一个方法：

class TestAnonymousSurvey(unittest.TestCase):
    """针对AnonymousSurvey类的测试"""
	def test_store_single_response(self):
        """测试单个答案会被妥善地存储"""
		--snip--
		
    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)

• 再次运行.py时，两个测试都通过了：
  
• 前面的做法效果很好，但这些测试有些重复的地方。下面使用unittest的另一项功能来提高它们的效率

2.4 方法setUp()

• unittest.TestCase类包含方法setUp()，让我们只需创建这些对象一次，并在每个测试方法中使用它们
• 如果你再TestCase类中包含了方法setUp()，Python将先运行它，再运行各个以test_打头的方法

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('English', self.my_survey.responses)
        
    def test_store_three_responses(self):
        """测试三个答案会被妥善地存储"""
        for response in self.responses:
            self.my_survey.store_response(response)
        for response in self.responses:
            self.assertIn(response, self.my_survey.responses)
        
unittest.main()

输出结果如下：

• 方法setUp()做了两件事情：创建一个调查对象；创建一个答案列表。存储这两样东西的变量名包含前缀self（即存储在属性中），因此可在这个类的任何地方使用
• 方法test_store_three_response() 核实self.responses 中的第一个答案—self.responses[0] —被妥善地存储，而方法test_store_three_response() 核实self.responses 中的全部三个答案都被妥善地存储。
• 测试自己编写的类时，方法setUp() 让测试方法编写起来更容易
  • 可在setUp() 方法中创建一系列实例并设置它们的属性，再在测试方法中直接使用这些实例。
  • 相比于在每个测试方法中都创建实例并设置其属性，这要容易得多。

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