Python编程学习笔记（八）

十一、测试代码

  使用Python模块unittest中的工具来测试代码。

1.测试函数

对返回首字母大写的姓名函数：
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()

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

  现在假设我们要修改get_formatted_name() ，使其还能够处理中间名。但要确保不破坏这个函数处理只有名和姓的姓名的方式。为此，我们可以在每次修改get_formatted_name() 后都进行测试：运行程序names.py，并输入像Janis Joplin 这样的姓名，但这太烦琐了。所以用如下自动测试的方法。
(1)单元测试和测试用例
单元测试用于核实函数的某个方面没有问题；测试用例是一组单元测试，这些单元测试一起核实函数在各种情形下的行为都符合要求。通常，最初只要针对代码的重要行为编写测试即可。
（2）可通过地测试
要为函数编写测试用例，可先导入模块unittest 以及要测试的函数，再创建一个继承unittest.TestCase 的类，并编写一系列方法对函数行为的不同方面进行测试。

#导入模块unittest 和要测试的函数
import unittest
from name_function import get_formatted_name

class NamesTestCase(unittest.TestCase): #继承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()

输出结果：

Ran 1 test in 0.002s

OK

(3)不能通过的测试

    def test_first_last_name2(self):
        """能够正确地处理像Janis这样的姓名吗？"""
        formatted_name = get_formatted_name('janis')
        #断言方法用来核实得到的结果是否与期望的结果一致
        self.assertEqual(formatted_name, 'Janis') 

(4)测试未通过时怎么办
如果你检查的条件没错，测试通过了意味着函数的行为是对的，而测试未通过意味着你编写的新代码有错。因此，测试未通过时，不要修改测试，而应修复导致测试不能通过的代码：检查刚对函数所做的修改，找出导致函数行为不符合预期的修改。
(5)添加新测试

class NamesTestCase(unittest.TestCase): #继承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')

输出结果：

Ran 2 tests in 0.001s

OK

2.测试类

(1)各种断言方法

(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 self.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()

输出结果：

What language did you first learn to speak?
Enter 'q' at any time to quit.


Language: Chinese

Language: English

Language: Spanish

Language: q

Thank you to everyone who participated in the survey!
Survey results:
- Chinese
- English
- Spanish

改进方向：让每位用户都可输入多个答案；编写一个方法，它只列出不同的答案，并指出每个答案出现了多少次；再编写一个类，用于管理非匿名调查。
(3)测试AnonymousSurvey 类

import unittest
from survey import AnonymousSurvey

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

两项测试都可通过。但这些测试有些重复的地方。下面使用unittest 的另一项功能来提高它们的效率。
(4)方法setUp()
使用setUp() 来创建一个调查对象和一组答案，供方法test_store_single_response() 和test_store_three_responses() 使用：

import unittest
from survey import AnonymousSurvey

class TestAnonmyousSurvey(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(self.responses[0], 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()

  运行测试用例时，每完成一个单元测试，Python都打印一个字符：测试通过时打印一个句点；测试引发错误时打印一个E ；测试导致断言失败时打印一个F 。

参考文献：袁国忠，Python编程：从入门到实践