（请先看这篇文章：https://blog.csdn.net/GenuineMonster/article/details/104495419） 

        也许你听过软件测试？编写函数或类时，可以为其编写对应的测试代码。通过测试，可检验代码是否能够按照编写意图工作。在本博文中，将会学习如何使用Python模块unittest中的工具来测试代码（测试函数和类），将会学习如何编写测试用例，编写多少个测试代码。

1 测试函数 

        要学习测试，得有要测试的代码。依据原书在此提供一个简单的函数，它接受名和姓并返回整洁的姓名，代码如下所示：

def get_formatted_name(first,last): # 函数将名和姓结合成姓名"""生成整洁的姓名"""full_name = first + " " + lastreturn full_name.title()

测试代码如下：（将上述代码单独一个文件，名为name_function.py）

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':breaklast = input("Please give me a last name: ")if last == 'q':breakformatted_name = get_formatted_name(first,last)print("\tNeatly formatted name:" + formatted_name +". ")

         从上述输出可知，合并得到的姓名正确无误。如果修改了get_formatted_name()，即使原有功能不变，还得运行测试代码进行测试，此时就体现出自动测试函数的好处。

1.1 单元测试和测试用例 

        Python标准库中的模块unittest提供了代码测试工具。单元测试用于核实函数的某个方面没有问题;测试用例是一组单元测试,这些单元测试一起核实函数在各种情形下的行为都符合要求。良好的测试用例考虑到了函数可能收到的各种输入，包含针对所有这些情形的测试。全覆盖式测试用例包含―整套单元测试，涵盖了各种可能的函数使用方式。

1.2 可通过的测试

        为函数编写测试用例,可先导人模块unittest以及要测试的函数，再创建一个继承unittest.TestCase的类，并编写一系列方法对函数行为的不同方面进行测试。接下来给出一个只包含一个方法的测试用例，它将检查函数get_formatted_name()在给定名和姓时能否正确地工作：

# 首先，导入模块unittest和要测试的函数get_formatted_name()
import unittest
from name_function import get_formatted_name
# 创建名为NamesTestCase的类，并在类的命名时体现出类的命名原则。
# 这个类必须继承uniunittest.TestCase类，这样Python才知道自动运行你编写的测试代码。# 可以看出NamesTestCase类中只包含一个方法，因此我们核实的是只有名和姓的姓名能否被正确地格式化。
"""我们运行test_name_function.py时，所有以test打头的方法都将自动运行。在这个方法中，我们调用了要测试的函数，并存储了要测试的返回值
"""class NamesTestCase(unittest.TestCase):"""测试name_function.py"""def test_first_last_name(self):"""能够正确处理像Janis Joplin这样的姓名吗？"""formatted_name = get_formatted_name('janis','joplin')# 我们使用了unittest类中最有用的功能之一：一个断言方法。断言方法是用来核实得到的结果是否与期望的结果一致# 下面这行代码的意思是说：请将程序处理得出的结果和我指定的结果进行比对，一样就万事大吉；不一样，就告诉我。self.assertEqual(formatted_name,'Janis Joplin')unittest.main()

第1行的句点表明有一个测试通过了。接下来的一行指出Python运行了一个测试，消耗的时间不到0.001s。最后的ok表明该测试用例中的所有单元测试都通过了。

1.3 不能通过的测试

        代码错误通常是导致测试未通过的根本原因，接下来我们修改get_formatted_name(),使其能够处理中间名，但是这样的话，此函数无法正确处理像Janis Joplin这样只用名和姓的姓名。下面是函数get_formatted_name()的新版本，它要求通过一个实参指定中间名：（下面的代码是更新过的）

def get_formatted_name(first,middle,last):"""生成整洁的姓名"""full_name = first + " " + middle + lastreturn full_name.title()

         上述展示的是测试未通过时的结果。因为测试未通过，所以需要说明的事情更多。其中：

1、第1行输出只有一个字母E，它表示测试用例中有一个单元测试导致了错误。

2、接下来，我们看到NameTestCase中的test_first_last_name()导致了错误。

3、错误提示信息中给出标准的Traceback，它指出函数调用get_formatted_name(' janis ', ' joplin ')有问题，因为它缺少一个必不可少的位置实参。

4、“Ran 1 test in 0.000s”指的是运行了一个单元测试。最后在这句的下面还看到一条消息，指出整个测试用例都未通过，因为运行该测试用例时发生了一个错误。

1.4 如何处理未通过的测试

        测试未通过意味着编写的代码有错误。因此在测试未通过时，不要修改测试，而是修复新编写的代码：检查刚对函数所做的修改，找出导致函数行为不符合预期的修改。

        对1.3中提到的例子而言，最佳的解决方法是将中间名变为可选项，这样就能兼容有中间名的姓名了。对此，将代码进行如下修改：

def get_formatted_name(first,last,middle = ''):"""生成整洁的姓名"""if middle:full_name = first + ' ' + middle + ' ' + lastelse:full_name = first + ' ' + lastreturn full_name.title()

        上述代码：将中间名设置为可选的，并在函数定义时，将形参middle移到形参列表的末尾，并将其默认值设定为一个空字符串。与此同时，使用一个if-else语句进行判断，分别处理有middle和没middle的情况。接下来我们再次运行测试代码。

 1.5 添加新测试

确定get_formatted_name()又能正确的处理简答的姓名后，我们再编写一个测试，用于测试包含中间名的姓名。为此，我们在NamesTestCase类中再添加一个方法，代码如下所示：

