《Python编程：从入门到实践》第11章 笔记

11 测试代码

　　编写函数或类时，还可为其编写测试。经过测试，可肯定代码面对各类输入都可以按要求的那样工做。在程序中添加新代码时，你也能够对其进行测试，确认它们不会破坏程序既有的行为。
　　在本章中，你将学习如何使用Python模块unittest中的工具来测试代码。你将学习编写测试用例，核实一系列输入都将获得预期的输出。你将看到测试经过了是什么样子，测试未经过又是什么样子，还将知道测试未经过如何有助于改进代码。你将学习如何测试函数和类，并将知道该为项目编写多少个测试。

"""11.1 测试函数"""
""" 下面是一个简单的函数，它接受名和姓并返回整洁的姓名： """
"""name_function.py"""

def get_formatted_name(first, last): 
    """Generate a neatly formatted full name.""" 
    full_name = first + ' ' + last 
    return full_name.title()

""" 为核实get_formatted_name()像指望的那样工做，咱们来编写一个 使用这个函数的程序。程序names.py让用户输入名和姓，并显示整洁的全名： """
"""names.py"""

from name_function import get_formatted_name

print "Enter 'q' at any time to quit."
while True:
    first = raw_input("\nPlease give me a first name: ")
    if first == 'q':
        break

    last = raw_input("Please give me a last name: ")
    if last == 'q':
        break

    formatted_name = get_formatted_name(first, last)
    print("\tNeatly formatted name: " + formatted_name + '.')

Enter 'q' at any time to quit.

Please give me a first name: janis
Please give me a last name: joplin
    Neatly formatted name: Janis Joplin.

Please give me a first name: bob
Please give me a last name: dylan
    Neatly formatted name: Bob Dylan.

Please give me a first name: q

　　从上述输出可知，合并获得的姓名正确无误。如今假设咱们要修改get_formatted_name()，使其还可以处理中间名。这样作时，咱们要确保不破坏这个函数处理只有名和姓的姓名的方式。为此，咱们能够在每次修改get_formatted_name()后都进行测试：运行程序names.py，并输入像Janis Joplin这样的姓名，但这太烦琐了。
　　所幸Python提供了一种自动测试函数输出的高效方式。假若咱们对get_formatted_name()进行自动测试，就能始终信心满满，确信给这个函数提供咱们测试过的姓名时，它都能正确地工做。

11.1.1 单元测试和测试用例

　　Python标准库中的模块unittest提供了代码测试工具。
　　单元测试用于核实函数的某个方面没有问题；测试用例是一组单元测试，这些单元测试一块儿核实函数在各类情形下的行为都符合要求。
　　良好的测试用例考虑到了函数可能收到的各类输入，包含针对全部这些情形的测试。全覆盖式测试用例包含一整套单元测试，涵盖了各类可能的函数使用方式。对于大型项目，要实现全覆盖可能很难。一般，最初只要针对代码的重要行为编写测试便可，等项目被普遍使用时再考虑全覆盖。

11.1.2 可经过的测试

　　要为函数编写测试用例，可先导入模块unittest以及要测试的函数，再建立一个继承unittest.TestCase的类，并编写一系列方法(须要以test或Test开头)对函数行为的不一样方面进行测试。 下面是一个只包含一个方法的测试用例，它检查函数get_formatted_name()在给定名和姓时可否正确地工做：

"""test_name_function.py"""

import unittest
#from name_function import get_formatted_name

def get_formatted_name(first, last): 
    """Generate a neatly formatted full name.""" 
    full_name = first + ' ' + last 
    return full_name.title() 

class NamesTestCase(unittest.TestCase):  # 这个类必须继承unittest.TestCase类
    """测试name_function.py"""   

    def test_first_last_name(self):
        formatted_name = get_formatted_name('janis', 'joplin')

        # ①
        self.assertEqual(formatted_name, 'Janis Joplin')

if __name__ == '__main__':  
# unittest.main()
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

.

Janis Joplin



----------------------------------------------------------------------
Ran 1 test in 0.002s

OK

①处，咱们使用了unittest类最有用的功能之一：一个断言方法。断言方法用来核实获得的结果是否与指望的结果一致。

　　在这里，咱们指望formatted_name的值为"Janis Joplin"。为检查是否确实如此，咱们调用unittest的方法assertEqual()，并向它传递formatted_name和"Janis Joplin"进行比较。代码行unittest.main()让Python运行这个文件中的测试。

说明：

　　书中原代码在本地能够运行，可是在jupyter notebook中运行报错”AttributeError: ‘module’ object has no attribute”，看到Stack Overflow上的问答,参考修改后能够在jupyter notebook中运行。

unittest.main(argv=['first-arg-is-ignored'], exit=False)

