如何用 unittest 写出高质量代码？

在 Python中 ，unittest 模块是进行单元测试的强大工具。无论你是初学者还是有经验的开发者，单元测试都是确保代码质量的重要一环。而 unittest 模块就是让这一过程变得简单、快捷的利器。

什么是单元测试？

在进入 unittest 模块之前，我们先来了解一下单元测试的概念。

单元测试（Unit Test）是指对软件中的最小可测试单元进行验证的测试。通常，这个最小单元是一个函数或方法。通过对这些单元进行测试，我们可以确保每个部分都能独立工作，这有助于在开发过程中发现并修复错误。

为什么要使用单元测试？

1. 早期发现错误：在代码开发的早期阶段进行单元测试，可以及早发现潜在的问题，减少调试的难度。

2. 确保代码正确性：通过测试来验证代码的行为，确保代码在各种输入下都能正确运行。

3. 重构的信心：在重构代码时，单元测试可以帮助确保改动没有引入新的错误。

unittest 模块概览

unittest 是 Python 内置的一个单元测试框架，类似于其他语言中的 JUnit（Java）或 NUnit（.NET）。它提供了一系列用于构建和运行测试的工具，帮助开发者自动化测试流程。

unittest 的基本概念

• 测试用例（Test Case）：最小的测试单元，通常是一个方法，用于测试代码中的某个特定行为。

• 测试套件（Test Suite）：一组测试用例的集合，可以用于组织多个测试用例。

• 测试运行器（Test Runner）：执行测试的引擎，它可以是命令行工具，也可以是 GUI 工具，用于运行测试并输出结果。

快速上手：编写你的第一个测试

下面我们来编写一个简单的例子，了解如何使用 unittest 模块进行单元测试。

假设我们有一个简单的函数 add(a, b)，用于返回两个数的和。

def add(a, b): return a + b

现在，我们为这个函数编写一个测试用例。

import unittest class TestMathOperations(unittest.TestCase): def test_add(self): self.assertEqual(add(1, 2), 3) self.assertEqual(add(-1, 1), 0) self.assertEqual(add(-1, -1), -2) if __name__ == '__main__': unittest.main()

代码解析

1. 定义测试类：所有的测试类都需要继承自 unittest.TestCase。

2. 编写测试方法：所有以 test_ 开头的方法都是测试用例。我们在 test_add 方法中编写了针对 add 函数的多个测试。

3. 断言方法：self.assertEqual(a, b) 用于断言 a 和 b 是否相等，这是最常用的断言方法之一。

运行这段代码，unittest 将自动发现所有的测试用例并执行它们。结果如下：

如果所有测试都通过，将会显示 “OK”。如果某个测试失败，unittest 会告诉你是哪个测试失败，并显示具体的错误信息。

更高级的测试技巧

1. 多种断言方法

除了 assertEqual，unittest 还提供了许多其他的断言方法，例如：

• assertTrue(expr) 和 assertFalse(expr)：断言表达式 expr 是否为 True 或 False。

• assertIn(a, b)：断言 a 是否包含在 b 中。

• assertRaises(exception, callable, *args, **kwds)：断言在调用函数时是否抛出了指定的异常。

2. 测试套件

当你有多个测试类或测试用例时，可以使用测试套件来组织它们：

def suite(): suite = unittest.TestSuite() suite.addTest(TestMathOperations('test_add')) # 你可以继续添加其他的测试用例或测试类 return suite if __name__ == '__main__': runner = unittest.TextTestRunner() runner.run(suite())

3. setUp 和 tearDown

有时，你可能需要在每个测试用例之前设置一些环境（例如初始化数据库连接），或者在测试用例之后清理环境。这时你可以使用 setUp 和 tearDown 方法。

class TestMathOperations(unittest.TestCase): def setUp(self): print("Setting up the environment...") def tearDown(self): print("Cleaning up the environment...") def test_add(self): self.assertEqual(add(1, 2), 3)

setUp 会在每个测试用例之前调用，而 tearDown 则会在测试用例之后调用。

4.跳过测试

有时候，你可能不希望运行某些测试，这时可以使用 @unittest.skip 装饰器。

class TestMathFunctions(unittest.TestCase): @unittest.skip("跳过这个测试") def test_division(self): self.assertEqual(divide(10, 2), 5)

5.预期失败

如果你知道某个测试目前会失败，但不希望它阻止其他测试的运行，可以使用 @unittest.expectedFailure。

@unittest.expectedFailure def test_fail(self): self.assertEqual(1 / 0, 1)

掌握 unittest 不仅可以帮助你写出更加健壮的代码，还能提升你调试和维护代码的效率。希望通过这篇文章，你能对 unittest 模块有一个全面的了解，并能够在你的项目中灵活应用。

感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你!有需要的小伙伴可以点击下方小卡片领取