Python单元测试模块doctest的具体使用

开发高质量软件的过程中，我们经常会为每个函数编写测试，这样在开发过程中运行这些测试的时候就比较方便，doctest是一个python标准库自带的轻量单元测试工具，适合实现一些简单的单元测试。

doctest模块提供的这样的工具，用于扫描模块并验证程序文档字符串中嵌入的测试，在docstring中寻找到测试用例并执行，比较输出结果与期望值是否符合。

我们如何构造这些测试呢？很简单

在python的交互解释器中创建测试用例，并复制到docstring中

tip:doctest在docstring中寻找测试用例的时候，认为>>>是一个测试用例的开始，直到遇到空行或者下一个>>>，在两个测试用例之间有其他内容的话，会被doctest忽略（可以利用这个特性为测试用例编写一些注释）。

我先在我自己的项目下准备一个测试脚本quality_q.py：

def average(values):
  """Computes the arithmetic mean of a list of numbers.

  >>> print(average([20, 30, 70]))
  40.0
  """
  return sum(values) / len(values)

#
if __name__ == '__main__':
  import doctest
  doctest.testmod(verbose=True) # automatically validate the embedded tests
  # 那个verbose参数，如果设置为True则在执行测试的时候会输出详细信息。
  # 默认是False，表示运行测试时，只有失败的用例会输出详细信息，成功的测试用例不会输入任何信息。

启动测试的方法：

第一个是在__main__函数中调用了doctest.testmod()方法。
然后在交互解释器中执行运行脚本 python3 doctest_q.py

如果__main__函数有其他用途，不方便调用doctest.testmod()方法，那么可以用另外一种执行测试的方法：

在交互解释器中执行如下命令执行测试： python3 -m doctest doctest_q.py -v
这里 -m 表示引用一个模块，-v 等价于 verbose=True

因为我是在Pycharm中创建的文件，我就直接打开Pycharm的Terminal，然后在交互解释器中切换一下脚本目录，执行的上面说到的启动方式，（顺便复习一下os模块的常用操作）
ps:读者在测试自己的例子时只需注意一下自己的当前工作目录即可

看一下最后的结果：

