Python-12.1-测试代码

测试代码

• 编写函数或类时，还可为其编写测试
• 通过测试，可确定代码面对各种输入都能够按要求的那样工作
   
• 将学习如何使用Python模块unittest中的工具来测试代码
• 将学习编写测试用例，核实一系列输入都将得到预期的输出
• 将学习如何测试函数和类，并将知道该为项目编写多少个测试

一：测试函数

• 要学习测试，得有测试代码
• 简单的函数
  • 它接受名和姓并返回整洁的姓名
  • 它接受名和姓或含有中间名并返回整洁姓名

# 1、返回整洁的姓名
def get_formatted_name(first, last):
    """Generate a neatly formatted full name."""
    
    full_name = first + " " + last
    return full_name.title()

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: ")
    
    formatted_name = get_formatted_name(first, last)
    print("\tNeatly formatted name: {} .".format(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

# 不确定是否有中间名
def get_formated_name(first, last, middle):
    if middle:
        full_name = first + " " + middle + " " + last
        return full_name.title()
    else:
        full_name = first + " " + last
        return full_name.title()
    
print("Enter 'q' at any time to quit.")

while True:
    first = input("\nPlease give me a first name: ")
    if first == 'q':
        break
    middle = input("Please give me a middle name: ")
    last = input("Please give me a last name: ")
    
    formatted_name = get_formated_name(first, last, middle)
    print("\tNeatly formatted name: {} .".format(formatted_name))
    
# 此测试方法都过于繁琐
# Python提供了一种自动测试函数输出的高效方式

Enter ‘q’ at any time to quit.

Please give me a first name: qwe
Please give me a middle name: asd
Please give me a last name: zxc
  Neatly formatted name: Qwe Asd Zxc .

Please give me a first name: rty
Please give me a middle name:
Please give me a last name: bvc
  Neatly formatted name: Rty Bvc .

Please give me a first name: q

1、单元测试和测试用例

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

2、可通过的测试

• 导入模块unittest和要测试的函数get_formatted_name()
• 创建一个名为NamesTestCase的类，用于包含一系列针对get_formatted_name()的单元测试
  • 这个类必须继承 unittest.TestCase类，Python才知道如何运行你编写的测试
• NamesTestCase只包含一个方法，用于测试get_formatted_name()的一个方面
  • 核实的是只有名和姓的姓名能否被正确地格式化
• 我们运行程序时，所有以 test_ 打头的方法都将自动运行
• unittest类最有用的功能之一：一个断言方法
  • 断言方法是用来核实得到的结构是否与期望的结果一致
  • 将’formatted_name’的值同字符串’Janis Joplin’进行比较

import unittest

def get_formatted_name(first, last):
    """Generate a neatly formatted full name."""

    full_name = first + " " + last
    return full_name.title()


class NamesTestCase(unittest.TestCase):
    """测试名字"""

    def test_first_last_name(self):
        """是否能正确地处理Janis Joplin这样的姓名"""
        name = get_formatted_name('janis', 'joplin')
        # 断言方法
        self.assertEqual(name, 'Janis Joplin')

# 让Python运行这个测试
unittest.main()

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

OK

3、不能通过的测试

• 第一行输出只有一个字母E。它指出测试用例中有一个单元测试导致了错误

# 重新定义的函数能处理包含中间名的姓名
# 当测试时处理只有名和姓的姓名，则不能通过测试
import unittest

def get_formatted_name(first, last, middle):
    """Generate a neatly formatted full name."""

    full_name = first + " " + middle + " " + last
    return full_name.title()


class NameTestCase(unittest.TestCase):
    """测试名字"""

    def test_first_last_name(self):
        """是否能正确地处理Janis Joplin这样的姓名"""
        
        # 缺少一个必不可少的位置实参
        formatted_name = get_formatted_name('janis', 'joplin')
        self.assertEqual(formatted_name, 'Janis Joplin')

unittest.main()

E
*======================================================================*
ERROR: test_first_last_name (main.NamesTestCase)
是否能正确地处理Janis Joplin这样的姓名
----------------------------------------------------------------------
Traceback (most recent call last):
File “G:/zxc/qwe.py”, line 15, in test_first_last_name
name = get_formatted_name(‘janis’, ‘joplin’)
TypeError: get_formatted_name() missing 1 required positional argument: ‘middle’

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

FAILED (errors=1)

4、测试未通过时该怎么办

• 如果你检查的条件没错，测试通过了意味着函数的行为时对的，而测试未通过意味着你编写的新代码有错
• 测试未通过时，不要修改测试，而应修复导致测试不能通过的代码
  • 检查刚对函数所做的修改，找出导致函数行为不符合预期的修改

# 将中间名设置为可选的
import unittest

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


class NameTestCase(unittest.TestCase):
    """测试名字"""

    def test_first_last_name(self):
        """是否能正确地处理Janis Joplin这样的姓名"""
        formatted_name = get_formatted_name('janis', 'joplin')
        self.assertEqual(formatted_name, 'Janis Joplin')

unittest.main()

5、添加新测试

• 方法名必须以test_打头
  • 测试运行程序时才会自动运行
• 这些方法由Python自动调用，根本不用编写调用它们的代码

import unittest

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


class NameTestCase(unittest.TestCase):
    """测试名字"""

    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):
        formatted_name = get_formatted_name('wolfgang', 'mozart', 'amadeus')
        self.assertEqual(formatted_name, 'Wolfgang Amadeus Mozart')

unittest.main()

二：测试类

• 如果针对类的测试通过了，就能确信对类所做的改进没有意外地破坏其原有的行为

1、各种断言方法

• 断言方法检查你认为应该满足的条件是否确实满足
  • 只能在继承 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、一个要测试的类

• 类的测试与函数的测试相似，所做的大部分工作都是测试类中方法的行为

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 result:")
        for response in self.responses:
            print("- " + response.title())
            
# 定义一个问题，并创建一个表示调查的AnonymousSurvey对象
question = "What language did you first learn to speak?"
my_survey = AnonymousSury(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 result:

• Chinese
• English
• Spanish

3、测试 AnonymousSurvey 类

• 对 AnonymousSurvey 类的行为进行验证
  • 如果用户只提供一个答案，能妥善地存储
  • 如果用户提供了三个答案，也能妥善地存储

# 测试类
import unittest

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 result:")
        for response in self.responses:
            print("- " + response.title())
            
class TestAnonymousSurvey(unittest.TestCase):
    """针对AnonymousSurvey"""
    
    def test_store_single_responses(self):
        """测试单个答案会被妥善地存储"""
        question = "What language did you first learn to speak?"
        my_survey = AnonymousSurvey(question)
        my_survey.store_response('chinese')
        
        self.assertIn('chinese', my_survey.responses)
        
    def test_store_three_responses(self):
        question = "What language did you first learn to speak?"
        my_survey = AnonymousSurvey(question)
        three_responses = ['Chinese', 'English', 'Spanish']
        for three_response in three_responses:
            my_survey.store_response(three_response)
            
        for three_response in three_responses:
            self.assertIn(three_response, my_survey.responses)
        
unittest.main()

4、方法 setUp()

• unittest.TestCase 类包含方法 setUp()，让我们只需创建这些对象一次，并在每个测试方法中使用它们

# 方法 setUp()
import unittest
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 result:")
        for response in self.responses:
            print("- " + response.title())

class TestAnonymousSurvey(unittest.TestCase):
    """针对AnonymousSurvey类的测试"""

    def setUp(self):
        """创建一个调查对象和一组答案，供使用的测试方法使用"""
        question = "What language did you first learn to speak?"
        # 变量名包含前缀self(即存储在属性中)
        # 因此可在这个类的任何地方使用
        self.my_survey = AnonymousSurvey(question)
        self.new_responses = ['Chinese', 'English', "Mandarin"]

    def test_store_single_response(self):
        """测试单个答案会被妥善存储"""
        self.my_survey.store_response(self.new_responses[0])
        self.assertIn(self.new_responses[0], self.my_survey.responses)

    def test_store_three_response(self):
        """测试三个答案会被妥善存储"""
        for new_response in self.new_responses:
            self.my_survey.store_response(new_response)
        for new_response in self.new_responses:
            self.assertIn(new_response, self.my_survey.responses)

unittest.main()

三：小结

• 学习了
• 如何使用模块 unittest 中的工具为函数和类编写测试
• 如何编写继承 unittest.TestCase 的类，以及如何编写测试方法，以核实函数和类的行为符合预期
• 如何使用方法 setUp() 来根据类高效地创建实例并设置其属性，以便在类的所有方法中中都可以使用它们