第十一章测试代码

最新推荐文章于 2022-02-20 12:40:22 发布

豆腐西红柿

最新推荐文章于 2022-02-20 12:40:22 发布

阅读量464

点赞数

分类专栏： Python 学习文章标签：单元测试 python

本文链接：https://blog.csdn.net/loon_zy/article/details/120588104

版权

Python 学习专栏收录该内容

11 篇文章 0 订阅

订阅专栏

系列文章目录

第一章起步
第二章变量和简单数据类型
第三章列表简介
第四章操作列表
第五章 if 语句
第六章字典
第七章用户输入和 while 语句
第八章函数
第九章类
第十章文章和异常
第十一章测试代码

前言

编写函数或类时，还可为其编写测试。通过测试，可确定代码面对各种输入都能够按照要求那样工作。另外，在程序中添加新代码时，也可以对其进行测试，确认不会破坏程序既有的行为。总之，测试代码可以帮助我们在用户发现问题之前找出它们。

11.1 测试函数

首先，要学习测试，怎么能没有要测试的代码呢？下面是一个简单的函数，它接受名和姓并返回整洁的姓名：

def get_formatted_name(first, last):
    """生成整洁的姓名。"""
    full_name = f"{first} {last}"
    return full_name.title()

接下来，为核实 def get_formatted_name() 像期望的那样工作，我们来编写一个使用该函数的程序，让用户输入名和姓，并显示整洁的姓名：

# 如果函数在其他 .py 文件里的话，要先导入函数：
# from file_name import get_formatted_name
# 不过这里就直接在同一个 .py 文件中继续往下写了

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(f"\tNetly formatted name: {formatted_name}.")

这样，用户就可以输入一系列的名和姓，并看到格式整洁的姓名：

Please give me a first name: janis
Please give me a last name: joplin
	Netly formatted name: Janis Joplin.

Please give me a first name: bob
Please give me a last name: dylan
	Netly formatted name: Bob Dylan.

Please give me a first name: q

OK，合并的姓名正确无误，但如果我们想要修改这个函数使其能够再处理一个中间名的话，就要在每次修改后重新跑一遍程序，这不太烦琐了？所幸 Python 提供了一种自动测试函数输出的高效方式，这便是本节所要学习的东西。

11.1.1

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

11.1.2 可通过的测试

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

下面的测试用例只包含一个方法，它检查函数 get_formatted_name() 在给定名和姓时能否正确工作：

import unittest
# from file_name import get_formatted_name

class NamesTestCase(unittest.TestCase):                          #1
    """测试上述合并姓名的程序。"""

    def test_first_last_name(self):
        """能够正确地处理像 Janis Joplin 这样的姓名吗？"""
        formatted_name = get_formatted_name('janis', 'joplin')  #2
        self.assertEqual(formatted_name, 'Janis Joplin')        #3

if __name__ == '__main__':                                      #4
    unittest.main()

首先，我们导入了模块 unittest 和要测试用的函数 get_formatted_name() 。在 #1 处，创建了一个名为 NamesTestCase 的类，用于包含一系列针对 get_formatted_name() 的单元测试。这个类可以随意命名，但最好让它看起来与要测试的函数相关并包含 Test 字样。这个类必须继承 unittest.TestCase 类，这样 Python 才知道如何运行我们编写的测试。

NamesTestCase 只包含一个方法，用于测试 get_formatted_name() 的一个方面。将该方法命名为 test_first_last_name() ，因为要核实的是由名和姓的姓名能否被正确格式化。在运行这个测试程序时，所有以 test_ 打头的方法都将自动运行。在这个方法中，调用了要测试的函数。在本例中，使用实参 ‘janis’ 和 ‘joplin’ 调用 get_formatted_name() ，并将结果赋给变量 formatted_name（见 #2）。

在 #3 处，我们使用了 unittest 类最有用的功能之一：断言方法。断言方法核实得到的结果是否与预期的结果一致，所以这一行代码的意思时：将 formatted_name 的值与字符串 ‘Janis Joplin’（预期值）比较，如果它们相等，那么万事大吉；如果它们不相等，就告诉我们一声！

我们将直接运行这个文件，但要指出的是，很多测试框架都会先导入测试文件再运行。导入文件时，解释器将在导入的同时执行它。#4 处的 if 代码块检查特殊变量 name __ ，这个变量是在程序执行时设定的。如果这个文件作为主程序执行，变量 __ name __ 将被设置为 ’ __ main __ ’ 。在这里，调用 unittest.main() 来运行测试用例。如果这个文件被测试框架导入，变量 name __ 的值不是 ’ __ main __ ’ ，因此不会调用 unittest.main() 。

