编写函数或类时,还可为其编写测试。通过测试,可确定代码面对各种输入都能够按要求的那样工作。在程序中添加新代码时,也可以对其进行测试,确认它们不会破坏程序既有的行为。程序员都会犯错,因此每个程序员都必须经常测试其代码,在 用户发现问题前找出它们。
1、测试函数
def get_name_function(first,last):
full_name = first + ' ' + last
return full_name.title()
函数get_name_function()将名和姓合并成姓名,并返回首字母大写的姓名。为核实该函数的工作,再编写一个使用该函数的程序。
name.py
from name_function import get_name_function
print("Enter 'q' at any time to quit")
while True:
first = input("\nPlease Enter your first name:")
if first == 'q':
break
last = input("\nPlease Enter your last name:")
if last == 'q':
break
formatted_name = get_name_function(first,last)
print("\tNeatly formatted name:"+formatted_name+'.')
用户输入名和姓,可看到整洁的全名:
Enter 'q' at any time to quit
Please Enter your first name:zina
Please Enter your last name:zhang
Neatly formatted name:Zina Zhang.
Please Enter your first name:helen
Please Enter your last name:wang
Neatly formatted name:Helen Wang.
Please Enter your first name:q
从上述输出可知,合并得到的姓名正确无误。现在假设要修改get_formatted_name() ,使其还能够处理中间名。这样做时,确保不破坏这个函数处理只有名和姓的姓名的方式。可以在每次修改get_formatted_name() 后都进行测试:运行程序names.py,并输入像zina zhang这样的姓名,但这太烦琐了。Python提供了一种自动测试函数输出的高效方式。倘若对get_formatted_name() 进行自动测试,确信给这个函数提供测试过的姓名时,它都能正确地工作。
单元测试和测试用例:
Python标准库中的模块unittest提供了代码测试工具。单元测试用于核实函数的某个方面没有问题;测试用例是一组单元测试,这些单元测试行为都符合要求。良好的测试用例考虑到了函数可能收到的各种输入,包含针对所有这些情形的测试。全覆盖式测试用例包含一整套单元测试,涵盖了各种可能的函数使用方 。
要为函数编写测试用例,可先导入模块unittest以及要测试的函数,再创建一个继承unittest.TestCase的类,并编写一系列方法对函数行为的不同方面进行测试。
下面是一个只包含一个方法的测试用例,它检查函数get_formatted_name()在给定名和姓时能否正确工作:
test_name_function.py
import unittest
from name_function import get_name_function
class NameTestCase(unittest.TestCase):
"""测试name_function.py"""
def test_first_last_name(self):
formatted_name = get_name_function('zina','zhang')
self.assertEqual(formatted_name,'Zina Zhang')
unittest.main()
首先,导入了模块unittest 和要测试的函数get_formatted_name() 。创建了一个名为NamesTestCase 的类,用于包含一系列针 对get_name_function() 的单元测试。类命名最好让它看起来与要测试的函数相关,并包含字样Test。这个类必须继承unittest.TestCase 类,这 样Python才知道如何运行你编写的测试。 NameTestCase 只包含一个方法,用于测试get_name_function() 的一个方面。
运行test_name_function.py时,所有以test 打头的方法都将自动运行。在这个方法中,调用了要测试的函数,并存储了要测试的返回值。
在示例中,使用实参'zina' 和'zhang' 调用get_name_function() ,并将结果存储到变量formatted_name 中。 其中使用了unittest 类最有用的功能之一:一个断言方法。断言方法用来核实得到的结果是否与期望的结果一致。在这里,知道get_formatted_name() 应 返回这样的姓名,即名和姓的首字母为大写,且它们之间有一个空格,因此我们期望formatted_name 的值为Zina Zhang。为检查是否确实如此,调用unittest 的方法assertEqual()进行比较 ,并向它传递formatted_name 和'Zina Zhang' 。
代码行unittest.main() 让Python运行这个文件中的测试。运行test_name_function.py时,得到的输出如下:
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
第1行的句点表明有一个测试通过了。接下来的一行指出Python运行了一个测试,消耗的时间不到0.001秒。最后的OK 表明该测试用例中的所有单元测试都通过了。 上述输出表明,给定包含名和姓的姓名时,函数get_formatted_name() 总是能正确地处理。修改get_formatted_name() 后,可再次运行这个测试用例。如果它通过 了,我们就知道在给定Zina Zhang这样的姓名时,这个函数依然能够正确地处理。
再看测试未通过的结果是怎样的,修改get_name_function(),使其能够处理中间名,但这样做时,故意让这个函数无法正确地处理像Zina Zhang这样只有名和姓的 姓名。
下面是函数get_formatted_name() 的新版本,它要求通过一个实参指定中间名:
def get_name_function(first,middle,last):
full_name = first + ' ' + middle + ' '+ last
return full_name.title()
这个版本应该能够正确地处理包含中间名的姓名,但对其进行测试时,我们发现它再也不能正确地处理只有名和姓的姓名。这次运行程序test_name_function.py时,输出如下:
E
======================================================================
ERROR: test_first_last_name (__main__.NameTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
File "D:/pycharm/test_name_function.py", line 10, in test_first_last_name
formatted_name = get_name_function('zina','zhang')
TypeError: get_name_function() missing 1 required positional argument: 'last'
----------------------------------------------------------------------
Ran 1 test in 0.016s
FAILED (errors=1)
其中包含的信息很多第1行输出只有一个字母E ,它指出测试用例中有一个单元测试导致了错误。接下来,看到NameTestCase 中的test_first_last_name() 导致了错误。测试用例包含众多单元测试时,知道哪个测试未通过至关重要。在下一步处,看到了一个标准的traceback,它指出函数调用get_nam_function('zina','zhang')有问题,因为它缺少一个必不可少的位置实参。 还运行了一个单元测试。最后,还看到了一条消息,它指出整个测试用例都未通过,因为运行该测试用例时发生了一个错误。
测试未通过时,如果检查的条件没错,测试通过了意味着函数的行为是对的,而测试未通过意味着编写的新代码有错。测试未通过时,不要修改测试,而应 修复导致测试不能通过的代码:检查刚对函数所做的修改,找出导致函数行为不符合预期的修改。
name_function.py
def get_name_function(first,last,middle=''):
if middle:
full_name = first + ' ' + middle + ' '+ last
else:
full_name = first + ' ' + last
return full_name.title()
将函数get_name_function()中的中间名设置为可选。再次运行test_name_function.py:
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
测试用例通过。
添加新测试:
在NameTestCase类中再添加一个方法:
import unittest
from name_function import get_name_function
class NameTestCase(unittest.TestCase):
"""测试name_function.py"""
def test_first_last_name(self):
formatted_name = get_name_function('zina','zhang')
self.assertEqual(formatted_name,'Zina Zhang')
def test_first_last_middle_name(self):
formatted_name = get_name_function('zina', 'zhang','helen')
self.assertEqual(formatted_name, 'Zina Helen Zhang')
unittest.main()
运行:
..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK
两个测试都通过了。
2、测试类
各种断言方法:
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 中 |
assertNotIn(item , list ) | 核实 item 不在 list 中 |
一个要测试的类:
编写一个帮助管理匿名调查的类: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)
为证明AnonymousSurvey 类能够正确地工作,我们来编写一个使用它的程序:
from survey import AnonymousSurvey
# 定义一个问题,并创建一个表示调查的AnonymouseSurvey对象
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()
运行:
What language did you first learn to speak?
Enter 'q' at any time to quit.
Language:Chinese
Language:English
Language:q
Thank you to everyone who participated in the survey
Survey results:
-Chinese
-English
测试AnonymousSurvey类:
编写一个测试,对AnonymousSurvey 类的行为的一个方面进行验证:如果用户面对调查问题时只提供了一个答案,这个答案也能被妥善地存储。为此,我们将在这个答案被存储后,使用方法assertIn() 来核实它包含在答案列表中:
import unittest
from survey import AnonymousSurvey
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('Chinese')
self.assertIn('Chinese', my_survey.responses)
unittest.main()
运行测试通过:
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
方法setUp():
unittest.TestCase 类包含方法setUp() ,只需创建这些对象一次,并在每个测试方法中使用它们。如果在TestCase 类中包含了方法setUp() ,Python将先运行它,再运行各个以test_打头的方法。这样,在编写 的每个测试方法中都可使用在方法setUp() 中创建的对象了。
下面使用setUp() 来创建一个调查对象和一组答案,供方法test_store_single_response() 和test_store_three_responses() 使用:
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 = ['China', 'Enlish', 'Spanish']
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 (即存储在属性中),因此可在这个类的任何 地方使用。这让两个测试方法都更简单,因为它们都不用创建调查对象和答案。
方法test_store_three_response() 核实self.responses 中的第一个答案 ——self.responses[0] ——被妥善地存储,而方法test_store_three_response() 核实self.responses 中的全部三个答案都被妥善地存储。
再次运行test_survey.py时,这两个测试也都通过了。如果要扩展AnonymousSurvey ,使其允许每位用户输入多个答案,这些测试将很有用。修改代码以接受多个答案后,可运行这些测试,确认存储单个答案或一系列答案的行为未受影响。
测试自己编写的类时,方法setUp() 让测试方法编写起来更容易:可在setUp() 方法中创建一系列实例并设置它们的属性,再在测试方法中直接使用这些实例。相比于在每个 测试方法中都创建实例并设置其属性,这要容易得多。
3、小结
学习了:如何使用模块unittest 中的工具来为函数和类编写测试;如何编写继承unittest.TestCase 的类,以及如何编写测试方法,以核实函数和类的行为符合预期;如何使用方法setUp() 来根据类高效地创建实例并设置其属性,以便在类的所有测试方法中都可使用它们。