diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
index c329baf230e6..f1c988370c6e 100644
--- a/lib/matplotlib/testing/decorators.py
+++ b/lib/matplotlib/testing/decorators.py
@@ -359,9 +359,9 @@ def check_figures_equal(*, extensions=("png", "pdf", "svg"), tol=0):
"""
Decorator for test cases that generate and compare two figures.
- The decorated function must take two arguments, *fig_test* and *fig_ref*,
- and draw the test and reference images on them. After the function
- returns, the figures are saved and compared.
+ The decorated function must take two keyword arguments, *fig_test*
+ and *fig_ref*, and draw the test and reference images on them.
+ After the function returns, the figures are saved and compared.
This decorator should be preferred over `image_comparison` when possible in
order to keep the size of the test suite from ballooning.
@@ -382,6 +382,7 @@ def check_figures_equal(*, extensions=("png", "pdf", "svg"), tol=0):
def test_plot(fig_test, fig_ref):
fig_test.subplots().plot([1, 3, 5])
fig_ref.subplots().plot([0, 1, 2], [1, 3, 5])
+
"""
ALLOWED_CHARS = set(string.digits + string.ascii_letters + '_-[]()')
KEYWORD_ONLY = inspect.Parameter.KEYWORD_ONLY
@@ -391,6 +392,11 @@ def decorator(func):
_, result_dir = _image_directories(func)
old_sig = inspect.signature(func)
+ if not {"fig_test", "fig_ref"}.issubset(old_sig.parameters):
+ raise ValueError("The decorated function must have at least the "
+ "parameters 'fig_ref' and 'fig_test', but your "
+ f"function has the signature {old_sig}")
+
@pytest.mark.parametrize("ext", extensions)
def wrapper(*args, **kwargs):
ext = kwargs['ext']
diff --git a/lib/matplotlib/tests/test_testing.py b/lib/matplotlib/tests/test_testing.py
index d1273ec1ba46..f779d74c1007 100644
--- a/lib/matplotlib/tests/test_testing.py
+++ b/lib/matplotlib/tests/test_testing.py
@@ -15,3 +15,10 @@ def test_warn_to_fail():
@pytest.mark.parametrize("b", [1])
def test_parametrize_with_check_figure_equal(a, fig_ref, b, fig_test):
assert a == b
+
+
+def test_wrap_failure():
+ with pytest.raises(ValueError, match="^The decorated function"):
+ @check_figures_equal()
+ def should_fail(test, ref):
+ pass
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy