python基础篇(二十三)——测试代码(上)

雨点打透心脏的1/2处 2022-09-04 12:57 172阅读 0赞

## 前言 ##

我们通过前面的两篇文章给大家介绍了[文件的输入输出][Link 1]以及在编程过程中常见的[异常情况][Link 2]以及具体的处理方式。本文给大家介绍Python写完代码后，如何测试自己代码是否符合逻辑以及有无bug。首先为大家介绍测试函数。

## 测试函数 ##

在学习测试之前，我们首先要有测试的代码。下面是一个简单的函数，它接受名和姓并返回整洁的姓名：

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

函数`get_formated_name()`将名和姓合并成姓名，在名和姓之间加上一个空格，并将它们的首字母大写，再返回结果。为核实`get_formated_name()`像期望那样的工作，我们来编写一个使用这个函数的程序。程序`names.py`让用户输入名和姓，并显示整洁全名：

from name_function import get_formated_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("\nPlease give me a last name:")
        if last == 'q':
            break
        formatted_name = get_formated_name(first, last)
        print("\tNeatly formatted name: " + formatted_name + '.')

这个程序从`name_function.py`中导入`get_formatted_name()`。用户可输入一系列的名和姓，并看到格式整洁的全名：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center][]  
  从上述输出可知，合并得到的姓名正确无误。现在假设我们要修改`get_formatted_name()`，使其还能够处理中间名。这样做时，我们要确保不破坏这个函数处理只有名和姓的姓名的方式。为此，我们可以在每次修改`get_formatted_name()`后都进行测试：运行程序`names.py`，并输入像`Stefan Oliver`这样的姓名，但这太繁琐了。所幸Python提供了一种自动测试函数输出的高效方式。倘若我们对`get_formatted_name()`进行自动测试，就能始终信心满满，确信给这个函数提供我们测试过的姓名时，它都能正确的工作。  
  这里需要我们注意的是：我们在上图中可以看出在导入文件时候会有红色的波浪线，但是不要紧张，那不是报错，只是导入自己写的类就会出现红线。这点还需要读者格外的注意。

## 1、单元测试和测试用例 ##

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

## 2、可通过测试 ##

创建测试用例的语法需要一段时间才可以习惯，但测试用例创建后，再添加针对函数的单元测试就很简单了。要为函数编写测试用例，可先导入模块`unittest`以及要测试的函数，再创建一个继承`unittest.TestCast`的类，并编写一系列方法对函数行为的不同方面进行测试。  
  下面是一个只包含一个方法的测试用例，它检查函数`get_formatted_name()`在给定名和姓时能否正确地工作：

import unittest
    from name_function import get_formated_name
    class NamesTestCase(unittest.TestCase):
        """测试name_function.py"""
        def test_first_last_name(self):
            """能够正确地处理Stefan_Napoleon这样的姓名吗？"""
            formatted_name = get_formated_name('薛', '仁贵')
            self.assertEqual(formatted_name, '薛 仁贵')
    unittest.main

首先，我们导入模块`unittest`和要测试的函数`get_formatted_name()`。我们首先创建了一个名为`NamesCase`类，用于包含一系列针对`get_formatted_name()`的单元测试。当然我们可随便给这个类命名，但最好让它看起来与要测试的函数相关，并包含字样Test。这个类必须继承`unittest.TestCase类`，这样Python才知道如何运行我们编写的测试。  
  `NamesTestCase`只包含一个方法，用于测试`get_formatted_name()`的一个方面。我们将这个方面命名为`test_first_last_name()`，因为我们要核实的是只有名和姓的姓名能否正常的格式化。当我们运行test\_name function.py时候，所有以test\_打头的方法都将自动运行。在这个方法中，我们调用了要测试的函数，并存储了要测试的返回值。在这个示例中，我们要使用实参`薛`和`仁贵`调用`get_formatted_name()`，并将结果存储到变量`formatted_name`中。  
  另外，我们使用了`unittest`类最有用的功能之一：一个断言方法。断言方法用来核实得到的结果是否与期望的结果一致。在这里，我们知道`get_formatted_name()`的值为`薛仁贵`。为检查是否确实如此，我们调用`unittest`的方法`assertEqual()`，并向它传递`formatted_name`和`薛仁贵`.代码行self.assertEqual(formatted\_name,薛仁贵的意思是说：将`formatted_name`的值同字符串`薛仁贵`相比较，如果它们相等，就OK了，如果他们不相等就返回消息。  
  代码行 `unitest.main`让Python运行这个文件的测试。具体结果如下：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center 1][]  
  上图的输出表明，给定包含名和姓的姓名时，函数`get_formatted_name()`总是能够正确的处理。修改`get_formatted_name()`后，可再次运行这个测试用例。如果它通过了，我们就知道在给定姓名时。这个函数依然能够正确处理。

## 3、不能通过的测试 ##

测试未通过时结果是什么样的呢？我们来修改`get_formatted_name()`，使其能够处理中间名，但这样做时，故意让这个函数无法正确地处理像`薛仁贵`这样只有名和姓的姓名。下面是函数`get_formatted_name()`的新版本，它要求通过一个实参指定中间名：

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

