Python单元测试与文档测试实战指南

许南星

发布时间：2026-10-13 | 5人浏览过

原创

本文详细解析Python中的单元测试与文档测试。通过MathFunc和Person类的具体代码示例，演示如何使用unittest模块对函数和类进行正确性检测，包括setUp/tearDown的使用及断言方法。同时介绍doctest模块如何从注释中提取代码执行，确保文档与代码行为一致，帮助开发者提升代码质量。

Python单元测试与文档测试概述

本文通过具体实例深入讲解Python中的单元（Unit）测试与文档（Doc）测试技术，供读者参考学习。

单元与文档测试概述

单元测试基础与函数测试

1、单元测试基础

单元测试旨在验证模块、函数或类的正确性。 1.若测试通过，表明被测函数功能正常； 2.若测试失败，则意味着函数存在Bug或输入参数不合法，此时需修复函数逻辑。

2、对函数执行单元测试

首先创建名为MathFunc.py的Python文件，代码如下：


def mySum(x,y):
  return x + y
def mySub(x,y)
  return x -y
print(mySum(1,2))

接着创建测试文件text01.py，内容如下：


import unittest
from MathFunc import mySum, mySub
#测试类 继承自unittest.TestCase
class Test(unittest.TestCase):
  #下面两个方法存在的意义：假设需要连接数据库，当测试完毕之后，需要断开和数据库的连接
  def setUp(self):
    print("开始测试时自动调用")
  def tearDown(self):
    print("结束时自动调用")
  #测试相应的函数
  #一般情况下，测试函数命名格式：text_需要被测试的函数名
  def test_mySum(self):
    #断言：对函数命名格式：text_需要被测试的函数名
    self.assertEqual(mySum(1,2),3,"加法有误")
  def test_mySub(self):
    self.asserEqual(mySub(2,1),1,"减法有误")
#当主程序运行的时候，开始进行单元测试
if __name__ == "__main__":
  unittest.main()

运行text01.py文件，确认测试正常通过。随后修改MathFunc.py文件，按以下方式调整代码：


def mySum(x,y):
  return x + y + 1
def mySub(x, y):
  return x - y
print(mySub(1,2))

再次运行text01.py文件，此时将显示错误信息。

类的单元测试实现

3、对类执行单元测试

首先创建类文件person.py，内容如下：


class Person(object):
  #构造方法
  def __init__(self, name, age):
    #给成员变量赋值
    self.name = name
    self.age = age
  def getAge(self):
    return self.age

创建text02.py文件以进行类的单元测试，代码如下：


import unittest
from person import person
class Test(unittest.TestCase):
  def test_init(self):
    p = Person('hanmeimei',20)
    self.asserEqual(p.name,"hanmeimei","属性值有误")
  def test_getAge(self):
    p = Person('hanmeimei',22)
    self.assertEqual(p.getAge(),p.age,"getAge函数有误")
if __name__ = "__main__":
  unittest.mian()

演示环节：运行text02.py文件，程序正常运行。随后修改person.py文件，具体修改如下：


class Person(object):
  #构造方法
  def __init__(self, name, age):
    #给成员变量赋值
    self.name = name
    self.age = age
  def getAge(self):
    return self.age+1

再次运行程序，将会报错。

对类的单元测试：本质上仍是对类中方法的单元测试。

文档测试（DocTest）应用

4、文档测试

文档测试的作用：提取注释中的代码并执行。 doctest模块负责提取注释中的代码并运行。 doctest严格遵循Python交互模式的输入格式进行提取。


import doctest
def mySum(x,y):
  #对函数进行功能和使用说明
  '''
  求两个数的和
  get The sum from x and y
  :param x:firstNum
  :param y:secondNum
  :return sum
  #注意有空格
  example:
  >>> print(mySum(1,2))
  3
  '''
  return x + y
print(mySum(1,2))
#进行文档测试，在当前文件中进行即可
doctest.testmod()

注意：演示时主要关注测试用例。

示例：