Python单元测试框架选择：unittest对比pytest

0. 概述

在Python中，单元测试是一种确保代码符合预期的重要方法，而unittest和pytest是两个流行的测试框架。在本文中，将探讨这两个框架的特点和用法，以帮助选择适合项目的测试工具。

1. unittest：Python的标准测试框架

unittest是Python的标准库的一部分，受Java的JUnit框架启发。它支持测试自动化、共享测试代码的设置与拆解、聚集多个测试用例以及独立性测试等。

1.1 特点

• 组织结构：测试用例是通过类的形式组织的，每个测试函数以test开头。
• 断言方法：提供了多种断言方法如assertEqual(), assertTrue()等。
• 固定装置（Fixtures）：使用setUp()和tearDown()方法为测试方法进行预先设置和后续清理。使用self.id()返回的字符串包括测试所在文件名（模块）、测试类名和测试方法名可以唯一地标识出正在执行的测试案例。
• 测试发现：支持通过命令行自动发现和运行测试。

1.2 示例代码

# 导入unittest模块，这是Python的标准测试库。
import unittest


# 定义一个名为TestMathOperations的测试类，该类继承自unittest.TestCase，提供了测试的基础框架。
class TestMathOperations(unittest.TestCase):
    # setUp方法在每个测试方法执行前被调用，用于设置测试环境。
    def setUp(self):
        # 初始化一个实例变量，将在测试中使用。
        self.number = 10
        print("setUp executed.")

    # tearDown方法在每个测试方法执行后被调用，用于清理测试环境。
    def tearDown(self):
        # 清理或重置实例变量。
        self.number = 0
        print("tearDown executed.")

    # 定义一个测试方法，方法名以test_开头，这是unittest识别测试的方式。
    def test_addition(self):
        # 打印当前测试方法的名称:unit.test_my.TestMathOperations.test_addition
        print(f"self.id(): {self.id()}")
        # 执行加法操作。
        result = self.number + 5
        # 使用assertEqual来验证结果是否符合预期。
        self.assertEqual(result, 15)

2. pytest：灵活且强大的第三方库

pytest是一个第三方库，以其简单性、灵活性和强大的功能著称，适用于简单的单元测试和复杂的功能测试。

2.1 特点

• 简洁的语法：不需要编写类定义，测试用例简短易写。可以使用 Python 的内置 assert 语句进行断言。简单直接，无需学习额外的断言方法。
• 强大的装置系统：通过装饰器@pytest.fixture，可以更灵活地创建依赖对象。
  • 可以有不同的作用域级别：

    function（默认）：每个测试函数调用时都会调用装置。

    class：每个测试类调用一次，适用于所有类中的方法。

    module：每个模块调用一次，对所有模块中的测试有效。

    session：整个测试会话中只调用一次。

  • 通过 yield 语句分割设置和清理代码。当测试函数执行完毕后，yield 后面的代码将被执行。

• 插件支持：支持超过315个插件，极大地扩展了其功能，比如下面一些插件：
  • pytest-cov：用于测试覆盖率报告。
  • pytest-xdist：支持多CPU并行运行测试。
  • pytest-mock：简化了 mock 对象的使用。
  • pytest-django：专为 Django 应用设计的测试插件。
• 参数化测试：内置支持参数化，允许使用不同的参数多次运行同一测试

  @pytest.fixture(params=[(1, 2, 3), (4, 5, 9)])
  def tuple_data(request):
      return request.param

2.2 示例代码

import pytest


# input_value 装置为每个测试返回42，测试函数通过参数引用它
@pytest.fixture(scope="module")
def input_value():
    # setup
    print("Setting up")
    # yield
    yield 42
    # teardown
    print("Tearing down")


# tuple_data 装置为每个测试返回一个元组，测试函数通过参数引用它
@pytest.fixture(params=[(1, 2, 3), (4, 5, 9)])
def tuple_data(request):
    return request.param


# 测试函数接收参数 input_value
def test_divisible_by_6(input_value):
    assert input_value % 6 == 0


# 测试函数接收参数 input_value
def test_tuples(tuple_data):
    a, b, sum_ab = tuple_data
    assert a + b == sum_ab

3. unittest与pytest的对比

• 易用性：pytest的学习曲线较低，写法更自然。unittest的结构性较强，对面向对象编程更友好。
• 灵活性：pytest提供了更多的灵活性和强大的功能，特别是在装置和插件支持方面。
• 标准支持：作为标准库的一部分，unittest不需要额外安装即可使用，适合不需要额外依赖的环境。

4. 结论

如果需要一个简单、易用且功能强大的工具，且不介意安装第三方库，pytest可能是更好的选择。如果偏好使用Python标准库并需要一个结构化的框架，unittest或许更合适。