unittest 是 Python 标准库中的一个测试框架，它深受 Java 的 JUnit 影响，它为编写和运行测试提供了结构化的方式，包括测试发现、测试执行、断言和测试结果报告等功能，对于初学者来说，它是一个非常好的起点，因为它内置在 Python 环境中，无需额外安装。

核心概念

理解 unittest 的几个关键类和概念是掌握它的第一步。

1. unittest.TestCase

   • 这是所有测试用例的基类,你编写的每一个测试类都必须继承自 unittest.TestCase。
   • 它提供了一系列断言方法（如 assertEqual, assertTrue, assertRaises 等）来验证代码的行为是否符合预期。
   • 它定义了测试的生命周期方法,如 setUp() 和 tearDown()。

2. setUp() 和 tearDown()

   • setUp(): 在每个测试方法之前运行，用于执行通用的设置操作，比如创建对象、初始化数据库连接、打开文件等。
   • tearDown(): 在每个测试方法之后运行，用于执行通用的清理操作，比如关闭文件、删除临时文件、释放数据库连接等。
   • 重要提示：setUp() 和 tearDown() 是在每个测试方法上独立运行的，这能确保测试用例之间不会相互影响，保证了测试的隔离性。

3. setUpClass() 和 tearDownClass()

   • setUpClass(): 在一个测试类的所有测试方法之前运行一次，必须是类方法（使用 @classmethod 装饰器）。
   • tearDownClass(): 在一个测试类的所有测试方法之后运行一次，也必须是类方法。
   • 适用于那些开销较大,但所有测试可以共享的资源，比如启动一个测试服务器。

4. 测试方法

   • 任何以 test_ 开头的方法都会被 unittest 测试运行器识别为一个测试用例。
   • 在这些方法中,你使用 self 来调用 TestCase 提供的断言方法，以验证你的代码。

5. unittest.TestSuite

   用于将多个测试用例或测试套件组合在一起,形成一个更大的测试集合，你可以手动创建测试套件，但通常让测试运行器自动发现测试更方便。

6. unittest.TextTestRunner

   这是测试运行器,它负责执行测试套件中的测试，并将结果以文本形式输出到控制台。

一个简单的完整示例

假设我们有一个简单的 calculator.py 文件，我们要测试它的功能。

calculator.py

class Calculator:
    def add(self, a, b):
        return a + b
    def subtract(self, a, b):
        return a - b
    def multiply(self, a, b):
        return a * b
    def divide(self, a, b):
        if b == 0:
            raise ValueError("Cannot divide by zero")
        return a / b

我们为它编写测试用例。

test_calculator.py

import unittest
from calculator import Calculator # 导入我们要测试的类
class TestCalculator(unittest.TestCase):
    """测试 Calculator 类的各种方法"""
    def setUp(self):
        """在每个测试方法前运行，初始化一个计算器实例"""
        print("\n正在设置测试环境...")
        self.calc = Calculator()
    def tearDown(self):
        """在每个测试方法后运行，进行清理"""
        print("测试环境已清理。")
    # --- 测试 add 方法 ---
    def test_add_positive_numbers(self):
        """测试两个正数相加"""
        result = self.calc.add(5, 3)
        self.assertEqual(result, 8)
    def test_add_negative_numbers(self):
        """测试两个负数相加"""
        result = self.calc.add(-2, -3)
        self.assertEqual(result, -5)
    # --- 测试 subtract 方法 ---
    def test_subtract(self):
        """测试减法"""
        result = self.calc.subtract(10, 4)
        self.assertEqual(result, 6)
    # --- 测试 multiply 方法 ---
    def test_multiply(self):
        """测试乘法"""
        result = self.calc.multiply(7, 6)
        self.assertEqual(result, 42)
    # --- 测试 divide 方法 ---
    def test_divide(self):
        """测试正常除法"""
        result = self.calc.divide(10, 2)
        self.assertEqual(result, 5.0)
    def test_divide_by_zero(self):
        """测试除以零的情况"""
        # 使用 assertRaises 来验证是否抛出了预期的异常
        with self.assertRaises(ValueError):
            self.calc.divide(10, 0)
# --- 运行测试 ---
if __name__ == '__main__':
    # 创建一个测试套件
    suite = unittest.TestLoader().loadTestsFromTestCase(TestCalculator)
    # 创建一个测试运行器
    runner = unittest.TextTestRunner(verbosity=2) # verbosity=2 提供更详细的输出
    # 运行测试套件
    runner.run(suite)

如何运行测试？

1. 直接运行测试文件： 在终端中，进入 test_calculator.py 所在的目录，然后运行：

   python test_calculator.py

   你会看到类似下面的输出：

   test_add_negative_numbers (test_calculator.TestCalculator) ... ok
   test_add_positive_numbers (test_calculator.TestCalculator) ... ok
   test_divide (test_calculator.TestCalculator) ... ok
   test_divide_by_zero (test_calculator.TestCalculator) ... ok
   test_multiply (test_calculator.TestCalculator) ... ok
   test_subtract (test_calculator.TestCalculator) ... ok
   ----------------------------------------------------------------------
   Ran 6 tests in 0.001s
   OK

2. 使用 unittest 模块命令行发现并运行： 这是更推荐的方式，尤其是在项目变大后，它会自动发现所有符合命名规则的测试文件。

   # -s 指定测试所在的目录（通常是项目根目录或 tests 目录）
   # -p 指定测试文件的匹配模式（'test_*.py'）
   python -m unittest discover -s . -p "test_*.py"

常用断言方法

unittest.TestCase 提供了丰富的断言方法，用于验证结果。

unittest vs. pytest

虽然 unittest 很强大，但在现代 Python 开发中，pytest 更受欢迎，了解它们的区别有助于你选择合适的工具。

• unittest: 优点是无需安装，语法严格，适合大型、需要严格结构的项目，缺点是语法相对繁琐。
• pytest: 优点是语法简洁（特别是断言），功能强大（fixture、参数化），插件丰富，社区活跃，是目前 Python 社区的事实标准。

对于新手,可以从 unittest 开始，因为它就在手边，一旦熟悉了测试的基本概念，强烈建议转向 pytest，它能极大地提升你的测试效率。

进阶技巧

1. 测试夹具 unittest 也提供了 setUpModule 和 tearDownModule，它们在整个模块的所有测试之前和之后各运行一次，但这远不如 pytest 的 fixture 灵活。

2. 跳过测试 你可以跳过某个测试，或者仅在满足特定条件时才运行它。

   import unittest
   import sys
   class MyTests(unittest.TestCase):
       @unittest.skip("直接跳过这个测试")
       def test_skipped(self):
           self.fail("这个测试不应该被执行")
       @unittest.skipIf(sys.version_info < (3, 6), "需要 Python 3.6 或更高版本")
       def test_skip_if_condition(self):
           self.assertEqual("hello".upper(), "HELLO")
       @unittest.skipUnless(sys.platform == "win32", "仅在 Windows 上运行")
       def test_skip_unless_condition(self):
           self.assertTrue(True)

3. 测试套件 除了自动发现，你也可以手动构建测试套件来组合不同测试文件中的测试。

   # 在一个主测试文件中
   from test_module1 import TestModule1
   from test_module2 import TestModule2
   def suite():
       suite = unittest.TestSuite()
       suite.addTest(unittest.makeSuite(TestModule1))
       suite.addTest(unittest.makeSuite(TestModule2))
       return suite
   if __name__ == '__main__':
       runner = unittest.TextTestRunner()
       runner.run(suite())

希望这份详细的指南能帮助你全面理解 Python 的 unittest 框架！