本文详细介绍了如何使用Python的unittest模块进行单元测试，包括测试函数、测试类及其方法，如断言的使用，以及如何处理测试未通过的情况。通过实例演示了如何编写测试用例和类测试，强调了测试在代码质量保证中的重要性。
目录
编写函数或类时，还可为其编写测试。通过测试，可确定代码面对各种输入都能够按要求的那样工作。测试让你信心满满，深信即使有更多的人使用你的程序，它也能正确地工作。在程序中添加新代码时，你也可以对其进行测试，确认它们不会破坏程序既有的行为。程序员都会犯错，因此每个程序员都必须经常测试其代码，在用户发现问题前找出它们。使用Python模块unittest中的工具来测试代码，核实一些列输入都将得到预期的输出。你将看到测试通过了是什么样子，测试未通过又是什么样子，还将知道测试未通过如何有助于改进代码。你将学习如何测试函数和类，并将知道应该为项目编写对少个测试。
1、测试函数
要学习测试，得到要测试的代码。下面是一个简单的函数，它接受名和姓并返回简介的姓名：
name_function.py
def get_formatted_name(first, last):
"""Generate a ready formatted full name."""
full_name = first + ' ' + last
return full_name.title()函数get_formatted_name()将名和姓合并成名字，在名和姓之间加上一个空格，并将它们的首字母大写，再返回结果。为核实get_formatted_name()像期望的那样工作，我们编写一个使用这个函数的程序。程序names.py让用户输入名和姓，并显示整洁的全名：
names.py
from name_function import get_formatted_name
print("Enter 'q' at 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 foramtted name: " + formatted_name + '.')
Output:
-----------------------------------------------------
Enter 'q' at time to quit.
Please give me a first name: janis
Please give me a last name: joplin
Neatly foramtted name: Janis Joplin.
Please give me a first name: bob
Please give me a last name: dylan
Neatly foramtted name: Bob Dylan.
Please give me a first name: q
------------------------------------------------------这个程序从name_function.py中导入get_formatted_name()。用户可输入一系列的名和姓，并看到格式整洁的全名。从上述输出可知，合并得到的姓名正确无误。现在假设我们要修改get_formatted()，使其还能够处理中间名。这样做时，我们要确保不破坏这个函数处理只有名和姓的姓名的方式。为此，我们可以在每次修改get_formatted_name()后都记性测试：运行程序names.py，并输入像Janis Joplin这样的姓名，但这太繁琐了。所幸python提供了一种自动测试函数输出的高效方式。倘若我们对get_formatted_name()进行自动测试，就能始终信心满满，确信这个函数提供我们测试过的的姓名时，它都能正确运行。
1、单元测试和测试用例
Python标准库中的模块unittest提供了代码测试工具。单元测试用于核实函数的某个方面没有问题；测试用例是一组单元测试，这些测试一起核实函数在各种情形下的行为都符合要求。良好的测试用例考虑到了函数可能收到的各种输入，包含针对所有这些情形的测试。全覆盖测试用例包含一整套单元测试，涵盖了各种可能的函数使用方式。对于大型项目，要实现全覆盖可能很难，通常，只要针对代码的重要行为编写测试即可，等项目被广泛使用时，再考虑全覆盖。
2、可通过的测试
创建测试用例的语法需要一段时间才能习惯，但测试用例创建后，再添加针对函数的单元测试就很简单了。要为函数编写测试用例，可先导入模块unittest以及要测试的函数，再创建一个继承unittest。TestCase的类，并编写一些列方法对函数行为的不同方面进行测试。下面是一个只包含一个方法的测试用例，它检查函数get_formatted_name()在给定名和姓时能否正确地工作：
test_name_function.py
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')
unittest.main()
Output:
------------------------------------------------------------------------------------
.
----------------------------------------------------------------------
Ran 1 test in 0.001s
OK
------------------------------------------------------------------------------------首先，我们导入了模块unittest和要测试的函数get_formatted_name()。我们创建了一个名为NamesTestCase的类，用户包含一系列针对get_fromatted_name()的单元测试。你可随便给这个类命名，但最好让它看起来要与测试的函数相关，并包含字样Test。这个类必须继承unittest.TestCase类，这样Python才知道如何运行你编写的测试。
NamesTestCase只包含一个方法，用于测试get_formatted_name()的一个方面。我们将这个方法命名为test_first_last_name()，因为我们要核实的是只有名和姓的姓名能否被正确地格式化。我们运行test_name_function.py时，所有test_打头的方法都将自动运行。在这个方法中，我们调用了要测试的函数，并存储了要测试的返回值。在这个示例中，我们使用实参'janis'和'joplin'调用get_formatted_name()，并将存储到变量formatted_name中。
接下来，我们使用了unittest类最有用的功能之一：一个断言方法。断言方法用来核实得到的结果是否与期望的结果一致。在这里，我们知道get_formatted_name()应返回这样的姓名，即名和姓的首字母为大写，且它们之间有一个空格，因此我们期望formatted_name的值为Janis Joplin。为检查是否确实如此，我们调用unittest的方法assertEqual()，并向它传递formatted_name和'Janis Jopin'。代码行self.assertEaual()，并向它传递formatted_name和'Janis Joplin'。代码行self.assertEqual(formatted_name, 'Janis Joplin')的意思是说：“将formatted_name”的值同字符串'Janis Joplin'进行比较，如果它们相等，就万事大吉，如果它们不相等，更我说一声！”代码行unittest.main()让Python运行这个文件中的测试。运行test_name_function.py时，得到的输出如下。
第1行的句点表明有一个测试通过了。接下来的一行指出Python运行了一个测试，消耗的时间不到0,001秒。最后的OK表明该测试用例中的所有单元测试都通过了。上述输出表明，给定包含名和姓的姓名时，函数get_formatted_name()总是能正确地处理。修改get_formatted_name()后，可再次运行这个测试用例。如果它通过了，我们就知道在给定Janis Joplin这样的姓名时，这个函数依然能够正确地处理。
3、不能通过的测试
测试未通过时结果是什么样的呢？我们来修改get_formatted_name()，使其能够处理中间名，但这样做时，故意让这个函数无法正确地处理像Janis Joplin这样只有名和姓的姓名。
下面是函数get_formatted_name()的新版本，它要求通过一个实参指定中间名：
name_function.py
def get_function_name(first, middle, last):
""""生成整洁的姓名"""
full_name = first + ' ' + middle + ' ' + last
return full_name.title()
Output:
----------------------------------------------------------------------------------------
E
======================================================================
ERROR: test_first_last_name (__main__.NamesTestCase)
能够正确地处理Janis Joplin这样的姓名吗？
----------------------------------------------------------------------
Traceback (most recent call last):
File "D:/pylearning/wrapper/test/names.py", line 10, in test_first_last_name
formatted_name = get_foramtted_name('janis', 'joplin')
TypeError: get_foramtted_name() missing 1 required positional argument: 'last'
----------------------------------------------------------------------
Ran 1 test in 0.001s
FAILED (errors=1)
----------------------------------------------------------------------------------------这个版本应该能够正确地处理包含中间名的姓名，但对其进行测试时，我们发现它再也不能正确地处理只有名好姓的姓名。这次运行程序test_name_function.py时，输出如下：
Ran 1 test in 0.016s。
其中包含的信息很多，因为测试未通过时，需要让你知道的事情可能有很多。第1行输出只有一个字母E，它指出测试用例中有一个单元测试导致了错误。接下来，我们看到NamesTestCase中的test_first_last_name()导致了错误。测试用例包含了众多单元测试时，知道哪个测试未通过至关重要。traceback指出函数调用get_formatted_name('janis', 'joplin')有问题，因为它缺少一个必不可少的位置实参。我们正看到运行了一个单元测试。最后，还看到了一条消息，他指出整个测试用例都未通过，因为运行该测试用例时发生了一个错误。这条消息位于输出末尾，让你一眼就能看到------你可不希望为获悉有多少测试未通过而翻阅长长的输出。
4、测试未通过时怎么办
测试未通过时怎么办？如果你检查的条件没错，测试通过了意味着函数的行为是对的，而测试未通过意味着你编写的新代码有错。因此，测试未通过时，不要修改测试，而应修改测试不能通过的代码：检查刚对函数所做的修改，找出导致函数行为不符合预期的修改。
在这个示例中，get_formatted_name()以前只需要两个实参------名和姓，但现在它要求提供名、中间名和姓。新增的中间名参数是必不可少的，这导致get_formatted_name()的行为不符合预期。就这里而言，最佳的选择是让中间名变为可选的，这样做后，使用类似于Janis Joplin的姓名进行测试时，预测就会通过了，同时这个函数还能接受中间名。下面来修改get_formatted_name()，将中间名设置为可选的，然后再次运行这个测试用例。如果通过了，我们接着确认这个函数能够妥善地处理中间名。要将中间名设置为可选的，可在函数定义中将形参middle移到形参表末尾。并将其默认值指定为一个空字符串。我们还要添加一个if测试，以便根据是否提供了中间名相应地创建姓名：
name_function.py
def get_formatted_name(first, last, middle=''):
"""生成整数的姓名"""
if middle:
full_name = first + ' ' + middle + ' ' + last
else:
full_name = first + ' ' + last
return full_name.title()
Output:
------------------------------------------------------------------------
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
------------------------------------------------------------------------在get_formatted_name()这个新版中，中间名是可选的。如果向这个函数传递了中间名(if middle: )、姓名将包含名、中间名和姓，否则姓名将只包含名和姓。现在，对于两种不同的姓名，这个函数都应该能够正确地处理。为确定这个函数依然能够正确地处理像Janis Jopin这样的姓名，我们再次运行test_name_function.py。现在，测试用例通过了。太好了，这意味着这个函数又能正确地处理Janis Joplin这样的姓名了，而且我们无需手工测试这个函数。这个函数很容易就修复了，因为未通过的测试让我们得知新代码破坏了函数原来的行为。
5、添加新测试
确定get_formatted_name()又能正确地处理简单的姓名后，我们再编写一个测试，用于测试包含中间名的姓名。为此，我们在NamesTestCase类中再添加一个方法：
import unittest
from name_function import get_formatted_name
class NamesTestCase(unittest.TestCase):
"""测试name_function.py"""
def test_first_last_name(self):
"""能够正确地处理像Janis Joplin这样的姓名吗？"""
formtted_name = get_formatted_name('janis', 'joplin')
self.asserEqual(formtted_name, 'Janis Joplin')
def test_first_last_middle_name(self):
"""能够正确地处理图像Wolfgang Amadeus Mozart这样的姓名吗？"""
formatted_name = get_formatted_name('wolfgang', 'mozart', 'amadeus')
self.asserEqual(formatted_name, 'Wolfgang Amadeus Mozart')
if __name__=="__main__":
unittest.main()
Output:
---------------------------------------------------------------------------------------
..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK
---------------------------------------------------------------------------------------我们将这个方法命名为test_first_last_middle_name()。方法名必须以test_打头，这样它才会在我们运行test_name_function.py时自动运行。这个方法名清楚地指出了它测试的是get_formatted_name()的哪个行为。这样，如果该测试未通过，我们就会的马上知道受影响的是哪种类型的姓名。在TestCase类中使用很长的方法名时可行的：这些方法的名称必须是描述性的，这才能让你明白测试未通过时的输出：这些方法由python自动调用，你根本不用编写调用它们的代码。
为测试函数get_formatted_name()，我们使用名、姓和中间名调用它，再使用assertEqual()检查返回的姓名是否与预期的姓名(名、中间名和姓)一致。我们再次运行test_name_function.py时，两个测试都通过了。
2、测试类
1、各种断言的方法
python在unittest.TestCase类中提供了很多断言方法。断言方法检查你认为应该满足的条件是否确实满足。如果该条件满足，你对程序行为的假设就得到了确认。你就可以确信其中没有错误。如果你认为应该满足的条件实际上并不满足，python经引发异常。
下表描述了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中 |
| asserNotIn(item, list) | 核实item不在list中 |
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)这个类首先存储了一个你指定的调查问卷，并创建了一个空列表，用于存储答案。这个类包含打印调查问卷问题的方法、在答案列表汇总添加新答案的方法、以及将存储在列表中的答案都打印出来的方法。要创建这个类的实例，只需提供一个问题即可。有了表示调查的实例后，就可以使用show_questiuon()来显示其中的问题，可使用store_reponse()来存储答案，并使用show_result()来显示调查结果。为证明AnonymousSurvey类能够正确地工作，来编写一个使用它的程序。
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':
break
my_survey.store_response(response)
# 显示调查结果
print("\nThank you to everyone who participated in the survey!")
my_survey.show_results()
Output:
-----------------------------------------------------------
What language did you first learn to speak?
Enter 'q' at any time to quit.
Language: English
Language: Spanish
Language: English
Language: Mandarish
Language: q
Thank you to everyone who participated in the survey!
Survey results:
- English
- Spanish
- English
- Mandarish
-----------------------------------------------------------这个程序定义了一个问题("What language did you first to speak!")，并使用这个问题创建了一个AnonymousSurvey对象。接下来，这个程序调用show_question()来是显示问题，并提示用户输入答案。收到每个答案的同时将其存储起来。用户输入所有答案(输入q要求退出)后，调用show_result()来打印调查结果。AnonymousSurvey类可用于进行简单的匿名调查。假设将它放在了survey中，并想进行改进：让每位用户都可输入多个答案；编写一个方法，它只列出不同的答案，并指出每个打哪出现了多少次；再编写一个类，用于管理非匿名调查。
进行上述修改存在风险，可能会影响AnonymousSurvey类的当前行为。例如，允许每位用户输入多个答案时，可能不小心出力单个答案的方式。要确认在这个模块时没有破坏既有行为，可以编写针对这个类的测试。
3、测试AnonymousSurvey类
下面来编写一个测试，对AnonymousSurvey类的行为的一个方面进行验证：如果用户面对调查问题时只提供了一个答案，这个答案也能被存储后，使用方法assertIn()来核实它包含在答案列表中：
test_survey.py
import unittest
from survey import AnonymousSurvey
class TestAnonymousSurvey(unittest.TestCase):
"""针对AnonymousSurvey类的测试"""
def test_single_response(self):
"""测试单个答案会被妥善的存储"""
question = "What language did you first learn to speank?"
my_survey = AnonymousSurvey(question)
my_survey.store_response('English')
self.assertIn('English', my_survey.responses)
if __name__=="__main__":
unittest.main()
Output:
----------------------------------------------------------------------------
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
----------------------------------------------------------------------------首先导入了模块unittest以及要测试的类AnonymousSurvey。将测试用例命名为TestAnonymousSurvey，它也继承了unittest.TestCast。第一个测试方法验证调查问题的单个答案被存储后，会包含在调查列表中。对于这个方法，一个不错的描述性名称是test_store_single_response()。如果这个测试未通过，就能通过输出中的方法名得知，在存储单个调查答案方面存在问题。
要测试类的行为，需要创建其实例。最后，使用问题"What language did you first learn to speak!"创建了一个名为my_survey的实例，然后使用方法store_response()存储了单个答案English。接下来。检查English是否包含在列表my_survey.responses中，以核实这个答案是否被妥善的存储了。当我们运行test_survey时，测试通过了。这很好，但只能收集一个答案的调查用途不大。下面来核实用户提供三个答案时，它们也将被妥善地存储。为此，在TestAnonymousSurvey中再添加一个方法：
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 speank?"
my_survey = AnonymousSurvey(question)
my_survey.store_response('English')
self.assertIn('English', my_survey.responses)
def test_store_three_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)
if __name__=="__main__":
unittest.main()
Output:
-------------------------------------------------------------------------------
..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK
-------------------------------------------------------------------------------将这个方法命名为test_store_responses()，并像test_store_single_response()，并像test_store_single_response()一样，在其中创建一个调查对象。定义了一个包含三个不同答案的列表，在对其中每个答案都调用store_reponse()。存储这些答案后，使用一个循环来确认每个答案都包含在my_survey.response中。
再次运行test_survey时，两个测试(针对单个答案的测试和针对三个答案的测试)都通过了。前述做法的效果很好，但这些测试有些重复的地方。下面使用unittest的另一项功能来提高它们的效率。
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
from survey 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.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)
if __name__=="__main__":
unittest.main()
Output:
-------------------------------------------------------------------------
..
----------------------------------------------------------------------
Ran 2 tests in 0.001s
OK
-------------------------------------------------------------------------方法setUp()做了两件事情：创建一个调查对象；创建一个答案列表。存储这两样东西的变量名包含前缀self(即存储在属性中)，因此可在这个类的任何地方使用。这让两个测试方法都更简单，因为它们都不用创建调查对象和答案。方法test_store_response()核实self.response中的第一个答案------self.responses中的全部三个答案都被妥善地存储。
再次运行test_survey.py时，这些测试将很有用。修改代码以接受多个答案后，可运行这些测试，确认存储单个答案或一系列答案的行为未受影响。
测试自己编写的类时，方法setUp()让测试方法编写起来更容易：可在setUp方法中创建一系列实例并设置它们的属性，再在测试方法中直接使用这些实例。相比于在每个测试方法中都创建实例并设置其属性，这要容易的多。
注意： 运行测试用例时，每完成一个单元测试，Python都打印一个字符：测试通过时打印一个句点；测试引发错误时打印一个E；测试导致断言失败时打印一个F。这就是你运行测试用例时，在输出的第一行中看到的句点和字符数量各不相同的原因。如果测试用例包含很多单元测试，需要运行很长时间，就可通过观察这些结果来获悉有多少的测试通过了。
扫一扫
2863
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
