Python面向对象之十二：代码测试

Python面向对象之十二：代码测试

编写函数或类时，还可为其编写测试。通过测试，可确定代码面对各种输入都能够按要求的那样工作。测试让你信心满满，深信即便有更多的人使用你的程序，它也能正确地工作。在程序中添加新代码时，你也可以对其进行测试，确认它们不会破坏程序既有的行为。程序员都会犯错，因此每个程序员都必须经常测试其代码，在用户发现问题前找出它们。

一、测试函数

下面是一个简单的函数，它接受名和姓并返回整洁的姓名：

def get_formatted_name(first, last):
    full_name = first + ' ' + last
    return full_name.title()

1、单元测试和测试用例

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

1、单元测试：用于核实函数的某个方面没有问题；测试用例是一组单元测试，这些单元测试一起核实函数在各种情形下的行为都符合要求。良好的测试用例考虑到了函数可能收到的各种输入，包含针对所有这些情形的测试。

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

2、可通过的测试

针对上面函数进行测试：

import unittest
class NamesTestCase(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()

分析：
1、创建了一个名为NamesTestCase的类，用于包含一系列针对get_formatted_name()的单元测试。
2、我们知道get_formatted_name()应返回这样的姓名，即名和姓的首字母为大写，且它们之间有一个空格，因此我们期望formatted_name的值为Janis Joplin。为检查是否确实如此，我们调用unittest的方法assertEqual()，并向它传递formatted_ name和’Janis Joplin’。
3、代码行unittest.main()让Python运行这个文件中的测试。

运行结果：

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

OK

分析：
1、第1行的句点表明有一个测试通过了。
2、第2行指出Python运行了一个测试，消耗的时间不到0.001秒。
3、最后的OK表明该测试用例中的所有单元测试都通过了。

3、不能通过的测试

1、修改get_formatted_name被测试的函数，添加一个中间名：

def get_formatted_name(first,  middle, last):

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

2、运行测试类NamesTestCase后：

E
======================================================================
ERROR: test_first_last_name (__main__.NamesTestCase)
能够正确地处理像Janis Joplin这样的姓名吗？
----------------------------------------------------------------------
Traceback (most recent call last):
  File "C:/Users/Administrator/PycharmProjects/pythonProject1/temp/shiyan.py", line 10, in test_first_last_name
    formatted_name = get_formatted_name('janis', 'joplin')
TypeError: get_formatted_name() missing 1 required positional argument: 'last'

----------------------------------------------------------------------
Ran 1 test in 0.001s

FAILED (errors=1)

分析：
1、第1部分输出只有一个字母E，它指出测试用例中有一个单元测试导致了错误。
2、第2部分错误追踪：NamesTestCase中的test_first_last_name()导致了错误。
3、第3部分我们看到了一个标准的traceback，它指出函数调用get_formatted_name(‘janis’, ‘joplin’)有问题，因为它缺少一个必不可少的位置实参。
4、第4部分运行了一个单元测试， FAILED (errors=1)指整个测试用例都未通过，因为运行该测试用例时发生了一个错误。

4、处理未通过的测试

1、修改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()

2、给NamesTestCase类再添加一个方法：

import unittest
class NamesTestCase(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):
        """能够正确地处理像Wolfgang Amadeus Mozart这样的姓名吗？"""
        formatted_name = get_formatted_name('wolfgang', 'mozart', 'amadeus')
        self.assertEqual(formatted_name, 'Wolfgang Amadeus Mozart')

unittest.main()

运行结果：

..
----------------------------------------------------------------------
Ran 2 tests in 0.000s

OK

二、测试类

很多程序中都会用到类，因此能够证明你的类能够正确地工作会大有裨益。如果针对类的测试通过了，你就能确信对类所做的改进没有意外地破坏其原有的行为。

1、6个常用的断言方法

方 法	用 途
assertEqual(a, b)	核实a == b
assertNotEqual(a, b)	核实a != b
assertTrue(x)	核实x为True
assertFalse(x) 核实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 results:")
        for response in self.responses:
            print('- ' + response)

3、测试 AnonymousSurvey 类

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

import unittest

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

运行结果：

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

OK

分析：从运行结果上可以得知收集一个答案的测试成功了，下面来核实用户提供三个答案时，它们也将被妥善地存储，修改以上的测试代码：

class TestAnonmyousSurvey(unittest.TestCase):
    """针对AnonymousSurvey类的测试"""
    def test_store_single_response(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()

运行结果：

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

OK

分析：从运行结果上可以得知收集三个答案的测试成功了

4、方法 setUp()

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

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

class TestAnonmyousSurvey(unittest.TestCase):

    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)

    """针对AnonymousSurvey类的测试"""

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

运行结果：

..
----------------------------------------------------------------------
Ran 2 tests in 0.000s

OK

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

方法setUp()做了两件事情：创建一个调查对象；创建一个答案列表。存储这两样东西的变量名包含前缀self（即存储在属性中），因此可在这个类的任何地方使用。这让两个测试方法都更简单，因为它们都不用创建调查对象和答案。

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