Python--测试代码
Python--测试代码
编写函数或类时，还可为其编写测试。通过测试，可编写代码而对各种输入都能过按要求的那样工作。测试让你身心，即便有更多人使用你的程序，它也能正确地工作。在程序中添加新代码时，也可以对其进行测试，确认不会破坏程序既有的行为。程序员都会犯错，因此每个程序员都必须经常测试其代码，在用户发现问题前找出它们。
在本篇中，你将学习如何使用Python模块unittest中的工具来测试代码，还将学习编写测试用例，核实一系列输入都将得到预期的输出。你将看到测试通过了是什么样子，测试未通过又是什么样子，还将知道测试未通过如何有助于改进代码。你将学习如何测试函数和类。并将知道该为项目编写多少个测试。
一、测试函数
要学习测试，必须有要测试的代码。下面是一个简单的函数，它接收名和姓并返回完整的姓名：
函数get_formatted_name()将名和姓合并成姓名：在名和姓之间加上一个空格并将其首字母大写，再返回结果。为核实get_formatted_name()像期望的那样工作，我们来编写一个使用该函数的程序。程序names.py让用户输入名和姓，并显示完整的姓名：
这个程序从name_function.py中导入get_formatted_name()。用户可输入一系列名和姓，并看到完整的姓名：
从上述输出可知，合并得到的姓名正确无误。现在假设要修改get_formatted_name()，使其还能够处理中间名。这样做时，要确保不破坏这个函数处理只含有名和姓的方式。为此，可在每次修改get_formatted_name()后都进行测试：运行程序name.py，并输入像Zhou Jielun这样的姓名。不过这太烦琐了。所幸Python提供了一种自动测试函数输出的高效方式。倘若对get_formatted_name()进行自动测试，就能始终确信当提供测试过的姓名时，该函数都能正确工作。
1. 单元测试和测试用例
Python标准库中的模块unittest提供了代码测试工具。单元测试用于核实函数的某个方面没有问题。测试用例是一组单元测试，它们一道核实函数在各种情形下的行为都符合要求。良好的测试用例考虑到了函数可能受到的各种输入，包含针对所有这种情形的测试。全覆盖的测试用例包含一整套单元测试，涵盖了各种可能的函数使用方式。对于大型项目，要进行全覆盖测试可能很难。通常，最初只要针对代码的重要行为编写测试即可，等项目被广泛使用时再考虑全覆盖。
2. 可通过的测试
你需要一段时间才能习惯创建测试用例的语法，但创建测试用例之后，再添加针对函数的单元测试就很简单了。要为函数编写测试用例，可先导入模块unittest和要测试的函数，再创建一个继承unittest.TestCase的类，并编写一系列方法对函数行为的不同方面进行测试。
下面的测试用例只包含一个方法，它检查函数get_formatted_name()在给定明和姓时能否正确工作：
首先，导入了模块unittest和要测试的函数get_formatted_name()。然后，创建了一个名为NamesTestCase的类，用于包含一系列针对get_formatted_name()的单元测试。这个类可以随意命名，但最好让它看起来与要测试的函数相关并包含Test字样。这个类必须继承unittest.TestCase类，这样Python才知道如何运行你编写的测试。
NamesTestCase只包含一个方法，用于测试get_formatted_name()的一个方面。将该方法命名为test_first_last_name()因为要合适的是只有名和姓的姓名能否被正确格式化。运行test_name_function.py时，所有以test_打头的方法都将自动运行。在这个方法中，调用了要测试的函数。在本例中，使用实参zhou和Jielun调用get_formatted_name()，并将结果赋给变量formatted_name。
最后，使用了unittest类最有用的功能之一：断言方法。断言方法核实得到的结果是否与期望的结果一直。在这里，我们知道get_formatted_name()应返回名和姓首字母大写且之间有一个空格的姓名，因此期望formatted_name的值为Zhou Jielun。为检查是否确实如此，我们调用unittest的方法assertEqual()，并向它传递formatted_name和Zhou Jielun。代码行
self.assertEqual(formatted_ame, 'Zhou Jielun')
的意思是：“将formatted_name的值与字符串Zhou Jielun比较。如果它们相等，那么完事打击；如果它们不相等，就告诉我一声！”
我们将直接运行这个文件，但需要指出的是，很多测试框架否会先导入测试文件再运行。导入文件时，解释器将在导入的同时执行它。使用if代码块检查特殊变量__name__，这个变量是在程序执行时设置的。如果这个文件作为主程序执行，变量__name__将被设置为__mian__。在这里，调用unittest.main()来运行测试用例。如果这个文件被测试框架导入，变量__name__的值将不是__mian__，因此不会调用unittest.mian()。
运行test_name_function.py时，得到的输出如下：
第一行的句点表名有一个测试通过了。接下来的一行指出Python运行了一个测试，消耗的时间不到0.001秒。最后的OK表名该测试用例中的所有单元测试都通过了。
上述输出表名，给定包含名和姓的姓名时，函数get_formatted_name()总是能正确地处理。修改get_formatted_name()后，可再次运行这个测试用例。如果它通过了，就表名给定Zhou Jielun这样的姓名时，该函数依然能够正确地处理。
3. 未通过的测试
测试未通过时结果是什么样的呢？我们来修改get_formatted_name()，使其能够处理中间名，但同时故意让该函数无法正确处理像Zhou Jielun这样只有名和姓的姓名。
下面是函数get_formatted_name()的新版本，它要求通过一个实参指定中间名：
这个版本应该能够正确处理包含中间名的姓名，但对其进行测试时，我们发现它不再能正确处理只有名和姓的姓名。这次运行程序test_name_function.py时，输出如下：
里面包含很多信息，因为测试未通过时，需要让你知道的事情可能有很多。第一行输出只有一个字母E，指出测试用例中有一个单元测试导致了错误。接下来，我们看到NamesTestCase中的test_first_last_name()导致了错误。测试用例包含众多单元测试时，知道哪个测试未通过至关重要。接着，我们看到了一个标准的traceback，指出函数调用get_formatted_name('zhou', 'jielun')有问题，因为缺少一个必不可少的位置实参。
我们还看到运行了一个单元测试。最后是一条消息，指出整个测试用例未通过，因为运行该测试用例时发生了一个错误。这条消息位于输出末尾，让你一眼就能看到。你可不希望委获悉有多少测试未通过而翻阅长长的输出。
4. 测试未通过时怎么办
测试未通过时怎么办呢？如果你检查的条件没错，测试通过意味着函数的行为是对的，而测试未通过意味着编写的新代码有错。因此，测试未通过时，不要修改测试，而应修复导致错误不能通过的代码：检查刚刚对函数所做的修改，找出导致函数行为不符合预期的修改。
在本例中，get_formatted_name()以前只需要名和姓两个实参，但现在要求提供名、中间名和姓。新增的中间名参数是必不可少的，这导致get_formatted_name()的行为不符合预期。就这里而言，最佳的选择是让中间名变为可选的。这样做后，使用类似于Zhou Jielun的姓名进行测试时，测试就又能通过了，而且也可以接受中间名。下面来修改get_formatted_name()，将中间名设置为可选的，然后再次运行这个测试用例。如果通过了，就接着确认该函数能够妥善地处理中间名。
要将中间名设置为可选的，可在函数定义中将形参middle移到形参列表末尾，并将其默认值指定为一个空字符串。还需要添加一个if测试，以便根据是否提供了中间名相应地创建姓名：
在get_formatted_name()的这个新版本中，中间名是可选的。如果向该函数传递了中间名，姓名将包含名、中间名和姓，否则姓名将只包含名和姓。现在，对于两个不同的姓名，这个函数都应该能够正确地处理。为确定这个函数依然能够处理像Zhou Jielun这样的姓名，我们再次运行test_name_function.py:
现在，测试用例通过了。太好了，这意味着这个函数又能正确处理像Zhou Jielun这样的姓名了，而且我们无需手工测试这个函数。这个函数之所以很容易修复，是因为未通过的测试让我们得知新代码破坏了函数原来的行为。
5. 添加新测试
确定get_formatted_name()又能正确处理简单的姓名后，我们再编写一个测试，用于测试包含中间名的姓名。为此，在NamesTestCase类中再添加一个方法：
将该方法命名为test_first_last_middle_name()。方法名必须以test_打头，这样它才会在我们运行test_name_function.py时自动运行。这个方法名清楚地指出了它测试的是get_formatted_name()的哪个行为。这样，如果该测试未通过，我们就能马上知道受影响的是哪种类型的姓名，可以在TestCase类中使用很长的方法名，而且这些方法名必须是描述性的，这样你才能看懂测试未通过时的输出。这些方法由Python自动调用，你根本不用编写调用它们的代码。
为测试函数get_formatted_name()，我们使用名、姓和中间名调用它，再使用assertEqual()检查返回的姓名是否与预期的姓名（姓、中间名和名）一致。再次运行test_name_function.py时，两个测试都通过了：
太好了！现在我们知道，这个函数又能正确地处理像Zhou Jielun这样的姓名了，而且深信它也能够正确地处理像Zhou Jie Lun这样的姓名。
二、测试类
在前面，你编写了针对单个函数的测试，下面来编写针对类的测试。很多程序中都会用到类，因此证明你的类能够正确工作大有裨益。如果针对类的测试通过了，你就能确信对类所做的改进没有意外地破坏其原有的行为。
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中 |
| assertNotIn(item, list) | 核实item不在list中 |
2. 一个要测试的类
类的测试与函数的测试相似，你所做的大部分工作是测试类中的方法的行为。不过还是存在一些不同之处，下面编写一个要测试的类。来看一个帮助管理匿名调查的类：
这个类首先存储了一个调查问题，并创建了一个空列表，用于存储答案。这个类包含打印调查问题的方法，在答案列表中添加新答案的方法，以及将存储在列表中的答案都打印出来的方法。要创建该类的示例，只需提供一个问题即可，有了表示调查的示例后，就可使用show_question()来显示其中的问题，使用store_response()来存储答案并使用show_results()来显示调查结果。
为证明AnonymousSurvey类能够正确工作，编写一个使用它的程序：
这个程序定义了一个问题"What language did you first learn to speak?"，并使用该问题创建了一个AnonymousSurvey对象，接下来，这个程序调用show_question()来现实问题，并提示用户输入答案。在收到每个答案的同时将其存储起来。用户输入所有答案（输入q要求退出）后，调用show_results()来打印调查结果：
AnonymousSurvey类可用于进行简单的匿名检查。假设我们将它放在了模块survey中，并想进行改进：让每位用户都可输入多个答案；编写一个方法，只列出不同的答案出现了多少次；再编写一个类，用于管理非匿名调查。
进行上述修改存在风险，可能影响AnonymousSurvey类的当前行为。例如，允许每位用户输入多个答案时，可能会不小心修改单个答案的方式。要确认在开发这个模块时没有破坏既有行为，可以编写针对这个类的测试。
3. 测试AnonymousSurvey类
下面来编写一个测试，对AnonymousSurvey类的行为的一个方面进行验证：如果用户面对调查问题只提供一个答案，这个答案也能被妥善地存储。为此，我们将在这个答案被存储后，使用方法saaertIn()来核实它确实在答案列表中：
首先，导入模块unittest和要测试的类AnonymousSurvey。将测试用例命名为TestAnonymousSurvey，它也继承了unittest.TestCase。第一个测试方法验证：调查问题的单个答案被存储后，会包含在调查结果列表中。对于这个方法，一个不错的描述性名称是test_store_single_question()。如果这个测试未通过，我们就能通过输出中的方法得知，在存储单个调查答案方法存在问题。
要测试类的行为，需要创建其实例。然后使用为"What language did you first learn to speak?"
创建一个名为my_survey的实例，然后使用方法store_response()存储单个答案Chinese。接下来，检查Chinese是否包含在列表my_survey.responses中，以核实这个答案是否被妥善地存储了。
当我们运行test_survey.py时，测试通过了：
这很好，但只能收集一个答案的调查用途不大。下面来合适当用户提供三个答案时，它们也将被妥善地存储。为此，在TestAnonymousSurvey中再添加一个方法：
我们将该方法命名为test_store_three_responses()，并像对test_store_single_response()所做的一样，在其中创建一个调查对象。定义一个包含三个不同答案的列表，再对其中每个答案调用store_response()。存储这些答案后，使用一个循环来确认每个答案都包含在my_survey.responses中。
再次运行test_survey.py时，两个测试（针对单个答案的测试和针对三个答案的测试）都通过了：
前述做法的效果很好，但这些测试有些重复的地方。下面使用unittest的另一项功能来提高其效率。
4. 方法setUp()
在前面test_survey.py中，我们在每个测试方法中都创建了一个AnonymousSurvey实例，并在每个方法中都创建了答案。unittest.TestCase类包含的方法setUp()让我们只需创建这些对象一次，就能在每个测试方法中使用。如果在TestCase类中包含了方法setUp()，Python将先运行它，再运行各个以test_打头的方法。这样，在你编写的每个测试方法中，都可使用的方法setUp()中创建的对象。
下面使用setUp()来创建一个调查对象和一组答案，供方法test_store_single_response()和test_store_three_responses()使用：
方法setUp()做了两件事情：创建一个调查对象，以及创建一个答案列表。存储这两样东西的变量名包含前缀self（即存储在属性中），因此可在这个类的任何地方使用。这让两个测试方法都更简单，因为它们都不用创建调查对象和答案了。方法test_store_single_reponse()核实self.responses中的第一个答案self.responses中的全部三个答案都被妥善地存储。
再次运行test_survey.py时，这两个测试也都通过了。如果要扩展AnonymousSurvey，使其允许每位用户输入多个答案，这些测试将很有用。修改代码以接收多个答案后，可运行这些测试，确认每位用户输入多个答案，这些测试将很有用。修改代码以接受多个答案后，可运行这些测试，确认存储单个答案或一系列答案的行为未受影响。
测试自己编写的类时，方法setUp()让测试方法编写起来更容易：可在setUp()中创建一系列实例并设置其属性，再在测试方法中直接使用这些实例。相比于在每个测试方法中都创建实例并设置其属性，这要容易得多。
注意：运行测试用例时，每完成一个单元测试，Python都打印一个字符：测试通过时打印一个句点，测试应发错误时打印一个E，而测试导致断言失败时则打印一个F。这就是你运行测试用例时，在输出的第一行中看到的句点和字符数量各不相同的原因，如果测试用例包含很多单元测试，需要运行很长时间，就可通过观察这些结果来获悉有多少个测试通过了。
三、小结
在本篇学习了：如何使用模块unittest中的工具来为函数和类编写测试；如何编写继承unittest.TestCase的类，以及如何编写测试方法，以核实函数和类的行为符合预期；如何使用方法setUp()来根据类高效地创建实例并设置其属性，以便在类的所有测试方法中使用。
测试是很多初学者不熟悉的主题。作为初学者，并非必须为你尝试的所有项目编写测试。然而参与工作量较大的项目时，你应该对自己所编写函数和类的重要行为进行测试。这样你就能够更加确定自己所做的工作不会破坏项目的其他部分，从而自由地改进既有代码。如果不小心破坏了原来的功能，你马上就会知道，而且能够轻松地修复问题。比起等到不满意的用户报告bug后再采取措施，在测试未通过时采取措施要容易得多。
如果你在项目中包含了初步测试，将得到其他程序员的尊敬。他们不仅能够更得心应手地使用你编写的代码，也更愿意与你合作开发项目。如果要更其他程序员开发的项目共享代码，就必须证明你编写的代码通过了既有测试，通常还需要为你添加的新行为编写测试。
请通过多开展测试来熟悉代码测试过程。对于自己编写的函数和类，请编写针对其重要行为的测试。不过不要在项目早期试图编写全覆盖的测试用例，除非有充分的理由。