unittest.main(argv=['ignored', '-v'], exit=False)

1.1.3 不能经过的测试

　　修改get_formatted_name()，使其可以处理中间名，但这样作时，故意让这个函数没法正确地处理像Janis Joplin这样只有名和姓的姓名。

　　下面是函数get_formatted_name()的新版本，它要求经过一个实参指定中间名：

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

　　运行程序test_name_function.py

"""test_name_function.py"""

import unittest
#from name_function import get_formatted_name

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

class NamesTestCase(unittest.TestCase):  # 这个类必须继承unittest.TestCase类
    """测试name_function.py"""   

    def test_first_last_name(self):
        formatted_name = get_formatted_name('janis', 'joplin')

        self.assertEqual(formatted_name, 'Janis Joplin')

if __name__ == '__main__':  
# unittest.main()
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

E
======================================================================
ERROR: test_first_last_name (__main__.NamesTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "<ipython-input-22-c6f1d3890843>", line 15, in test_first_last_name
    formatted_name = get_formatted_name('janis', 'joplin')
TypeError: get_formatted_name() takes exactly 3 arguments (2 given)

----------------------------------------------------------------------
Ran 1 test in 0.041s

FAILED (errors=1)

11.1.4 测试未经过时怎么办

　　测试未经过时怎么办呢？若是你检查的条件没错，测试经过了意味着函数的行为是对的，而测试未经过意味着你编写的新代码有错。所以，测试未经过时，不要修改测试，而应修复致使测试不能经过的代码：检查刚对函数所作的修改，找出致使函数行为不符合预期的修改。
　　在这个示例中，get_formatted_name()之前只须要两个实参——名和姓，但如今它要求提供名、中间名和姓。就这里而言，最佳的选择是让中间名变为可选的。这样作后，使用相似于Janis Joplin的姓名 进 行 测 试 时 ， 测 试 就 会 通 过 了 ， 同 时 这 个 函 数 还 能 接 受 中 间 名 。 下 面 来 修 改get_formatted_name()，将中间名设置为可选的，而后再次运行这个测试用例。若是经过了，咱们接着确认这个函数可以妥善地处理中间名。

　　将中间名设置为可选的，可在函数定义中将形参middle移到形参列表末尾，并将其默认值指定为一个空字符串。咱们还要添加一个if测试，以便根据是否提供了中间名相应地建立姓名：

"""name_function.py"""

def get_formatted_name(first, last, middle=''):
    """Generate a neatly-formatted full name."""
    if middle:
        full_name = first + ' ' + middle + ' ' + last
    else:
        full_name = first + ' ' + last
    return full_name.title()

　　再次运行test_name_function.py：

"""test_name_function.py"""

import unittest
from name_function import get_formatted_name

class NamesTestCase(unittest.TestCase):  # 这个类必须继承unittest.TestCase类
    """测试name_function.py"""   

    def test_first_last_name(self):
        formatted_name = get_formatted_name('janis', 'joplin')
        print formatted_name
        self.assertEqual(formatted_name, 'Janis Joplin')

if __name__ == '__main__':  
# unittest.main()
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

.

Janis Joplin



----------------------------------------------------------------------
Ran 1 test in 0.003s

OK

11.1.5 添加新测试

　　肯定get_formatted_name()又能正确地处理简单的姓名后，咱们再编写一个测试，用于测试包含中间名的姓名。为此，咱们在NamesTestCase类中再添加一个方法：

"""test_name_function.py"""

import unittest
from name_function import get_formatted_name

class NamesTestCase(unittest.TestCase):  # 这个类必须继承unittest.TestCase类
    """测试name_function.py"""   

    def test_first_last_name(self):
        formatted_name = get_formatted_name('janis', 'joplin')
        print formatted_name
        self.assertEqual(formatted_name, 'Janis Joplin')

    def test_first_last_middle_name(self):
        formatted_name = get_formatted_name(
            'wolfgang', 'mozart', 'amadeus')
        self.assertEqual(formatted_name, 'Wolfgang Amadeus Mozart')

if __name__ == '__main__':  
# unittest.main()
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

...

Janis Joplin



----------------------------------------------------------------------
Ran 3 tests in 0.007s

OK

　　咱们将这个方法命名为test_first_last_middle_name()。方法名必须以test_打头，这样它才会在咱们运行test_name_function.py时自动运行。这个方法名清楚地指出了它测试的是get_formatted_name()的哪一个行为，这样，若是该测试未经过，咱们就会立刻知道受影响的是哪一种类型的姓名。在TestCase类中使用很长的方法名是能够的；这些方法的名称必须是描述性的，这才能让你明白测试未经过时的输出；这些方法由Python自动调用，你根本不用编写调用它们的代码。
　　为测试函数get_formatted_name()，咱们使用名、姓和中间名调用它，再使用assertEqual()检查返回的姓名是否与预期的姓名（名、中间名和姓）一致。

习题11-1 城市和国家：

　　编写一个函数，它接受两个形参：一个城市名和一个国家名。这个函数返回一个格式为 City, Country 的字符串，如 Santiago, Chile 。将这个函数存储在一个名为 city_functions.py 的模块中。
　　建立一个名为 test_cities.py 的程序，对刚编写的函数进行测试（别忘了，你须要导入模块 unittest 以及要测试的函数）。编写一个名为 test_city_country()的方法，核实使用相似于 ‘santiago’ 和 ‘chile’ 这样的值来调用前述函数时，获得的字符串是正确的。
运行 test_cities.py，确认测试 test_city_country()经过了。

"test_cities.py"

import unittest
from  city_functions import city_country

class CityCountryTest(unittest.TestCase):

    def test_city_country(self):
        formatted_string = city_country('santiago', 'chile')
        self.assertEqual(formatted_string, 'Santiago, Chile')

if __name__ == '__main__':
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

...

Janis Joplin



----------------------------------------------------------------------
Ran 3 tests in 0.007s

OK

习题11–2 人口数量：

　　修改前面的函数，使其包含第三个必不可少的形参 population，并返回一个格式为 City, Country – population xxx 的字符串，如 Santiago, Chile – population 5000000。运行 test_cities.py，确认测试 test_city_country()未经过。
　　修改上述函数，将形参population 设置为可选的。再次运行 test_cities.py，确认测试 test_city_country()又经过了。
　　再编写一个名为 test_city_country_population()的测试，核实可使用相似于 ‘santiago’、’chile’ 和 ‘population=5000000’ 这样的值来调用这个函数。再次运行test_cities.py，确认测试 test_city_country_population()经过了。

"test_cities.py"
"加一个形参population"

import unittest
from  city_functions import city_country

class CityCountryTest(unittest.TestCase):

    def test_city_country(self):
        formatted_string = city_country('santiago', 'chile')
        self.assertEqual(formatted_string, 'Santiago, Chile')

if __name__ == '__main__':
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

E
======================================================================
ERROR: test_city_country (__main__.CityCountryTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "<ipython-input-1-40099b039d57>", line 9, in test_city_country
    formatted_string = city_country('santiago', 'chile')
TypeError: city_country() takes exactly 3 arguments (2 given)

----------------------------------------------------------------------
Ran 1 test in 0.002s

FAILED (errors=1)

"test_cities.py"
"形参可选"

import unittest
from  city_functions import city_country

class CityCountryTest(unittest.TestCase):

    def test_city_country(self):
        formatted_string = city_country('santiago', 'chile')
        self.assertEqual(formatted_string, 'Santiago, Chile')

if __name__ == '__main__':
    unittest.main(argv=['first_arg-is-ignored'], exit=False)

.
----------------------------------------------------------------------
Ran 1 test in 0.002s

OK

"test_cities.py"
"测试人口"

import unittest
from  city_functions import city_country

class CityCountryTest(unittest.TestCase):

    def test_city_country(self):
        formatted_string = city_country('santiago', 'chile')
        self.assertEqual(formatted_string, 'Santiago, Chile')

    def test_city_country_population(self):
        formatted_string = city_country('santiago', 'chile', 5000000)
        self.assertEqual(formatted_string, 'Santiago, Chile - population 5000000')

if __name__ == '__main__':
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

..
----------------------------------------------------------------------
Ran 2 tests in 0.005s

OK

11.2 测试类

11.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中

"""11.2.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

"""编写一个使用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 = raw_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: English
Language: Spanish
Language: English
Language: Mandarin
Language: q

Thank you to everyone who participated in the survey!
Survey results:
- English
- Spanish
- English
- Mandarin

"""11.2.3 测试 AnonymousSurvey 类 """

import unittest
from survey import AnonymousSurvey

class TestAnonymousSurvey(unittest.TestCase):
    """Tests for the class AnonymousSurvey."""


    def test_store_single_response(self):
        """Test that a single response is stored properly."""
        question = "What language did you first learn to speak?"
        my_survey = AnonymousSurvey(question) 
        my_survey.store_response('English') 

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


if __name__ == '__main__':           
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

.
----------------------------------------------------------------------
Ran 1 test in 0.001s

OK

　　这很好，但只能收集一个答案的调查用途不大。下面来核实用户提供三个答案时，它们也将被妥善地存储。为此，咱们在TestAnonymousSurvey中再添加一个方法：

import unittest
from survey import AnonymousSurvey

class TestAnonymousSurvey(unittest.TestCase):
    """Tests for the class AnonymousSurvey."""


    def test_store_single_response(self):
        """Test that a single response is stored properly."""
        question = "What language did you first learn to speak?"
        my_survey = AnonymousSurvey(question) 
        my_survey.store_response('English') 

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

    def test_store_three_responses(self):
        """Test that three individual responses are stored properly."""
        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(argv=['first-arg-is-ignored'], exit=False)

..
----------------------------------------------------------------------
Ran 2 tests in 0.004s

OK

　　效果很好，但这些测试有些重复的地方。下面使用unittest的另外一项功能来提升它们的效率。

11.2.4 方法 setUp()

　　在前面的test_survey.py中，咱们在每一个测试方法中都建立了一个 AnonymousSurvey 实例，并在每一个方法中都建立了答案。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):
    """Tests for the class AnonymousSurvey."""

    def setUp(self):
        """ Create a survey and a set of responses for use in all test methods. """
        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):
        """Test that a single response is stored properly."""
        self.my_survey.store_response(self.responses[0])
        self.assertIn(self.responses[0], self.my_survey.responses)


    def test_store_three_responses(self):
        """Test that three individual responses are stored properly."""
        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(argv=['first-arg-is-ignored'], exit=False)

