Skip to content

TST: use pytest name in naming files for check_figures_equal #16693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
QuLogic merged 4 commits into from
Mar 16, 2020
Merged

TST: use pytest name in naming files for check_figures_equal #16693

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbb78a0
TST: add the request fixture to check_figures_equal
tacaswell Mar 6, 2020
3b57fba
MNT: correctly label the inject kwargs as kwonly
tacaswell Mar 6, 2020
a66d8d8
MNT: filter filename to not fail non-allowed names
tacaswell Mar 15, 2020
3788e3c
MNT: remove unused import
tacaswell Mar 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions lib/matplotlib/testing/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import sys
import unittest
import warnings
import string

import matplotlib as mpl
import matplotlib.style
Expand All @@ -17,7 +18,7 @@
from matplotlib import ft2font
from matplotlib import pyplot as plt
from matplotlib import ticker
from . import is_called_from_pytest

from .compare import comparable_formats, compare_images, make_test_filename
from .exceptions import ImageComparisonFailure

Expand Down Expand Up @@ -381,22 +382,23 @@ def test_plot(fig_test, fig_ref):
fig_test.subplots().plot([1, 3, 5])
fig_ref.subplots().plot([0, 1, 2], [1, 3, 5])
"""
POSITIONAL_OR_KEYWORD = inspect.Parameter.POSITIONAL_OR_KEYWORD
ALLOWED_CHARS = set(string.digits + string.ascii_letters + '_-[]()')
KEYWORD_ONLY = inspect.Parameter.KEYWORD_ONLY
def decorator(func):
import pytest

_, result_dir = _image_directories(func)

@pytest.mark.parametrize("ext", extensions)
def wrapper(*args, ext, **kwargs):
def wrapper(*args, ext, request, **kwargs):
file_name = "".join(c for c in request.node.name
if c in ALLOWED_CHARS)
try:
fig_test = plt.figure("test")
fig_ref = plt.figure("reference")
func(*args, fig_test=fig_test, fig_ref=fig_ref, **kwargs)
test_image_path = result_dir / (func.__name__ + "." + ext)
ref_image_path = result_dir / (
func.__name__ + "-expected." + ext
)
test_image_path = result_dir / (file_name + "." + ext)
ref_image_path = result_dir / (file_name + "-expected." + ext)
fig_test.savefig(test_image_path)
fig_ref.savefig(ref_image_path)
_raise_on_image_difference(
Expand All @@ -411,7 +413,10 @@ def wrapper(*args, ext, **kwargs):
parameters=([param
for param in sig.parameters.values()
if param.name not in {"fig_test", "fig_ref"}]
+ [inspect.Parameter("ext", POSITIONAL_OR_KEYWORD)])
+ [
inspect.Parameter("ext", KEYWORD_ONLY),
inspect.Parameter("request", KEYWORD_ONLY),
])
)
wrapper.__signature__ = new_sig

Expand Down