# 首先，导入模块unittest和要测试的函数get_formatted_name()
import unittest
from name_function import get_formatted_name
# 创建名为NamesTestCase的类，并在类的命名时体现出类的命名原则。
# 这个类必须继承uniunittest.TestCase类，这样Python才知道自动运行你编写的测试代码。# 可以看出NamesTestCase类中只包含一个方法，因此我们核实的是只有名和姓的姓名能否被正确地格式化。
"""我们运行test_name_function.py时，所有以test打头的方法都将自动运行。在这个方法中，我们调用了要测试的函数，并存储了要测试的返回值
"""class NamesTestCase(unittest.TestCase):"""测试name_function.py"""def test_first_last_name(self):"""能够正确处理像Janis Joplin这样的姓名吗？"""formatted_name = get_formatted_name('janis','joplin')# 我们使用了unittest类中最有用的功能之一：一个断言方法。断言方法是用来核实得到的结果是否与期望的结果一致# 下面这行代码的意思是说：请将程序处理得出的结果和我指定的结果进行比对，一样就万事大吉；不一样，就告诉我。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()

 我们在命名函数时，都是以test开头，而且必须这么做。这样它才可以在我们运行test_name_function.py时自动运行。在TestCase类中使用很长的方法名是可以的，这些方法名的名称必须是描述性的，这才能让你明白测试未通过时的输出；这些方法由Python自动调用，你根本不用编写调用他们的代码。虽然加备注也可以起到描述性的作用，但是备注不会再错误时显示到终端里。

2 测试类

        1中介绍了编写针对单个函数的测试，下面来编写针对类的测试。 如果针对类的测试通过了，你就能确信对类所做的改进没有以外的破坏其原有的行为。

 2.1 各种断言方法

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

        下面提供6种断言方法，可核实返回的值等于或不等于预期的值；返回的值为True或False；返回的值在列表种或不在列表中（只能在继承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.2 一个要测试的类

        类的测试与函数的测试类似——所做的大部分工作都是测试类中方法的行为，但存在一些不同之处。

survey.py文件中的代码：

class AnonymousSurvey():"""收集匿名调查问卷的答案"""def __init__(self,question):"""存储一个问题，并为存储答案做准备"""self.question = questionself.responses = []def show_question(self):"""显示调查问卷"""print(self.question)def store_response(self,new_response):"""存储单份调查答卷"""self.responses.append(new_response)def show_result(self):"""显示收集到的所有答案"""print("Survey results:")for response in self.responses:print('- ' + response)

使用上述类代码的另一段代码：文件名为language_survey.py

from survey import AnonymousSurvey# 定义一个问题，并创建一个表示调查的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("Language: ")if response == 'q':breakmy_survey.store_response(response)# 显示调查结果
print("\nThank you everyone who participated in the survey!")
my_survey.show_results()

这个程序定义了一个问题（“ What language did you first learn to speak? "）,并使用这个问题创建了一个AnonymousSurvey对象。下面是程序运行结果：

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

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

2.3 测试AnonymousSurvey类

        在此小节中，我们编写一个测试，对AnonymousSurvey类的行为进行验证。文件名为test_survey.py。

# 导入模块unittest以及要测试的类AnonymousSurvey。将测试用例命名为TestAnonymousSurvey，它也
# 继承了unittest.Testcase
import unittest
from survey import AnonymousSurvey
class TestAnonymousSurvey(unittest.TestCase):"""针对AnonymousSurvey类的测试"""def test_store_single_response(self):"""测试单个答案会被妥善地存储"""question = "what language did you first learn to speak? "# 使用问题“ what language did you first learn to speak? ”创建了一个名为my_survey的实例，# 然后使用方法store_response()存储了单个答案English。接下来，并使用断言，检测English是否包含# 在列表my_survey.responses中，以核实这个答案是否被妥善的存储了。my_survey =AnonymousSurvey(question)my_survey.store_response('English')self.assertIn('English',my_survey.responses)unittest.main()

 

 但只能收集一个答案的调查用途不大，我们扩大为3个：

import unittest
# 导入模块unittest以及要测试的类AnonymousSurvey。将测试用例命名为TestAnonymousSurvey，它也
# 继承了unittest.Testcase
from survey import AnonymousSurveyclass TestAnonymousSurvey(unittest.TestCase):"""针对AnonymousSurvey类的测试"""def test_store_single_response(self):"""测试单个答案会被妥善地存储"""question = "what language did you first learn to speak?"# 使用问题“ what language did you first learn to speak? ”创建了一个名为my_survey的实例，# 然后使用方法store_response()存储了单个答案English。接下来，并使用断言，检测English是否包含# 在列表my_survey.responses中，以核实这个答案是否被妥善的存储了。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','Spnish','Mandarin'for response in responses:my_survey.store_response(response)for response in responses:self.assertIn(response,my_survey.responses)unittest.main()

 前述做法的效果很好，但这些测试有冗余。下面使用unittest的另一项功能来提高他们的效率。

2.4 方法setUp（）

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

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

import unittest
# 导入模块unittest以及要测试的类AnonymousSurvey。将测试用例命名为TestAnonymousSurvey，它也
# 继承了unittest.Testcase
from survey import AnonymousSurveyclass 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.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（即存储在属性中），因此可在这个类的任何地方使用。这让两个个测试方法都更简单，因为他们都不用创建对象和答案。再次运行代码的结果为：

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

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

        在项目早期，不要试图去编写全覆盖的测试用例，除非有充分的理由这样做。