zoukankan      html  css  js  c++  java
  • 第 11 章 测试代码

        编写函数或类时,还可为其编写测试。通过测试,可确定代码面对各种输入都能够按要求的那样工作。测试让我们信心满满,深信即便有更多的人使用我们的

    程序,它也能正确地工作。在程序中添加新代码时,我们也可以对其进行测试,确认它们不会破坏程序既有的行为。程序员都会犯错,因此每个程序员都必须经常

    测试其代码,在用户发现问题前找出它们。

        在本章中,我们将学习如何使用Python模块unittest中的工具来测试代码。我们将学习编写测试用例,核实一系列输入都将得到预期的输出。我们将看到测试通过了是什么样子,测试未通过是什么样子,还将知道测试未通过如何有助于改进代码。我们将学习如何测试函数和类,并将知道该为项目编写多少个测试。

    11.1  测试函数

        要测试函数,得有要测试的代码。下面一个简单额函数,它接受名和姓并返回整洁的姓名:

      name_funcition.py

        def get_formatted_name(first,last):
      ''''获得用户完整的姓名'''
        full_name = first + " " + last
        return full_name.title()
        函数get_formatted_name()将名和姓合并成姓名,在名和姓之间加上一个空格,并将它们的首字母都大写,再返回结果。为核实get_formatted_name()像

    期望的那样工作,我们来编写一个使用这个函数的程序。程序names.py让用户输入名和姓,并显示整洁的全名:

    from name_function import get_formatted_name
    print("Enter 'q' at any time to quit.")
    while True:
      first = input(" Please 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(" Neatly formatted name: " + formatted_name + ".")

        这个程序从name_function.py中导入get_formatted_name()。用户输入一系列的名和姓,并看到格式整洁的全名:

        Enter 'q' at any time to quit.

      Please give me a first name: geng
      Please give me a last name: changxue
          Neatly formatted name: Geng Changxue.

      Please give me a first name: jains
      Please give me a last name: joplin
          Neatly formatted name: Jains Joplin.

      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的类,并编写一系列方法对函数行为的不同方面进行测试。

        下面是一个只包含一个方法的测试用例,它检查函数get_formatted_name()在给定名和姓时能否正确地工作:

     import unittest

    from name_function import get_formatted_name

    class NameTestCase(unittest.TestCase): --(1)
    '''测试name_function.py'''

    def test_first_last_name(self):

    '''能够正确地处理像janis joplin这样的姓名吗?'''
    formatted_name = get_formatted_name('janis','joplin') --(2)

    self.assertEqual(formatted_name, "Janis Joplin") --(3)

    unittest.main()
    首先,我们导入了模块unittest和要测试的函数get_formatted_name()。在(1)处,我们创建了一个名为NamesTestCase的类,用于包含一系列针对get_
    formatted_name()的单元测试。我们可随便给这个类命名,但最好让它看起来与要测试的函数相关,并包含字样Test。这个类必须继承unittest.TestCase类
    ,这样Python才知道如何运行我们编写的测试。
    NamesTestCase只包含一个方法,用于测试get_formatted_name()的一个方面。我们将这个方法命名为test_first_last_name(),因为我们要核实的是
    只有名和姓的姓名能否被正确地格式化。我们运行test_name_function.py时,所有以test_打头的方法都将自动运行。在这个方法中,我们调用了要测试的函
    数,并存储了要测试的返回值。在这个实例中,我们使用实参'janis'和'joplin'调用get_formatted_name(),并将结果存储到变量formatted_name中。
    在(3)处,我们使用了unittest类最有用的功能之一:一个断言方法。断言方法用来核实得到的结果是否与期望的结果一致。在这里,我们知道get_forma
    tted_name()应返回这样的姓名,即名和姓的首字母为大写,且它们之间有一个空格,因此我们期望formatted_name的值为Janis Joplin。为检查是否确实如
    此,我们调用unittest的方法assertEqual(),并向它传递formatted_name和'Janis Joplin'。代码行self.assertEqual(formatted_name,'Janis Joplin'
    )的意思是说:将formatted_name的值同字符串'Janis Joplin'进行比较,如果它们相等,就万事大吉,如果它们不相等,更我说一声!“
    代码行unittest.main()让Python运行这个文件中的测试。运行test_name_function.py时,得到的输出如下:
    第1行的句点表明有一个测试通过了。接下来的一行指出了Python运行了一个测试,消耗的时间不到0.001秒。最后的OK表明该测试用例中的所有单元测试
    都通过了。
    上述输出表明,给定包含名和姓时,函数get_formatted_name()总是能正确地处理。修改get_formatted_name()后,可再次运行这个测试用例。如果它
    通过了,我们就知道在给定Janis Joplin这样的姓名时,这个函数依然能够正确处理。

    11.1.3 不能通过的测试
    测试未通过时结果是什么样的呢?我们来修改get_formatted_name(),使其能够处理中间名,但这样做时,故意让这个函数无法正确地处理像Janis Joplin
    这样只有名和姓的姓名。
    下面是get_formatted_name()的新版本
    其中包含的信息很多,因为测试未通过时,需要让我们知道的事情可能有很多。第1行输出只有字母E,它指出测试用例中有一个单元测试导致了错误。接下
    来,我们看到NamesTestCase中的test_first_last_name()导致了错误。测试用例包含众多单元测试时,知道那个测试未通过至关重要。在(3)处,我们看到了
    一个标准的traceback,它指出函数调用get_formatted_name('janis','joplin')有问题,因为它缺少一个必不可少的位置实参。
    我们看到了运行了一个单元测试。最后,还看到了一条消息,它指出整个测试用例都未通过,因为运行该测试时发生了一个错误。这条消息位于输出末尾,
    让我们一眼看到——我们可不希望为获悉有多少测试未通过而翻阅长长的输出。

    11.1.4 测试未通过时该怎么办
    测试未通过时怎么办呢?如果我们检查的条件没有错,测试通过了意味着函数的行为是对的,而测试未通过意味着我们编写的新代码有错。因此,测试未
    通过时,不要修改测试,而应修复导致测试不能通过的代码:检查刚对函数所做的修改,找出导致函数行为不符合预期的修改。
    在这个示例中,get_formatted_name()以前只需要两个实参——名和姓,但现在它需要提供名、中间名和姓。新增的中间名参数是必不可少的,这导致
    get_formatted_name()的行为不符合预期。就这里而言,最佳的选择是让中间名变为可选的。这样做后,使用类似于Janis Joplin的姓名进行测试时,测试就
    会通过了,同时这个函数还能接受中间名。下面来修改get_formatted_name(),将中间名设置为可选的,然后再次运行这个测试用例。如果通过了,我们接着
    确认这个函数能够妥善地处理中间名。

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

    11.2 测试类
    在本章前半部分,我们编写了针对单个函数的测试,下面来编写针对类的测试。很多程序中都会用到类,因此能够证明我们的类能够正确地工作会大有裨益
    。如果针对类的测试通过了,我们就能确信对类所做的改进没有意外地破坏其原有的行为。

    11.2.1 各种断言方法
    Python在unittest.TestCase类中提供了很多断言方法。前面说过,断言方法检查我们认为应该满足的条件是否确实满足。如果该条件确实满足,我们对
    程序行为的假设就得到了确认,我们就可以确信其中没有错误。如果我们认为应该满足的条件实际上并不满足,Python将引发异常。
    表11-1描述了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.3 小结
    在本章中,我们学习了:如何使用模块unittest中的工具来为函数和类编写测试;如何编写继承unittest.TestCase的类,以及如何编写测试方法,以
    核实函数和类的行为符合预期;如何使用setUp()来根据类高效地创建实例并设置其属性,以便在类的所有测试方法中都可使用它们。
    测试是很多初学者都不熟悉的主题。作为初学者,并非必须为你尝试的所有项目编写测试;但参与工作量较大的项目时,我们应对自己编写的函数和类的
    重要行为进行测试。这样我们就能够更加确定自己所做的工作不会破坏项目的其他部分,我们就能够随心所欲地改进既有代码了。如果不小心破坏了原来的功能
    ,我们马上就会知道,从而能够轻松地修复问题。相比于等到不满意的用户报告bug后再采取措施,在测试未通过时采取措施要容易得多。
    如果我们在项目中包含了初步测试,其他程序员将更敬佩你,它们将能够更得心应手地尝试使用我们编写的代码,也更愿意与你合作开发项目。如果我们要
    与其他程序员开发的项目共享代码,就必须证明我们编写的代码通过了既有测试,通常还需要为你编写的新行为编写测试。
    请通过多开展测试来熟悉代码测试过程。对于自己编写的函数和类,请编写针对其重要行为的测试,但在项目早期,不要试图去编写全覆盖的测试用例,除
    非有充分的理由这样做。


       

    Enter 'q' at any time to quit.

    Please give me a first name: geng
    Please give me a last name: changxue
        Neatly formatted name: Geng Changxue.

    Please give me a first name: jains
    Please give me a last name: joplin
        Neatly formatted name: Jains Joplin.

    Please give me a first name: q

  • 相关阅读:
    【Jest】笔记二:Matchers匹配器
    【爬虫】如何用python+selenium网页爬虫
    【mysql-server】遇到的坑
    【puppeteer】前端自动化初探(一)
    强制360谷歌使用谷歌内核
    实时获取input输入框中的值
    什么是单页面
    如何更改Apache的根目录指向
    iphone上点击div会出现半透明灰色背景以及margin失效
    event.currentTarget和event.target的区别
  • 原文地址:https://www.cnblogs.com/gengcx/p/6665417.html
Copyright © 2011-2022 走看看