..
----------------------------------------------------------------------
Ran 2 tests in 0.003s

OK

　　方法setUp()作了两件事情：建立一个调查对象；建立一个答案列表。存储这两样东西的变量名包含前缀self（即存储在属性中），所以可在这个类的任何地方使用。这让两个测试方法都更简单，由于它们都不用建立调查对象和答案。方法test_store_single_response()核 实 self.responses 中 的 第 一 个 答 案 ——self.responses[0]—— 被 妥 善 地 存 储 ， 而 方 法test_store_three_response()核实self.responses中的所有三个答案都被妥善地存储。
　　再次运行test_survey.py时，这两个测试也都经过了。若是要扩展AnonymousSurvey，使其容许每位用户输入多个答案，这些测试将颇有用。修改代码以接受多个答案后，可运行这些测试，确认存储单个答案或一系列答案的行为未受影响。
　　测试本身编写的类时，方法setUp()让测试方法编写起来更容易：可在setUp()方法中建立一系列实例并设置它们的属性，再在测试方法中直接使用这些实例。相比于在每一个测试方法中都建立实例并设置其属性，这要容易得多。

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

11-3 雇员:
　　编写一个名为 Employee 的类，其方法__init__()接受名、姓和年薪，并将它们都存储在属性中。编写一个名为give_raise()的方法，它默认将年薪增长 5000美圆，但也可以接受其余的年薪增长量。
　　为 Employee 编写一个测试用例，其中包含两个测试方法：test_give_default_raise()和 test_give_custom_raise()。使用方法 setUp()，以避免在每一个测试方法中都建立新的雇员实例。运行这个测试用例，确认两个测试都经过了。

