Python基础(三)

Chapter11 测试代码

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

学习内容：

• 如何使用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()将名和姓合并成姓名,在名和姓之间加上一个空格,并将它们的
首字母都大写,再返回结果

现在测试其是否正确：

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() 后都进行测试:
运行程序names.py,并输入像Janis Joplin 这样的姓名,但这太烦琐了。所幸Python提供了一种自动测试函数输出的高效方式。倘若我们对 get_formatted_name() 进行自动测试,就能始终信心满满,确信给这个函数提供我们测试过的姓名时,它都能正确地工作。

11.1.1 单元测试和测试用例

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

单元测试用于核实函数的某个方面没有问题;测试用例是一组单元测试,这些单元测试一起核实函数在各种情形下的行为都符合要求。

良好的测试用例考虑到了函数可能收到的各种输入,包含针对所有这些情形的测试。

全覆盖式测试用例包含一整套单元测试,涵盖了各种可能的函数使用方式。对于大型项目,要实现全覆盖可能很难。通常,最初只要针对代码的重要行为编写测试即可,等项目被广泛使用时再考虑全覆盖。

11.1.2 可通过的测试

创建测试用例的语法需要一段时间才能习惯,但测试用例创建后,再添加针对函数的单元测试就很简单了。要为函数编写测试用例,可先导入模块unittest以及要测试的函数,再创建一个继承unittest.TestCase的类,并编写一系列方法对函数行为的不同方面进行测试。

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

class NamesTestCase(unittest.TestCase): # 创建类用于包含一系列针对函数的单元测试
    """测试name_function.py""" # 这个类必须继承unittest.TestCase类

    def test_first_last_name(self): # NamesTestCase包含的一个方法
        """能够正确地处理像Janis Joplin这样的姓名吗?"""

        formatted_name = get_formatted_name('janis', 'joplin') # 传入实参
        self.assertEqual(formatted_name, 'Janis Joplin') # 断言方法
        # 断言方法用来核实得到的结果是否与期望的结果一致

unittest.main() # 让Python运行这个文件中的测试

11.1.3 不能通过的测试

# 修改模块name_ function.py的get_formatted_name函数并且保存
def get_formatted_name(first, middle, last):
    """ 生成整洁的姓名 """
    full_name = first + ' ' + middle + ' ' + last
    return full_name.title()
    # 不能正确处理只有名和姓的姓名了

11.1.4 测试未通过时怎么办

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

在这个示例中,get_formatted_name()以前只需要两个实参——名和姓,但现在它要求提供名、中间名和姓。新增的中间名参数是必不可少的,这导致get_formatted_name()的行为不符合预期。

最佳的选择是让中间名变为可选的。这样做后,使用类似于Janis Joplin的姓名进行测试时,测试就会通过了,同时这个函数还能接受中间名。

# 修改模块name_ function.py的get_formatted_name函数并且保存
def get_formatted_name(first, last, middle=''): # 将中间名默认变成可选的
    """生成完整的姓名"""

    if middle: # 如果中间名输入了
        full_name = first + ' ' + middle + ' ' + last
    else:
        full_name = first + ' ' + last
    return full_name.title()

11.1.5 添加新测试

再编写一个测试,用于测试包含中间名的姓名。

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

11.2 测试类

11.2.1 各种断言方法

Python在unittest.TestCase类中提供了很多断言方法。前面说过,断言方法检查你认为应该满足的条件是否确实满足。如果该条件确实满足,你对程序行为的假设就得到了确认,你就可以确信其中没有错误。如果你认为应该满足的条件实际上并不满足,Python将引发异常。

6个常用的断言方法:

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 中  

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

# 开始测试

from survey import AnonymousSurvey

# 定义一个问题,并创建一个表示调查的AnonymousSurvey对象
question = "What language did you first learn to speak?"
my_survey = AnonymousSurvey(question) # 传入一个问题，my_survey相当于self

# 显示问题并存储答案
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() # 结果遍历出来

11.2.3 测试AnonymousSurvey类

编写一个测试,对AnonymousSurvey类的行为的一个方面进行验证:如果用户面对调查问题时只提供了一个答案,这个答案也能被妥善地存储。为此,我们将在这个答案被存储后,使用方法assertIn()来核实它包含在答案列表中

import unittest
from survey import AnonymousSurvey

class TestAnonmyousSurvey(unittest.TestCase):
    """针对AnonymousSurvey类的测试"""
    # 它也继承了unittest.TestCase

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

'''
测试用户回答三个答案时
'''
import unittest
from survey import AnonymousSurvey

class TestAnonmyousSurvey(unittest.TestCase):
    """针对AnonymousSurvey类的测试"""
    # 它也继承了unittest.TestCase

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

11.2.4 方法 setUp()

在前面的test_survey.py中,我们在每个测试方法中都创建了一个AnonymousSurvey实例,并在每个方法中都创建了答案。unittest.TestCase类包含方法setUp(),让我们只需创建这些对象一次,并在每个测试方法中使用它们。如果你在TestCase类中包含了方法setUp(),Python将先运行它,再运行各个以test_打头的方法。这样,在你编写的每个测试方法中都可使用在方法setUp()中创建的对象了。

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

方法setUp()做了两件事情:

• 创建一个调查对象
• 创建一个答案列表

存储这两样东西的变量名包含前缀self(即存储在属性中),因此可在这个类的任何地方使用。这让两个测试方法都更简单,因为它们都不用创建调查对象和答案。

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