Python-Testing

第 11 章 测试代码

在本章中，你将学习如何使用Python模块unittest 中的工具来测试代码。你将学习编写测试用例，

核实一系列输入都将得到预期的输出。你将看到测试通过了是什么样子，测试未通过又是什么样子，

还将知道测试未通过如何有助于改进代码。

'''

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':

break

last = input("Please give me a last name: ")

if last == 'q':

break

formatted_name = get_formatted_name(first, last)

print("\tNeatly formatted name: " + formatted_name + '.')

'''unittest单元测试和测试用例

创建测试用例的语法需要一段时间才能习惯，但测试用例创建后，再添加针对函数的单元测试就

很简单了。要为函数编写测试用例，可先导入模块unittest 以及要测试的函数，再创建一个继承

unittest.TestCase 的类，并编写一系列方法对函数行为的不同方面进行测试。'''

'''

首先，我们导入了模块unittest 和要测试的函数get_formatted_name() 。在❶处，我们创建了一个名为NamesTestCase 的类，用于包含一系列针

对get_formatted_name() 的单元测试。你可随便给这个类命名，但最好让它看起来与要测试的函数相关，并包含字样Test。这个类必须继承unittest.TestCase 类，这

样Python才知道如何运行你编写的测试。

NamesTestCase 只包含一个方法，用于测试get_formatted_name() 的一个方面。我们将这个方法命名为test_first_last_name() ，因为我们要核实的是只有名和

姓的姓名能否被正确地格式化。我们运行testname_function.py时，所有以test 打头的方法都将自动运行。在这个方法中，我们调用了要测试的函数，并存储了要测试的返回值。

在这个示例中，我们使用实参'janis' 和'joplin' 调用get_formatted_name() ，并将结果存储到变量formatted_name 中（见❷）。

在❸处，我们使用了unittest 类最有用的功能之一：一个断言 方法。断言方法用来核实得到的结果是否与期望的结果一致。在这里，我们知道get_formatted_name() 应

返回这样的姓名，即名和姓的首字母为大写，且它们之间有一个空格，因此我们期望formatted_name 的值为Janis Joplin 。为检查是否确实如此，我们调用unittest

的方法assertEqual() ，并向它传递formatted_name 和'Janis Joplin' 。代码行self.assertEqual(formatted_name, 'Janis Joplin') 的意思是

说：“将formatted_name 的值同字符串'Janis Joplin' 进行比较，如果它们相等，就万事大吉，如果它们不相等，跟我说一声！”

'''

import unittest

from name_function import get_formatted_name

class NamesTestCase(unittest.TestCase):

'''这个类必须继承unittest.TestCase 类'''

def test_first_last_name(self):

"""能够正确地处理像Janis Joplin这样的姓名吗？"""

formatted_name=get_formatted_name('zhiqian','xue')

self.assertEqual(formatted_name,'Zhiqian Xue')

unittest.main()

'''添加新测试'''

import unittest

from name_function import get_formatted_name

class NamesTestCase(unittest.TestCase):

'''这个类必须继承unittest.TestCase 类'''

def test_first_last_name(self):

"""能够正确地处理像Janis Joplin这样的姓名吗？"""

formatted_name=get_formatted_name('zhiqian','xue')

self.assertEqual(formatted_name,'Zhiqian Xue')

def test_first_last_middle_naem(self):

formatted_name=get_formatted_name('qian','zhi','xue')

self.assertEqual(formatted_name,'Qian Xue Zhi')

unittest.main()

'''测试类

unittest Module中的断言方法

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 中

'''

'''一个要测试的类

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)

'''

filename="C:\Users\Andrew\Documents\Python\syldb"

from survey import 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("thank you!")

my_survey.show_results()

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

案，并指出每个答案出现了多少次；再编写一个类，用于管理非匿名调查。

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

时没有破坏既有行为，可以编写针对这个类的测试。'''

'''测试AnonymousSurvey 类

下面来编写一个测试，对AnonymousSurvey 类的行为的一个方面进行验证：如果用户面对调查问题时只提供了一个答案，这个答案也能被妥善地存储。为此，我们将在这个答

案被存储后，使用方法assertIn() 来核实它包含在答案列表中：'''

import unittest

from survey import AnonymousSurvey

class TestAnonmyousSurvey(unittest.TestCase):

def test_store_single_response(self):

question = "What language did you first learn to speak?"

my_survey = AnonymousSurvey(question)