➜ ForF python3
Python 3.7.3 (default, Mar 27 2019, 09:23:15)
[Clang 10.0.1 (clang-1001.0.46.3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.

>>> import os

>>> os.getcwd()
'/Users/dengjiguang/PycharmProjects/ForF'
>>> os.chdir('/Users/dengjiguang/PycharmProjects/ForF'+'/python_sample/quality_control')

>>> os.system('python3 -m doctest doctest_q.py -v')
Trying:
  print(average([20, 30, 70]))
Expecting:
  40.0
ok
1 items had no tests:
  doctest_q
1 items passed all tests:
  1 tests in doctest_q.average
1 tests in 2 items.
1 passed and 0 failed.
Test passed.
0
>>>

os.getcwd()：返回当前的工作目录
os.chdir(‘path')：切换工作目录
os.system(‘command'): 执行系统shell命令

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。

赞 (0)

相关推荐

  • Python单元测试工具doctest和unittest使用解析

    Python单元测试工具doctest和unittest使用解析

    Python标准库包含两个测试工具. doctest:一个简单的模块,为检查文档而设计,但也适合用来编写单元测试. unittest:一个通用的测试框架. 一.使用doctest进行单元测试 创建文件mymath.py,内容 def square(x): ''' 计算平方并返回结果(下面是单元测试的格式) >>> square(2) >>> square(3) ''' return x * x if __name__ == '__main__': import doct

  • Python单元测试模块doctest的具体使用

    开发高质量软件的过程中,我们经常会为每个函数编写测试,这样在开发过程中运行这些测试的时候就比较方便,doctest是一个python标准库自带的轻量单元测试工具,适合实现一些简单的单元测试. doctest模块提供的这样的工具,用于扫描模块并验证程序文档字符串中嵌入的测试,在docstring中寻找到测试用例并执行,比较输出结果与期望值是否符合. 我们如何构造这些测试呢?很简单 在python的交互解释器中创建测试用例,并复制到docstring中 tip:doctest在docstring中寻

  • Python测试模块doctest使用解析

    面试被问到了却没有用过,很尴尬:今天看了一下,真的是一个很简单的测试模块 方便起见,这里直接拿菜鸟教程的介绍和例子过来 开发高质量软件的方法之一是为每一个函数开发测试代码,并且在开发过程中经常进行测试: doctest模块提供了一个工具,扫描模块并根据程序中内嵌的文档字符串执行测试: 测试构造如同简单的将它的输出结果剪切并粘贴到文档字符串中: 通过用户提供的例子,它强化了文档,允许 doctest 模块确认代码的结果是否与文档一致: def average(values): ""&qu

  • python单元测试unittest实例详解

    本文实例讲述了python单元测试unittest用法.分享给大家供大家参考.具体分析如下: 单元测试作为任何语言的开发者都应该是必要的,因为时隔数月后再回来调试自己的复杂程序时,其实也是很崩溃的事情.虽然会很快熟悉内容,但是修改和调试将是一件痛苦的事情,如果你在修改了代码后出现问题的话,而单元测试可以帮助我们很快准确的定位到问题的位置,出现问题的模块和单元.所以这是一件很愉快的事情,因为我们知道其它修改或没有修改的地方仍然是正常工作的,而我们目前的唯一问题就是搞定眼前这个有点问题的"家伙&qu

  • Python单元测试与测试用例简析

    本文实例讲述了Python单元测试与测试用例.分享给大家供大家参考,具体如下: 单元测试与测试用例 简介 测试用例是一组单元测试,这些单元测试一起核实函数在各种情形下的行为都符合要求 要为函数编写测试用例,可先导入模块 unittest 以及要测试的函数,再创建一个继承unittest.TestCase 的类,并编写一系列方法对函数行为的不同方面进行测试 创建实例(对比接收到的名和姓是否符合要求) 1.先创建个name_function.py的文件(文件名称可以另取),接收名和姓并返回整洁的全名

  • Python单元测试简单示例

    本文实例讲述了Python单元测试方法.分享给大家供大家参考,具体如下: Eric书中<Python编程从入门到实践>中的一个例子. <Python编程从入门到实践>随书源码可至此下载:https://www.jb51.net/books/582019.html. 首先定义了一个测试函数: namefunction.py #-*- coding:cp936 -*- def get_formmed_name(first, last): """该函数根据姓

  • Python 单元测试（unittest）的使用小结

    测试目录 项目的整体结构可以参考"软件目录开发规范",这里单说测试目录.一般都是在项目里单独创建一个测试目录,目录名就是"tests". 关于目录的位置,一种建议是,在项目名(假设项目名是Foo)的一级子目录下创建二级子目录 "Foo/foo/tests" .但是这样可能是因为用起来不方便,有很多是按下面的做法.不过下面的示例我还是用这个方法来创建测试目录. 还可以把测试目录向上移一层,作为一级子目录,直接创建在项目之下 "Foo/te

  • Python单元测试实例详解

    Python单元测试实例详解

    本文实例讲述了Python单元测试.分享给大家供大家参考,具体如下: 在Python中进行单元测试需要用到自动单元测试框架PyUnit,Python2.1及其以后的版本都将PyUnit作为一个标准模块(即python的unittest模块),如果你很out,那么你需要从PyUnit网站下载源码安装后才能使用. 一.Python单元测试范例 测试最基本的原理是比较预期结果是否与实际执行结果相同,如果相同则测试成功,否则测试失败.为了更好地理解自动测试框架PyUnit,下面会以对Widget类进行测

  • python单元测试框架pytest的使用示例

    首先祝大家国庆节日快乐,这个假期因为我老婆要考注会,我也跟着天天去图书馆学了几天,学习的感觉还是非常不错的,这是一篇总结. 这篇博客准备讲解一下pytest测试框架,这个框架是当前最流行的python语言最流行的单测框架,不掌握可不行,首先这个框架属于第三方模块,需要通过pip安装即可 pip install pytest 下面我们进入正题 一.介绍pytest的运行规则 1.测试文件的名称必须要以test_*.py的格式,或者*_test.py的格式 2.测试类的名称必须要以Test开头,且这

  • Python单元测试的9个技巧技巧

    目录 1.requests项目单元测试状况 2.简单工具类如何测试 2.1 test_help 实现分析 2.2 test_hooks 实现分析 2.3 test_structures 实现分析 2.4 utils.py 2.5 utils测试用例 2.6 request-api如何测试 3.底层API测试 前言: requests是python知名的http爬虫库,同样简单易用,是python开源项目的TOP10. pytest是python的单元测试框架,简单易用,在很多知名项目中应用.re

随机推荐