这个版本应该能够正确地处理包含中间名的姓名，但对其进行测试时，我们发现它再也不能正确地处理只有名和姓的姓名。这次运行程序`test_name_function.,py`时，输出如下：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center 2][]  
  其中包含的信息很多，因为测试未通过时，需要让你知道的事情可能有很多。第一行输出只有一个字母E，它指出测试用例中有一个单元测试导致的错误。测试用例包含众多单元测试时，`NamesTestCase`中的`test_first_last_name()`导致了错误。测试用例包含众多单元测试时，知道哪个测试未通过至关重要。我们看到了一个标准的traceback，它指出了函数调用`get_formatted_name('薛'， '仁贵')`有问题，因为它缺少一个必不可少的位置实参。  
  我们还看到运行了一个单元测试。最后，还看到了一条消息，它指出整个测试用例都未通过，因为运行该测试用例时发生一个错误。这条消息位于输出末尾，让你一眼就能看到——你可不希望为获悉有多少测试未通过而翻阅长长的输出。

## 4、测试未通过时怎么办 ##

测试未通过时怎么办呢？如果你检查的条件没错，测试通过了意味着函数的行为是对的，而测试未通过意味着你编写的新代码有错。因此，测试未通过时，不要修改测试，而应修复导致测试不能通过的代码；检查刚对函数所做的修改，找出导致函数行为不符合预期的修改。  
  在这个示例中，`get_formatted_name()`以前只需要两个实参——名和姓，但现在它要求提供名、中间名和姓。新增的中间名参数是必不可少的，这导致`get_formatted_name()`的行为不符合预期。就这而言，最佳的选择是让中间名设置为可选的，然后再次运行这个测试用例。如果通过了，我们接着确认这个函数能够妥善地处理中间名。  
  要将中间名设置为可选的，可在函数定义中将形参middle 移到形参列表末尾，并将其默认值指定为一个空字符串。我们还要添加一个if测试，已根据是否提供了中间名相应地创建姓名：

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

在get\_formatted\_name()的这个新版本中，中间名是可选的。如果向这个函数传递了中间名，姓名将包含名、中间名和姓，否则姓名只包含名和姓。现在，对于两种不同的姓名，这个函数都应该能够正确的处理。为确定这个函数依然能够正确地处理像薛仁贵这样的姓名，具体运行结果如下：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center 3][]  
  现在，测试用例通过了。太好了，这意味着这个函数又能正确地处理像薛仁贵这样的姓名了，而且我们无需手工测试这个函数。这个函数很容易就修复了，因为未通过的测试让我们得知新代码破坏了函数原来的行为。

## 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):
            """能够正确地处理Stefan_Napoleon这样的姓名吗？"""
            formatted_name = get_formatted_name('薛', '仁贵')
            self.assertEqual(formatted_name, '薛 仁贵')
    
        def test_first_last_middle_name(self):
            formatted_name = get_formatted_name(
                'wolfgang', 'mozart', 'amadeus'
            )
            self.assertEqual(formatted_name, 'Wolfgang Amadeus Mozart')
    unittest.main

我们将这个方法命名为`test_first_last_middle_name()`。方法名必须以test\_打头，这样它才会在我们运行test\_name\_function.py时自动运行。这个方法名清楚地指出了它测试的是`get_formatted_name()`的那个行为，这样，如果该测试未通过，我们就会马上知道受影响的是哪种类型的姓名。在`TestCase`类中使用很长的方法名是可以的；这些方法的名称必须是描述性的，这才能让明白测试未通过时的输出；这些方法由Python自动调用，你根本不用编写调用它们的代码。  
  为测试函数`get_formatted_name()`,我们使用名、姓和中间名调用它，再使用`assertEqual()`检查返回的姓名是否与预期的姓名一致。我们再次运行test\_name\_function.py时，两个测试都通过了：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center 4][]  
  太好了，我们现在知道，这个函数又能正确地处理像薛仁贵的姓名，我们还深信它也够正确地处理像代码中这样的姓名。

## 总结 ##

我们通过前面的两篇文章给大家介绍了[文件的输入输出][Link 1]以及在编程过程中常见的[异常情况][Link 2]以及具体的处理方式。本文给大家介绍了Python写完代码后，如何测试自己代码是否符合逻辑以及有无bug。包括单元测试和测试用例以及针对可通过测试和不能通过测试时候的具体解决方案，最后介绍了新的测试。Python是一门注重实际操作的语言，它是众多编程语言中最简单，也是最好入门的。当你把这门语言学会了，再去学习java、go以及C语言就比较简单了。当然，Python也是一门热门语言，对于人工智能的实现有着很大的帮助，因此，值得大家花时间去学习。生命不息，奋斗不止，我们每天努力，好好学习，不断提高自己的能力，相信自己一定会学有所获。加油！！！

[Link 1]: https://blog.csdn.net/Oliverfly1/article/details/119295612
[Link 2]: https://blog.csdn.net/Oliverfly1/article/details/119513472
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center]: /images/20220829/a7299eee0bd74ccfaa5b6936c48708ff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20220829/743c0bfc861042919ad634e1db4474f7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20220829/b4f9c8d6208d44d892f5e0c0a576a725.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20220829/2ff7d2502ef94f67af43bafcf0332911.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09saXZlcmZseTE_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20220829/5c9d34ebf10340b9af8f39509f8fab7d.png