Python高级技术之：`Python`的`coverage`库：如何进行代码覆盖率测试。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，晚上好！我是你们的老朋友，代码界的搬运工。今天咱们来聊聊一个Python开发中非常实用，但又常常被忽视的工具：coverage库。它能帮你做代码覆盖率测试，简单来说，就是看看你的测试用例到底有没有覆盖到你写的每一行代码。

一、啥是代码覆盖率？

代码覆盖率，顾名思义，就是你的测试用例覆盖了多少百分比的代码。想象一下，你写了一个程序，就像盖了一栋房子。测试用例就像是来检查这栋房子的检查员。如果检查员只检查了客厅和卧室，没检查厨房和卫生间，那房子就可能存在隐患。代码覆盖率就是衡量检查员检查范围的指标。

常见的代码覆盖率指标有几种：

语句覆盖率 (Statement Coverage)： 你的测试用例执行了多少行代码？这是最基本的覆盖率指标，也是最容易达到的。
分支覆盖率 (Branch Coverage)： 你的测试用例覆盖了多少个 if、else、for、while 等分支？这个比语句覆盖率更严格，能发现一些隐藏的 bug。
函数覆盖率 (Function Coverage)： 你的测试用例调用了多少个函数？
行覆盖率 (Line Coverage): 和语句覆盖率类似，统计哪些行代码被执行了。
条件覆盖率 (Condition Coverage): 你的测试用例覆盖了多少个条件判断中的真假情况？例如，if a > 0 and b < 5，你需要测试 a > 0 为真假两种情况，b < 5 也要测试真假两种情况。
路径覆盖率 (Path Coverage)： 你的测试用例覆盖了多少条可能的执行路径？这是最严格的覆盖率指标，但也是最难达到的。

一般来说，我们比较关注语句覆盖率和分支覆盖率。当然，越高越好，但也不是越高越有意义。100% 的代码覆盖率并不代表你的代码就没有 bug，只能说明你的测试用例比较全面。

二、coverage 库怎么用？

coverage 库的使用非常简单，只需要几个步骤：

安装：
```
pip install coverage
```
运行测试：
```
coverage run -m unittest discover
```
或者，如果你使用 pytest：
```
coverage run -m pytest
```
coverage run 命令会运行你的测试用例，并记录哪些代码被执行了。-m unittest discover 是 unittest 的一种运行方式，会自动发现并运行你的测试用例。-m pytest 是 pytest 的运行方式。
生成报告：
```
coverage report -m
```
这个命令会生成一个文本报告，告诉你代码覆盖率是多少，以及哪些代码没有被覆盖。-m 参数会显示未覆盖的代码行。
```
coverage html
```
这个命令会生成一个 HTML 报告，更直观地展示代码覆盖率。你可以用浏览器打开 htmlcov/index.html 文件查看。

三、实战演练：一个简单的例子

咱们来写一个简单的函数，并用 coverage 库来测试它的代码覆盖率。

# my_module.py
def add(a, b):
    """
    加法函数，如果a是负数，则结果乘以2
    """
    result = a + b
    if a < 0:
        result = result * 2
    return result

def divide(a, b):
  """
  除法函数, 如果b为0，返回None
  """
  if b == 0:
    return None
  else:
    return a / b

然后，我们写一个简单的测试用例：

# test_my_module.py
import unittest
import my_module

class TestMyModule(unittest.TestCase):
    def test_add_positive(self):
        self.assertEqual(my_module.add(1, 2), 3)

    def test_add_negative(self):
        self.assertEqual(my_module.add(-1, 2), 2)

    def test_divide_valid(self):
        self.assertEqual(my_module.divide(10, 2), 5)

    def test_divide_zero(self):
        self.assertIsNone(my_module.divide(5, 0))

if __name__ == '__main__':
    unittest.main()

接下来，我们用 coverage 库来运行测试，并生成报告：

coverage run -m unittest test_my_module.py
coverage report -m
coverage html

运行 coverage report -m 后，你可能会看到类似这样的输出：

Name          Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------
my_module.py      9      0      2      0   100%
test_my_module.py  14      0      0      0   100%
---------------------------------------------------------
TOTAL            23      0      2      0   100%

这说明我们的代码覆盖率是 100%。

四、coverage 的高级用法

coverage 库还有一些高级用法，可以更好地满足我们的需求：

.coveragerc 配置文件：

你可以在项目根目录下创建一个 .coveragerc 文件，来配置 coverage 库的行为。例如，你可以排除一些不需要测试的文件或目录：
```
[run]
omit =
    */tests/*
    */migrations/*

[report]
exclude_lines =
    pragma: no cover
    if __name__ == '__main__':
```
omit 配置项可以排除 tests 和 migrations 目录下的所有文件。exclude_lines 配置项可以排除包含 pragma: no cover 和 if __name__ == '__main__': 的代码行。
pragma: no cover 注释：

你可以在代码中使用 pragma: no cover 注释来告诉 coverage 库不要覆盖某行代码。例如：
```
def my_function():
    if DEBUG:  # pragma: no cover
        print("Debug mode is enabled")
    # ...
```
这通常用于调试代码或不可能执行到的代码。

结合 CI/CD 工具：

你可以将 coverage 库集成到 CI/CD 工具中，例如 Jenkins、GitLab CI、GitHub Actions 等。这样，每次代码提交后，CI/CD 工具会自动运行测试并生成代码覆盖率报告。如果代码覆盖率低于某个阈值，CI/CD 工具可以阻止代码合并。

