pytest-mpl 使用教程

1. 项目介绍

pytest-mpl 是一个开源的 pytest 插件，专门用于比较 Matplotlib 图像。它允许用户在测试中自动生成图像，并与预先存储的参考图像进行对比，以确保图像渲染的一致性。这个工具特别适用于确保代码更改后，图形输出仍然符合预期。

2. 项目快速启动

首先，确保你已经安装了 pytest 和 matplotlib。接下来，你可以使用 pip 来安装 pytest-mpl 插件：

pip install pytest-mpl

然后，在你的测试文件中，你可以创建一个使用 @pytest.mark.mpl_image_compare 装饰器的测试函数，该函数会创建并返回一个 Matplotlib 图像：

import matplotlib.pyplot as plt
import pytest

@pytest.mark.mpl_image_compare
def test_plot():
    fig, ax = plt.subplots()
    ax.plot([1, 2])
    return fig

为了生成参考图像，你需要运行测试并使用 --mpl-generate-path 参数指定一个目录来存储生成的图像：

pytest --mpl-generate-path=baseline

之后，你可以运行测试，并通过 --mpl 参数来比较返回的图像和参考图像：

pytest --mpl

如果你想要生成一个图像比较结果的 HTML 汇总，你可以使用 --mpl-generate-summary=html 参数。

3. 应用案例和最佳实践

• 确保图形一致性：在持续集成（CI）流程中使用 pytest-mpl 可以确保代码更改后图形的一致性。
• 自动化测试：将 pytest-mpl 集成到自动化测试套件中，可以减少手动检查图形输出所需的时间。
• 版本控制：将参考图像存储在版本控制系统中，可以追踪图形的变化历史。

4. 典型生态项目

• Matplotlib：pytest-mpl 与 Matplotlib 库紧密集成，是确保 Matplotlib 图形渲染正确性的重要工具。
• pytest：作为 pytest 测试框架的一部分，pytest-mpl 利用 pytest 的强大功能进行图像比较测试。
• 持续集成工具：如 Jenkins、Travis CI 或 GitHub Actions 等工具可以与 pytest-mpl 结合使用，实现自动化测试和图形验证。