11.1.3 未通过的测试

测试未通过时结果是怎样的呢？我们来修改 get_formatted_name() ，使其能够处理中间名，但同时故意让该函数无法正确地处理像 Janis Joplin 这样只有名和姓的姓名。

下面是函数 get_formatted_name() 的新版本，它要求通过一个实参指定中间名：

def get_formatted_name(first, middle, last):
    """生成整洁的姓名。"""
    full_name = f"{first} {middle} {last}"
    return full_name.title()

这样一来，肯定会出错的，下面就来看看我们再执行这个测试代码的输出中都有哪些信息吧。首先可以看到一个字母 E ，这里指出测试用例中有一个单元测试导致了错误。接下来，我们看到 NamesTestCaes 中的 test_first_last_name() 导致了错误（当测试用例包含多个单元测试时，知道哪个测试未通过至关重要）。接下来还会看见一个标准的 traceback：get_formatted_name() missing 1 required positional argument: 'last'，指出函数 get_formatted_name(‘janis’, ‘joplin’) 调用有问题，因为缺少一个必不可少的位置实参。

11.1.4 测试未通过时怎么办

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

例如我们的例子中，只要将中间名设置为可选的即可：

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

这样一来，我们在函数定义中将形参 middle 移到形参列表末尾，并将其默认值修改为一个空字符串，再添加一个 if 测试，这样就可以保证测试用例（只有名和姓而没有中间名）通过了。

添加新测试

在确定刚刚的测试代码又能正确处理简单名字后，我们再编写一个测试，用于测试包含中间名的姓名。为此我们需要在 NamesTestCase 类中再添加一个方法：

--snip--

class NamesTestCase(unittest.TestCase):                          #1
    """测试上述合并姓名的程序。"""

    def test_first_last_name(self):
    	--snip--
    	
    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')

if __name__ == '__main__':
    unittest.main()

将该方法命名为 test_first_last_middle_name() 。方法名必须以 test_ 打头，这样他才会再我们运行测试程序时自动运行。这个方法名清楚地指出了它测试的是 get_formatted_name() 的哪个行为。这样，如果该测试未通过，我们就能马上知道受影响是是哪种类型的姓名。可以在 TestCase 类中使用很长的方法名，而且这些方法必须是描述性的，这样我们才能看懂测试未通过时的输出。这些方法由 Python 自动调用，我们根本不用编写调用它们的代码。

嗯，这样一来，两个测试都通过了，这样所有类型的名字都可以处理了。

11.2 测试类

在本章的前半部分中，我们编写了针对单个函数的测试，下面我们来编写针对类的测试。很多程序中都会用到类，因此证明我们的类能够正确工作将大有裨益。如果针对类的测试通过了，我们就能确信对类所做的改进没有意外地破坏其原有的行为。

11.2.1 各种断言方法

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

下图描述了 6 个常用的断言方法。使用这些方法可核实返回的值等于或不等于预期的值，返回的值为 True 或 False ，以及返回的值在列表中或不在列表中。只能继承 unittest.TestCase 的类中使用这些方法，随后来看看如何在测试类时使用它们。
请添加图片描述

11.2.2 一个要测试的类

类的测试与函数的测试相似，我们所做的大部分工作时测试类中方法的行为。不过还是存在一些不同之处，下面编写一个要测试的类。来看一个帮助管理匿名调查的类：

class AnonymousSurvey:
    """收集匿名调查问卷的答案。"""

    def __init__(self, question):
        """存储一个问题，并为存储答案做准备。"""
        self.question = question
        self.responeses = []

    def show_question(self):
        """显示调查问卷。"""
        print(self.question)

    def store_response(self, new_response):
        """存储单份调查答案"""
        self.responeses.append(new_response)

    def show_results(self):
        """显示收集到的所有答卷。"""
        print("Survey results:")
        for response in self.responeses:
            print(f"-{response}")

这个类首先存储了一个调查问题，并创建了一个空列表，用于存储答案。这个类包含调查问题的方法，在答案列表中添加新答案的方法，以及将存储在列表中的答案都打印出来的方法。要创建该类的实例，只需要提供一个问题即可。有了表示调查的示例后，就可使用 show_question() 来显示其中的问题，使用 store_response() 来存储答案并使用 show_results() 来显示调查结果。

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

# from file_name import 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("Languane: ")
    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.