例如，在 GitHub Actions 中，你可以使用类似这样的配置：

name: Code Coverage

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - name: Set up Python 3.x
        uses: actions/setup-python@v4
        with:
          python-version: '3.x'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install coverage pytest
      - name: Run tests with coverage
        run: |
          coverage run -m pytest
      - name: Generate coverage report
        run: |
          coverage xml
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: true

这个配置会在每次代码提交后，运行测试，生成 XML 格式的代码覆盖率报告，并将报告上传到 Codecov。Codecov 是一个代码覆盖率分析平台，可以帮助你更好地管理代码覆盖率。

五、代码覆盖率的误区

虽然代码覆盖率很重要，但也不能过度追求。以下是一些常见的误区：

盲目追求 100% 的代码覆盖率： 100% 的代码覆盖率并不代表你的代码就没有 bug。有些 bug 只有在特定情况下才会出现，而你的测试用例可能没有覆盖到这些情况。
只关注代码覆盖率，不关注测试用例的质量： 即使你的代码覆盖率很高，如果你的测试用例写得很烂，也可能无法发现 bug。
把代码覆盖率作为 KPI： 如果把代码覆盖率作为 KPI，开发人员可能会为了提高代码覆盖率而写一些无意义的测试用例。

正确的做法是：

把代码覆盖率作为一种辅助工具： 代码覆盖率可以帮助你发现测试用例的不足，但不能完全依赖它。
注重测试用例的质量： 测试用例应该尽可能覆盖各种边界情况和异常情况。
结合其他测试方法： 除了单元测试，还可以使用集成测试、系统测试、压力测试等方法来保证代码质量。

六、一些最佳实践

从一开始就编写测试用例： 这样可以避免以后补测试用例的麻烦。
使用 TDD (Test-Driven Development)： 先写测试用例，再写代码。
保持测试用例的简洁性： 测试用例应该只测试一个功能点。
定期审查测试用例： 确保测试用例仍然有效。
使用 Mock 对象： 在单元测试中，可以使用 Mock 对象来模拟外部依赖。

七、总结

coverage 库是一个非常实用的工具，可以帮助你提高代码质量。但是，不要过度追求代码覆盖率，要注重测试用例的质量，并结合其他测试方法。希望今天的讲座能对你有所帮助！

八、彩蛋：一个更复杂的例子 (可选)

为了更深入地理解 coverage 库的用法，我们可以考虑一个更复杂的例子。假设我们有一个计算器类：

# 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

    def power(self, a, b):
        return a ** b

    def square_root(self, a):
        if a < 0:
            raise ValueError("Cannot calculate square root of a negative number")
        return a ** 0.5

我们可以编写如下的测试用例：

# test_calculator.py
import unittest
from calculator import Calculator

class TestCalculator(unittest.TestCase):
    def setUp(self):
        self.calculator = Calculator()

    def test_add(self):
        self.assertEqual(self.calculator.add(2, 3), 5)
        self.assertEqual(self.calculator.add(-2, 3), 1)
        self.assertEqual(self.calculator.add(2, -3), -1)

    def test_subtract(self):
        self.assertEqual(self.calculator.subtract(5, 2), 3)
        self.assertEqual(self.calculator.subtract(-5, 2), -7)
        self.assertEqual(self.calculator.subtract(5, -2), 7)

    def test_multiply(self):
        self.assertEqual(self.calculator.multiply(2, 3), 6)
        self.assertEqual(self.calculator.multiply(-2, 3), -6)
        self.assertEqual(self.calculator.multiply(2, -3), -6)

    def test_divide(self):
        self.assertEqual(self.calculator.divide(6, 2), 3)
        self.assertEqual(self.calculator.divide(-6, 2), -3)
        self.assertEqual(self.calculator.divide(6, -2), -3)
        with self.assertRaises(ValueError):
            self.calculator.divide(6, 0)

    def test_power(self):
        self.assertEqual(self.calculator.power(2, 3), 8)
        self.assertEqual(self.calculator.power(-2, 3), -8)
        self.assertEqual(self.calculator.power(2, -1), 0.5)

    def test_square_root(self):
        self.assertEqual(self.calculator.square_root(9), 3)
        with self.assertRaises(ValueError):
            self.calculator.square_root(-9)

if __name__ == '__main__':
    unittest.main()

这个例子更全面地测试了计算器类的各个功能，包括正常情况、边界情况和异常情况。通过运行 coverage 库，我们可以确保我们的测试用例覆盖了所有可能的代码路径。

表格总结

特性	描述
安装	`pip install coverage`
运行测试	`coverage run -m unittest discover` 或 `coverage run -m pytest`
生成报告	`coverage report -m` (文本报告), `coverage html` (HTML报告)
配置文件	`.coveragerc`，用于排除文件/目录或代码行
代码注释	`# pragma: no cover`，排除特定代码行
CI/CD 集成	可以集成到 Jenkins、GitLab CI、GitHub Actions 等
常见误区	盲目追求 100% 覆盖率，只关注覆盖率不关注测试用例质量，将覆盖率作为 KPI
最佳实践	从一开始编写测试用例，使用 TDD，保持测试用例简洁，定期审查测试用例，使用 Mock 对象

希望这个更复杂的例子和表格总结能让你更深入地理解 coverage 库的用法。祝你编程愉快！

发表回复 取消回复

发表回复取消回复