my_survey.store_response('German')

self.assertIn('German', my_survey.responses)

unittest.main()

'''我们首先导入了模块unittest 以及要测试的类AnonymousSurvey 。我们将测试用例命名为TestAnonymousSurvey ，它也继承了unittest.TestCase （见❶）。第

一个测试方法验证调查问题的单个答案被存储后，会包含在调查结果列表中。对于这个方法，一个不错的描述性名称是test_store_single_response() （见❷）。如果

这个测试未通过，我们就能通过输出中的方法名得知，在存储单个调查答案方面存在问题。

要测试类的行为，需要创建其实例。在❸处，我们使用问题"What language did you first learn to speak?" 创建了一个名为my_survey 的实例，然后使用方

法store_response() 存储了单个答案English 。接下来，我们检查English 是否包含在列表my_survey.responses 中，以核实这个答案是否被妥善地存储了（见

❹）。'''

#try:

import unittest

from survey import AnonymousSurvey

class Test(unittest.TestCase):

def testres(self):

question="what's your name?"

myanswer=AnonymousSurvey(question)

myanswer.store_response('jason')

self.assertIn('jason',myanswer.responses)

unittest.main()

'''下面来核实用户提供三个答案时，它们也将被妥善地存储。'''

import unittest

from survey import AnonymousSurvey

class TestAnonymousSurvey(unittest.TestCase):

def test_store_single_response(self):

question="what's your name?"

my_survey=AnonymousSurvey(question)

my_survey.store_response('peter')

self.assertIn('peter',my_survey.responses)

def test_store_three_responses(self):

question="what language do you know to process data?"

my_survey=AnonymousSurvey(question)

responses=['py','sas','vba']

for response in responses:

my_survey.store_response(response)

for response in responses:

self.assertIn(response,my_survey.responses)

unittest.main()

'''方法setUp()

在前面的test_survey.py中，我们在每个测试方法中都创建了一个AnonymousSurvey 实例，并在每个方法中都创建了答案。unittest.TestCase 类包含方法setUp() ，让我

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

的每个测试方法中都可使用在方法setUp() 中创建的对象了。'''

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.responses 中的第一个答案——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()

'''注意 运行测试用例时，每完成一个单元测试，Python都打印一个字符：测试通过时打印一个句点；测试引发错误时打印一个E ；测试导致断言失败时打印一个F 。

这就是你运行测试用例时，在输出的第一行中看到的句点和字符数量各不相同的原因。如果测试用例包含很多单元测试，需要运行很长时间，就可通过观察这些结果

来获悉有多少个测试通过了。'''

#try:

import unittest

from try1 import Response

class TestSurvey(unittest.TestCase):

def setUp(self):

question="what's your name?"

self.my_survey=Response(question)

self.responses=['aa','bb','cc']

def test_single(self):

self.my_survey.store_question(self.responses[0])

self.assertIn(self.responses[0], self.my_survey.responses)

def test_mul(self):

for res in self.responses:

self.my_survey.store_question(res)

for res in self.responses:

self.assertIn(res,self.my_survey.responses)

unittest.main()

'''本章学习了：如何使用模块unittest 中的工具来为函数和类编写测试；如何编写继承unittest.TestCase 的类，以及如何编写测试方法，以核实函数和类的行为符合预期；如何使用方法setUp() 来根据类高效地创建实例并设置其属性，以便在类的所有测试方法中都可使用它们。

测试是很多初学者都不熟悉的主题。作为初学者，并非必须为你尝试的所有项目编写测试；但参与工作量较大的项目时，你应对自己编写的函数和类的重要行为进行测试。这样你就能够更加确定自己所做的工作不会破坏项目的其他部分，你就能够随心所欲地改进既有代码了。如果不小心破坏了原来的功能，你马上就会知道，从而能够轻松地修复问题。相比于等到不满意的用户报告bug后再采取措施，在测试未通过时采取措施要容易得多。

如果你在项目中包含了初步测试，其他程序员将更敬佩你，他们将能够更得心应手地尝试使用你编写的代码，也更愿意与你合作开发项目。如果你要跟其他程序员开发的项目共享代码，就必须证明你编写的代码通过了既有测试，通常还需要为你添加的新行为编写测试。请通过多开展测试来熟悉代码测试过程。对于自己编写的函数和类，请编写针对其重要行为的测试，但在项目早期，不要试图去编写全覆盖的测试用例，除非有充分的理由这样做。'''