class Employee():
    def __init__(self,last_name, first_name, salary=10000 ):
        self.last_name = last_name
        self.first_name = first_name
        self.salary = salary

    def give_raise(self,added=5000):
        self.salary += added
        return added

import unittest
from EmployeeFile import Employee

class TestEmployeeRaise(unittest.TestCase):

    def setUp(self):
        self.test1 = Employee('Tom', 'Smith')
        self.test2 = Employee('Tom', 'Smith',3000)


    def test_give_default_raise(self):
        self.salary1 = self.test1.give_raise()
        self.assertEqual(str(self.salary1), '5000')


    def test_give_custom_raise(self):
        self.salary2 = self.test2.give_raise(3000)
        self.assertEqual(str(self.salary2), '3000')


if __name__ == '__main__':
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

..
----------------------------------------------------------------------
Ran 2 tests in 0.003s

OK

11.3 小结

　　测试是不少初学者都不熟悉的主题。做为初学者，并不是必须为你尝试的全部项目编写测试；但参与工做量较大的项目时，你应对本身编写的函数和类的重要行为进行测试。这样你就可以更加肯定本身所作的工做不会破坏项目的其余部分，你就可以为所欲为地改进既有代码了。若是不当心破坏了原来的功能，你立刻就会知道，从而可以轻松地修复问题。相比于等到不满意的用户报告bug后再采起措施，在测试未经过时采起措施要容易得多。 　　若是你在项目中包含了初步测试，其余程序员将更敬佩你，他们将可以更驾轻就熟地尝试使用你编写的代码，也更愿意与你合做开发项目。若是你要跟其余程序员开发的项目共享代码，就必须证实你编写的代码经过了既有测试，一般还须要为你添加的新行为编写测试。 　　请经过多开展测试来熟悉代码测试过程。对于本身编写的函数和类，请编写针对其重要行为的测试，但在项目早期，不要试图去编写全覆盖的测试用例，除非有充分的理由这样作。