Languane: Chinese
Languane: English
Languane: Spanish
Languane: Chinese
Languane: q

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

AnonymousSurvey 类可用于简单的匿名调查。假设我们将它放在了模块 survey 中，并想进行改进：让每位用户都可输入多个答案；编写一个方法，只列出不同的答案并指出每个答案出现了多少次；再编写一个类，用于管理非匿名调查。

但如果进行上述修改将存在风险，可能影响 AnonymousSurvey 类的当前行为。例如，允许每位用户输入多个答案时，可能会不小心修改处理单个答案的方式。要确认在开发这个模块时没有破坏既有行为，可以编写针对这个类的测试。

11.2.3 测试 AnonymousSurvey 类

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

import unittest
# from file_name 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.responeses)

if __name__ == '__main__':
    unittest.main()

首先导入模块 unittest 和要测试的类 AnonymousSurvey 。将测试用例命名为 TestAnonymousSurvey ，它也继承了 unittest.TestCase 。第一个测试方法验证：调查问题的单个答案被存储后，会包含在调查结果列表中。对于这个方法一个不错的描述性名称是 test_store_single_response() 。如果这个测试未通过，我们就能通过输出中的方法名得知，在存储单个调查结果方面存在问题。

当我们运行这个程序时，测试通过了，这很好，但只能收集一个答案的调查用途不大。下面来核实用户提供三个答案时，它们也将被妥善地存储。为此，在 TestAnonymousSurvey 中再添加一个方法：

import unittest
# from file_name import AnonymousSurvey

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.responeses)

if __name__ == '__main__':
    unittest.main()

我们将该方法命名为 test_store_three_responses() ，并像对 test_store_single_response() 所做的一样，在其中创建一个调查对象。定义一个包含三个不同的列表，再对其中每个答案调用 store_response() 。存储这些答案后，使用一个循环来确认每个答案都包含在 my_survey.responeses 中。

再次运行这个测试程序时，两个测试（针对单个和三个答案的测试）就都通过了。这样的做法效果还是不错的，但这些测试有些重复的地方。下面使用 unittest 的另一项功能来提高其效率。

11.2.4 方法 setUp()

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

下面使用 setUp() 来创建一个调查对象和一组答案，供方法 test_store_single_response() 和 test_store_three_responses() 使用：

import unittest
# from file_name import AnonymousSurvey

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

    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.responeses)

if __name__ == '__main__':
    unittest.main()

方法 setUp() 做了两件事：创建一个调查对象，以及创建一个答案列表。存储这两样东西的变量名包含前缀 self（即存储在属性中），因此可在这个类的任何地方使用。这让两个测试方法都更简单，因为它们都不用创建调查对象和答案了。方法 test_store_single_response() 核实 self.responses 中的第一个答案 self.responses[0] 被妥善地存储，而方法 test_store_three_responses() 则核实 self.responses 中的三个答案都被妥善地存储。

再次运行时，这两个测试也都通过了。如果要扩展 AnonymousSurvey ，使其允许每位用户输入多个答案，这些测试将很有用。修改代码以接受多个答案后，可运行这些测试，确认存储单个答案或一系列答案的行为未受影响。

测试自己编写的类只，方法 setUp() 让测试方法编写起来更容易：可在 setUp() 方法中创建一系列实例并设置其属性，再在测试中直接使用这些实例。相比于在每个测试方法中都创建实例并设置属性，这要容易得多。

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

总结

在本章中，我们学习了：

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

测试是很多初学者不熟悉的主题。作为初学者，并非必须为我们所尝试的全部项目编写测试。然而参与工作量较大的项目时，我们应该对自己所编写函数和类重要行为进行测试。这样我们就能够更加确定自己所做的工作不会破坏项目的其他部分，从而自由地改进既有代码。如果不小心破坏了原来的功能，我们也会马上知道，而且能够很轻松地修复问题。比起等到不满意的用户报告 bug 后再采取措施，在测试未通过时采取措施要容易得多。

如果我们在项目中包含了初步测试，将得到其他程序员的尊敬。他们不仅能够更得心应手地使用我们编写的代码，也更愿意与我们合作开发项目。如果要跟其他程序员开发的项目共享代码，就必须证明我们编写的代码通过了既有测试，通常还需要为我们添加的新行为编写测试。

我们需要通过多开展测试来熟悉代码测试过程。对于自己编写的函数和类，可以练习编写针对其重要行为的测试。不过不要在项目早期试图编写全覆盖的测试用例，除非有充分的理由。