跳转到主要内容

pytest插件,用于帮助测试Matplotlib输出的图像

项目描述

pytest-mpl 是一个 pytest 插件,用于简化 Matplotlib 图像的比较。

对于每个要测试的图像,都会生成一个图像并将其从现有的参考图像中减去。如果残差的均方根大于用户指定的容差,则测试将失败。或者,生成的图像可以哈希并与其预期值进行比较。

有关更多信息,请参阅 pytest-mpl 文档

安装

pip install pytest-mpl

有关详细说明,请参阅 pytest-mpl 文档中的 安装指南

使用方法

首先,编写创建图像的测试函数。这些图像比较测试使用 @pytest.mark.mpl_image_compare 装饰器,并返回用于测试的图像

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

同时传递--mpl-generate-summary=html,将以HTML格式生成图像比较结果的摘要

html all

html filter

html result

有关如何配置和使用pytest-mpl的更多信息,请参阅pytest-mpl文档

贡献

pytest-mpl是一个由用户维护并由用户维护的社区项目。您有很多方式可以帮忙!

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

pytest-mpl-0.17.0.tar.gz (885.6 kB 查看哈希值)

上传时间

构建分发

pytest_mpl-0.17.0-py3-none-any.whl (27.6 kB 查看哈希值)

上传时间 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面