本章是本书理论部分的最后一节，过了今天，我们就将进行实战。理论最终还是要与实践结合。
那么，看看今天的主要内容吧。
第11章：测试代码
11.1 测试函数
要学习测试，必须要有测试的代码。下面是一个简单的函数，它接受名和姓并返回整洁的姓名：
def get_name(first,last):
"""生成简洁的姓名"""
fname = f"{first}{last}"
return fname
函数get_name()将名和姓合并成姓名：在名和姓之间加上空格，再返回结果。未核实get_name()像期望的那样工作，我们来编写一个该函数的程序。程序names.py让用户输入名和姓，并显示整洁的姓名：
from name import Get_name
print("输入'q'退出本程序：")
while True:
first_name = input("输入您的姓：")
if first_name == 'q':
break
last_name = input("输入您的名：")
if last_name == 'q':
break
sname = Get_name(first_name,last_name)
print(sname)
这个程序从name.py中导入Get_name()。用户可输入一系列姓和名，并看到格式整洁的姓名：
输入'q'退出本程序：
输入您的姓：新垣
输入您的名：结衣
新垣 结衣
输入您的姓：全
输入您的名：孝盛
全 孝盛
输入您的姓：刘
输入您的名：亦菲
从上述输出可知，合并得到的姓名准确无误。现在假设要修改get_name()，使其还能够处理中间名。这样做时，要确保不破坏这个函数处理只含有姓和名的方式。为此，可在每次修改get_name()后都进行测试：运行程序name.py并输入想Janis Joplin这样的姓名。不过这样太繁琐了。索性Python提供了一种自动测试函数输出的高效方式。倘若对get_name()进行自动测试，就能始终确信当提供测试过的姓名时，该函数都能正确工作。
附：
name.py
def Get_name(first,last,zhongjian = ""):
"""生成简洁的姓名"""
fname = f"{first} {zhongjian} {last}"
return fname
from name import Get_name
print("输入'q'退出本程序：")
while True:
first_name = input("输入您的姓：")
if first_name == 'q':
break
zhongjian = input("输入你的中间名：")
if zhongjian =='q':
break
last_name = input("输入您的名：")
if last_name == 'q':
break
sname = Get_name(first = first_name,zhongjian = zhongjian,last = last_name)
print(sname)需要注意，这里我用的是指定实参，如果是用位置实参的话，记得要调换顺序。
11.1.1 单元测试和测试用例
Python标准库中的模块unittest 提供了代码测试工具。单元测试用于核实函数的某个方面没有问题。测试用例是一组单元测试，它们一道核实函数在各个情形下的行为都符合要求。良好的测试用例考虑到了函数可能受到的各种输入，包含针对所有这些情形的测试。全覆盖的测试用例包含一整套单元测试，涵盖了各行可能的函数使用方式。对于大型项目，要进行全覆盖测试可能很难。通常，最初只要针对代码的重要行为编写测试即可，等项目被广泛使用后再考虑全覆盖。
11.1.2 可通过的测试
你需要一段时间才能习惯创建测试用例的方法，但创建测试用例之后，再添加针对函数的单元测试就很简单了。要为函数编写测试用例，可先导入模块unittest和要测试的函数，再创建一个集成unittest.TestCase的类，并编写一系列方法对函数行为的不同方面进行测试。
下面的测试用例只包含一个方法，它检查函数get_name()在给定姓和名时都否正确工作：
import unittest
from name import get_name
①class NamesTestCase(unittest.TestCase):
"""测试name.py"""
def test_name(self):
"""能够正确地处理朴 孝敏这样的名字吗"""
② formatted_name= get_name('朴','孝敏')
③ self.assertEqual(formatted_name,'朴 孝敏')
④if __name__ == '__main__':
unittest.main()
首先，导入了模块unittest和要测试的函数get_name()。在①处，创建了一个名为NamesTestCase的类，用于包含一系列针对get_name()的单元测试。这个类可以随意明明，但最好让它看起来与要测试的函数相关并包含Test字样。这个类必须继承unittest.TestCase类，这样Python才知道如何运行你编写的测试。
NamesTestCase只包含一个方法，用于测试get_name()的一个方法。将该方法命名为test_name()。运行test_name.py时，所有以test开头的方法都将自动运行。在这个方法中，调用了要测试的函数。在本例中，使用实参‘朴’和‘孝敏’调用get_name()，并将结果赋给变量formatted_name（见②）。
在③处，使用了unittest类最有用的功能之一：断言方法。断言方法核实得到的结果是否与期望的结果一直。在这里，我们知道get_name()应返回姓和名，以及中间带空格。因此希望formatted_name 的值为朴 孝敏。为检查是否确实如此，我们调用unittest的方法asserEqual()，并向它传递formatted_name和‘朴 孝敏’。代码行：
self.assertEqual(formatted_name,'朴 孝敏')
的意思是：“将formatted_name的值与字符串‘朴 孝敏’比较。如果它们相等，那么万事大吉；如果不相等，就告诉我一声哦！”
我们将直接运行这个文件，但需要指出的是，很多测试框架会先导入测试文件再运行。导入文件时，解释器将在导入的同时执行它。④处的if代码块检查特殊变量__name__，这个变量是在程序执行时设置的。如果这个文件作为主程序执行，变量__name__将被设置为‘__main__。在这里，调用unittest.main()来运行测试用例。如果这个文件被测试框架导入，变量__name__的值将不是'__main__'，因此不会调用unittest.main()
运行test_name.py 时，得到的输出如下：
Ran 1 test in 0.000s
OK
第一行的句点表明有一个测试通过了。接下来的一行指出Python运行了一个测试，消耗的时间不到0.001秒。最后的OK表明该测试用例的所有单元测试都通过了。
上述输出表明，给定包含姓和名的姓名时，函数get_name()总是能正确地处理。修改get_name()后，可再次运行这个测试用例。如果它通过了，就表明给定朴 孝敏这样的姓名时，该函数依然能够正确地处理。11.1.3 未通过的测试
测试未通过时结果是什么样的呢?我们来修改get_name()，使其能够处理中间名，但同时故意让该函数无法正确处理想朴 孝敏这样只有姓和名的姓名：
下面是函数get_name()的新版本，它要求通过一个实参指定中间名：
def get_name(first,middle,last):
"""生成简洁的姓名"""
fname = f"{first} {middle} {last}"
return fname
这个版本应该能够正确处理包含中间名的姓名，但对其进行测试时，我们发现它不再能正确处理只有姓和名的姓名。这次运行程序test_name.py时，输出如下：
①E
======================================================================
②ERROR: test_name (__main__.NamesTestCase)
能够正确地处理朴 孝敏这样的名字吗
----------------------------------------------------------------------
③Traceback (most recent call last):
File "/Users/gregory_mac/PycharmProjects/pythonProject/test_name.py", line 9, in test_name
formatted_name= get_name('朴','孝敏')
TypeError: get_name() missing 1 required positional argument: 'last'
----------------------------------------------------------------------
④Ran 1 test in 0.000s
⑤FAILED (errors=1)
里面包含很多信息，因为测试未通过时，需要让你知道的事情有很多。第一行输出只有一个字母E，指出测试用例中有一个单元测试导致了错误。接下来，我们看到NamesTestCase中的test_name()导致了错误。测试用例包含众多单元测试时，知道哪个测试未通过至关重要。在③处，我们看到了一个标准的traceback，指出函数调用get_name('朴','孝敏')有问题，因为缺少一个必不可少的位置实参。
我们还看到运行了一个单元测试（见④）。最后是一条消息，指出整个测试用例未通过，因为运行该测试用例时发生了一个错误（见⑤）。这条消息位于输出末尾，让你一眼就能看到。你可不希望为获悉有多少测试未通过而翻阅长长的输出。11.1.4 测试未通过时怎么办？
测试未通过时怎么办呢？如果你检查的条件没错，测试通过意味着函数的行为是对的，而测试未通过意味着编写的新代码有错。因此，测试未通过时，不要修改测试，而应修复导致测试不能通过的代码：检查刚刚对函数所做的修改，找出导致函数行为不符合预期的修改。
在本例中，get_name()以前只需要姓和名两个实参，但现在要求提供姓、中间名、名。新增的中间名参数是必不可少的，这导致get_name()的行为不符合预期。就这里而言，最佳的选择是让中间名变为可选的。这样做后，使用类似于朴 孝敏的姓名进行测试时，测试就又能通过了，而且也可以接受中间名。下面来修改get_name()，将中间名设置为可选的，然后再次运行这个测试用例。如果通过了，就接着确认该函数能够妥善地处理中间名。
要将中间名设置为可选的，可在函数定义中将形参middle 移到形参列表末尾，并将其默认值指定为一个空字符串。还需要添加一个if测试，以便根据是否提供了中间名相应的创建姓名：
def get_name(first,last,middle=""):
"""生成简洁的姓名"""
if middle:
fname = f"{first} {middle} {last}"
else:
fname = f"{first} {last}"
return fname
在get_name()的这个新版本中，中间名是可选的。如果向该函数传递了中间名，姓名将包含、中间名和姓，否则姓名将只包含姓和名。现在，对于两种不同的姓名，这个函数都应该能够正确地处理。为确定这个函数依然能够正确处理想朴 孝敏这样的名字，我们在此运行test_name.py:
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
现在，测试用例通过了。太好了，这意味着这个函数又能正确处理想朴 孝敏这样的姓名了，而且我们无需手工测试这个函数。这个函数之所以很容易修复，是因为未通过的测试让我们得知新代码破坏了函数原来的行为。11.1.5 添加新测试
确定get_name()又能正确处理简单的姓名后，我们再编写一个测试，用于测试瀚中间名的姓名。为此，在NamesTestCase 类中再添加一个方法：
import unittest
from name import get_name
class NamesTestCase(unittest.TestCase):
"""测试name.py"""
def test_name(self):
"""能够正确地处理朴 孝敏这样的名字吗"""
formatted_name= get_name(first='朴',last='孝敏')
self.assertEqual(formatted_name,'朴 孝敏')
def test_middle_name(self):
"""能够正确处理全 贝果女 孝盛这样的名字吗"""
① formatted_name= get_name(first='全',middle='贝果',last='孝盛')
self.assertEqual(formatted_name,'全 贝果 孝盛')
if __name__ == '__main__':
unittest.main()
将该方法命名为test_middle_name()。方法名必须以test_打头，这样它才会在我们运行test_name.py时自动运行。这个方法名清楚地指出了它测试的是get_name()的哪个行为。这样，如果该测试未通过，我们就能马上知道受影响的是哪种类型的姓名。可以在TestCase类中使用很长的方法名，而且这些方法名必须是描述性的，这样你才能看懂测试未通过时的输出。这些方法由Python自动调用，你根本不用编写调用它们的代码。
为测试函数get_name()，我们使用姓和名和中间名调用它（见①），再使用asserEqual()检查返回的姓名是否与预期的姓名一致。再次运行test_name.py时，两个测试都通过了：
..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK
太好了！现在我们知道，这个函数又能正确地处理想朴 孝敏这样的名字了，而且深信它也能够正确地处理想全 贝果 孝盛 这样的名字。11.2 测试类
在本章前半部分，你编写了针对单个函数的测试，下面来编写针对类的测试。很多程序中都会用到类，因此证明你的类能够正确工作大有裨益（胭惜雨：这个大有裨益...出现率真高呢）。如果针对类的测试通过了，你就能确信对类所做的改进没有意外地破坏其原有的行为。11.2.1 各种断言方法
Python在unittest.TestCase类中提供了很多断言方法。前面说过，断言方法检查你认为应该满足的条件是否确实满足。如果该条件确实满足，你对程序的假设就得到了确认，可以确信其中没有错误。如果你认为应该满足的条件实际上并不满足，Python将引发异常。
下表描述了6个常用的断言方法。使用这些方法可合适返回的值等于或不等于预期的值，返回的值为True或Flase，以及返回的值在列表中或不在列表中。只能在继承unittest.TestCase的类中使用这些方法，随后来看看如何在测试类时使用其中之一。
方法：asserEqual(a,b) 用途：核实a == b
方法：asserNotEqual(a,b) 用途：核实 a != b
方法：assertTrue(x) 用途：核实x为True
方法：assertFalse(x) 用途：核实x为False
方法：assertIn(item, list) 用途：核实item在list中
方法：asserNoIn(item,list) 用途：核实item不在list中11.2.2 一个要测试的类
类的测试与函数的测试相似，你所做的大部分工作是测试类中方法的行为。不过还是存在一些不同之处，下面编写一个要测试的类。来看一个帮助管理匿名调查的类：
class AninymousSurvey:
"""收集匿名调查问卷的答案"""
① def __init__(self,question):
"""存储一个问题，并未存储答案做准备"""
self.question = question
self.responese = []
② def show_question(self):
"""显示调查问卷"""
print(self.question)
③ def store_response(self,new_resopnse):
"""存储单份调查问卷"""
self.responese.append(new_resopnse)
④ def show_results(self):
"""显示收集到的所有答案"""
print("Survey results:")
for response in self.responses:
print(f"- {response}")
这个类首先存储了一个调查问题（见①），并创建了一个空列表，用于存储答案。这个类包含打印调查问题的方法（见②），在答案列表中添加新答案的方法（见③），以及将存储在列表中的答案都打印出来的方法（见④）。要创建该类的实例，只需提供一个问题即可。有了表示调查的实例后，就可使用show_question()来显示其中的问题，使用def store_response()来存储答案并使用show_results()来显示调查结果。
为证明AninymousSurvey类能够正确工作，编写一个使用它的程序：
from survey import AninymousSurvey
# 定义一个问题，并创建一个调查表。
question = "你喜欢我吗？"
my_surver = AninymousSurvey(question)
# 显示问题并存储答案
my_surver.show_question()
print("输入'q'退出.\n")
while True:
response = input("你喜欢我吗？")
if response == 'q':
break
my_surver.store_response(response)
from survey import AninymousSurvey
# 定义一个问题，并创建一个调查表。
question = "你喜欢我吗？"
my_surver = AninymousSurvey(question)
# 显示问题并存储答案
my_surver.show_question()
print("输入'q'退出.\n")
while True:
response = input("你喜欢我吗？")
if response == 'q':
break
my_surver.store_response(response)
# 显示调查结果
print("\n感谢您参与我们的调查！")
my_surver.show_results()
这个程序定义了一个问题（“你喜欢我吗？”）并使用该问题创建了一个AninymousSurvey 对象。接下来，这个程序调用show_question()来显示问题，并提示用户输入答案。在收到每个答案的同时将其存储起来。用户输入所有答案（输入q要求退出）后，调用show_results()来打印结果：
你喜欢我吗？
输入'q'退出.
你喜欢我吗？喜欢
你喜欢我吗？q
感谢您参与我吗的调查！
Survey results:
- 喜欢
进程已结束,退出代码0
AninymousSurvey 类可用于进行简单的匿名调查。假设我们将它放在了模块survey中，并想进行改进：让每位用户都可输入多个答案；编写一个方法，只列出不同的答案并指出每个答案出现了多少次；再编写一个类，用于管理费匿名调查。
进行上述修改存在风险，可能影响AninymousSurvey 类的当前行为。例如，允许每位用户输入多个答案时，可能会不小心修改处理单个答案的方式。要确认在开发这个模块时没有破坏既有行为，可以编写针对这个类的测试。11.2.3 测试AninymousSurvey类
下面来编写一个测试，对AninymousSurvey 类的行为的一个方面进行验证：如果用户面对调查问题只提供一个答案，这个答案也能被妥善地存储。为此，我们将在这个答案被存储后，使用方法assertIN()来核实它确实在答案列表中：
import unittest
from survey import AninymousSurvey
①class TesrAninymousSurvey(unittest.TestCase):
"""针对AninymousSurvey 类的测试"""
② def test_store_single_response(self):
"""测试单个答案会被妥善地存储"""
question = "你喜欢我吗？"
③ my_survey = AninymousSurvey(question)
my_survey.store_response("喜欢")
④ self.assertIn("喜欢",my_survey.responses)
if __name__ == '__main__':
unittest.main()
首先导入模块unittest和要测试的类AninymousSurvey。将测试用例命名为TestAninymousSurvey，它也继承了unittest.TestCse(见①)。第一个测试方法验证：调查问题的单个答案被存储后，会包含在调查结果列表中。对于这个方法，一个不错的描述性名称是test_store_single_response()（见②）。如果这个测试未通过，我们就能通过输出中的方法名得知，在存储单个调查答案方面存在问题。
要测试类的行为，需要创建其实例。在③处，使用问题“你喜欢我吗？”创建一个名为my_survey的实例，然后使用方法store_response()存储单个答案喜欢。接下来，检查‘喜欢’是否包含在列表my_survey.responese中，以合适这个答案是否被妥善地存储了（见④）。
当我们运行test_survey.py时，测试通过了：
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
这很好，但只能收集一个答案的调查用途不大。下面来核实当用户提供三个答案时，它们也将被妥善地存储。为此，在TesrAninymousSurvey中再添加一个方法：
import unittest
from survey import AninymousSurvey
class TesrAninymousSurvey(unittest.TestCase):
"""针对AninymousSurvey 类的测试"""
def test_store_single_response(self):
"""测试单个答案会被妥善地存储"""
question = "你喜欢我吗？"
my_survey = AninymousSurvey(question)
my_survey.store_response("喜欢")
self.assertIn("喜欢",my_survey.responses)
def test_store_three_single_response(self):
"""测试三个答案会被妥善地存储"""
question = "你喜欢我吗？"
my_survey = AninymousSurvey(question)
① responses = ['喜欢','很喜欢','非常喜欢']
for response in responses:
my_survey.store_response(response)
② for response in responses:
self.assertIn(response,my_survey.responses)
if __name__ == '__main__':
unittest.main()
我们将该方法命名为test_store_three_single_response()，并像对test_store_single_response()所做的一样，在其中创建一个调查对象。定义一个包含三个不同答案的列表（见①），再对其中每个答案调用store_response()。存储这些答案后，使用一个循环来确认每个答案都包含在my_survey.responses中（见②）。
再次运行test_survey.py时，两个测试（针对单个答案的测试和针对三个答案的测试）都通过了：
..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK
前述做法的效果很好，但这些测试有些重复的地方。下面使用unittest的另一项功能来提高其效率。11.2.4 方法 setUp()
在前面的test_survey.py中，我们在每个测试方法中都创建了一个AninymousSurvey 实例，并在每个方法中都创建了答案。unittest.TestCase类包含的方法setUp()让我们只需创建这些对象一次，就能在每个测试方法中使用。如果在TestCase类中包含了方法setUp(),python将先运行它，再运行各个以test_打头的方法。这样，在你编写的每个测试方法中，都可使用在方法setUp()中创建的对象。
下面使用setUp()来创建一个调查对象和一组答案，供方法test_store_single_response()和test_store_three_single_response()使用：
import unittest
from survey import AninymousSurvey
class TestAninymousSurvey(unittest.TestCase):
"""针对AninymousSurvey 类的测试"""
def setUp(self):
"""创建一个调查对象和一组答案，供使用的测试方法使用"""
question = "你喜欢我吗？"
① self.my_survey = AninymousSurvey(question)
② self.responses = ['喜欢','很喜欢','非常喜欢']
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_single_response(self):
"""测试多个答案会被妥善地存储"""
for response in self.responses:
self.my_survey.store_response(response)
for response in self.responses:
self.assertIn(response,self.my_survey.responses)
if __name__ == '__main__':
unittest.main()
方法setUp()做了两件事情：创建一个调查对象（见①），以及创建一个答案列表（见② ）。存储这两样东西的变量名包含前缀self（即存储在属性中），因此可在这个类的任何地方使用。这让两个测试方法都更简单，因为它们都不用创建调查对象和答案了。方法test_store_single_response()核实 self.responses 中的第一个答案self.responses[0]被妥善地存储，而方法test_store_three_response()核实self.responses 中的全部三个答案都被妥善地存储。
再次运行test_survey.py时，这两个测试也都通过了。如果要拓展AninymousSurvey，使其允许每位用户输入多个答案，这个测试将很有用。修改代码以接受多个答案后，可运行这些测试，确认存储单个答案或一系列答案的行为未受影响。
测试自己编写的类时，方法setUp()让测试方法编写起来更容易：可在serUp()方法中创建一系列实例并设置属性，再在测试方法中直接使用这些实例。相比于在每个测试方法中都创建实例并设置属性，这要容易得多。
注意：运行测试用例时，没完成一个单元测试，Python都打印一个字符：测试通过时打印一个据点，测试引发错误时打印一个E，而测试导致断言失败时则打印一个F。这就是你运行测试用例时，在输出的第一行中看到的句点和字符数量各不相同的原因。如果测试用例包含很多单元测试，需要运行很长时间，就可通过观察这些结果来获悉有多少个测试通过了。第一部分理论部分到此结束，第二个部分将是项目部分，前面的理论相当于储存粮草，项目就是模拟演习。如果不是天才的话，我猜这11章的内容，你大概忘了一半左右吧。
没事，忘了再回来查就是了。这也是为什么我会把内容抄出来的原因。
那么，咱们模拟演习见~
拜拜
胭惜雨
2021年02月14日