Deprecate @pytest.mark.style(...).

`@mpl.style.context` can be used in the same way (and is just as
greppable), but doesn't require any support from the pytest machinery.

Author: anntzer

doc/api/next_api_changes/deprecations/20543-AL.rst

@@ -0,0 +1,3 @@
+``@pytest.mark.style`` is deprecated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Use ``@mpl.style.context``, which has the same effect.

lib/matplotlib/testing/conftest.py

@@ -13,7 +13,8 @@ def pytest_configure(config):
         ("markers", "flaky: (Provided by pytest-rerunfailures.)"),
         ("markers", "timeout: (Provided by pytest-timeout.)"),
         ("markers", "backend: Set alternate Matplotlib backend temporarily."),
-        ("markers", "style: Set alternate Matplotlib style temporarily."),
+        ("markers",
+         "style: Set alternate Matplotlib style temporarily (deprecated)."),
         ("markers", "baseline_images: Compare output against references."),
         ("markers", "pytz: Tests that require pytz to be installed."),
         ("markers", "network: Tests that reach out to the network."),
@@ -65,6 +66,8 @@ def mpl_test_settings(request):
         if style_marker is not None:
             assert len(style_marker.args) == 1, \
                 "Marker 'style' must specify 1 style."
+            _api.warn_deprecated("3.5", name="style", obj_type="pytest marker",
+                                 alternative="@mpl.style.context(...)")
             style, = style_marker.args
 
         matplotlib.testing.setup()

lib/matplotlib/testing/decorators.py

@@ -18,7 +18,6 @@
 from matplotlib import ft2font
 from matplotlib import pyplot as plt
 from matplotlib import ticker
-
 from .compare import comparable_formats, compare_images, make_test_filename
 from .exceptions import ImageComparisonFailure
 
@@ -220,7 +219,7 @@ def decorator(func):
 
         @functools.wraps(func)
         @pytest.mark.parametrize('extension', extensions)
-        @pytest.mark.style(style)
+        @matplotlib.style.context(style)
         @_checked_on_freetype_version(freetype_version)
         @functools.wraps(func)
         def wrapper(*args, extension, request, **kwargs):

lib/matplotlib/tests/test_axes.py

@@ -457,7 +457,7 @@ def test_autoscale_tiny_range():
         ax.plot([0, 1], [1, 1 + y1])
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_autoscale_tight():
     fig, ax = plt.subplots(1, 1)
     ax.plot([1, 2, 3, 4])
@@ -467,7 +467,7 @@ def test_autoscale_tight():
     assert_allclose(ax.get_ylim(), (1.0, 4.0))
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_autoscale_log_shared():
     # related to github #7587
     # array starts at zero to trigger _minpos handling
@@ -485,7 +485,7 @@ def test_autoscale_log_shared():
     assert_allclose(ax2.get_ylim(), (x[0], x[-1]))
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_use_sticky_edges():
     fig, ax = plt.subplots()
     ax.imshow([[0, 1], [2, 3]], origin='lower')
@@ -822,7 +822,7 @@ def test_nonfinite_limits():
     ax.plot(x, y)
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @pytest.mark.parametrize('plot_fun',
                          ['scatter', 'plot', 'fill_between'])
 @check_figures_equal(extensions=["png"])
@@ -1696,8 +1696,8 @@ def test_bar_pandas_indexed(pd):
     ax.bar(df.x, 1., width=df.width)
 
 
+@mpl.style.context('default')
 @check_figures_equal()
-@pytest.mark.style('default')
 def test_bar_hatches(fig_test, fig_ref):
     ax_test = fig_test.subplots()
     ax_ref = fig_ref.subplots()
@@ -2190,7 +2190,7 @@ def test_scatter_unfilled(self):
                                                    [0.5, 0.5, 0.5, 1]])
         assert_array_equal(coll.get_linewidths(), [1.1, 1.2, 1.3])
 
-    @pytest.mark.style('default')
+    @mpl.style.context('default')
     def test_scatter_unfillable(self):
         coll = plt.scatter([0, 1, 2], [1, 3, 2], c=['0.1', '0.3', '0.5'],
                            marker='x',
@@ -2340,7 +2340,7 @@ def get_next_color():
                     c=c_case, edgecolors="black", kwargs={}, xsize=xsize,
                     get_next_color_func=get_next_color)
 
-    @pytest.mark.style('default')
+    @mpl.style.context('default')
     @check_figures_equal(extensions=["png"])
     def test_scatter_single_color_c(self, fig_test, fig_ref):
         rgb = [[1, 0.5, 0.05]]
@@ -5575,7 +5575,7 @@ def test_loglog_nonpos():
                 ax.set_yscale("log", nonpositive=mcy)
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_axes_margins():
     fig, ax = plt.subplots()
     ax.plot([0, 1, 2, 3])
@@ -6060,7 +6060,7 @@ def test_tick_param_label_rotation():
         assert text.get_rotation() == 35
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_fillbetween_cycle():
     fig, ax = plt.subplots()
 
@@ -6878,7 +6878,7 @@ def test_polar_interpolation_steps_variable_r(fig_test, fig_ref):
         np.linspace(0, np.pi/2, 101), np.linspace(1, 2, 101))
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_autoscale_tiny_sticky():
     fig, ax = plt.subplots()
     ax.bar(0, 1e-9)
@@ -6908,7 +6908,7 @@ def test_ytickcolor_is_not_yticklabelcolor():
 
 @pytest.mark.parametrize('size', [size for size in mfont_manager.font_scalings
                                   if size is not None] + [8, 10, 12])
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_relative_ticklabel_sizes(size):
     mpl.rcParams['xtick.labelsize'] = size
     mpl.rcParams['ytick.labelsize'] = size
@@ -7066,7 +7066,7 @@ def test_patch_bounds():  # PR 19078
         np.array((-0.525, -(bot+0.05), 1.05, bot+0.1)), ax.dataLim.bounds, 16)
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_warn_ignored_scatter_kwargs():
     with pytest.warns(UserWarning,
                       match=r"You passed a edgecolor/edgecolors"):

lib/matplotlib/tests/test_backend_pdf.py

@@ -308,7 +308,7 @@ def psfont(*args, **kwargs):
         fig.savefig(tmpfile, format='pdf')
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @check_figures_equal(extensions=["pdf", "eps"])
 def test_pdf_eps_savefig_when_color_is_none(fig_test, fig_ref):
     ax_test = fig_test.add_subplot()

lib/matplotlib/tests/test_backend_pgf.py

@@ -118,7 +118,7 @@ def test_pdflatex():
 # test updating the rc parameters for each figure
 @needs_xelatex
 @needs_pdflatex
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @pytest.mark.backend('pgf')
 def test_rcupdate():
     rc_sets = [{'font.family': 'sans-serif',
@@ -149,7 +149,7 @@ def test_rcupdate():
 
 # test backend-side clipping, since large numbers are not supported by TeX
 @needs_xelatex
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @pytest.mark.backend('pgf')
 def test_pathclip():
     np.random.seed(19680801)
@@ -179,7 +179,7 @@ def test_mixedmode():
 
 # test bbox_inches clipping
 @needs_xelatex
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @pytest.mark.backend('pgf')
 def test_bbox_inches():
     mpl.rcParams.update({'font.family': 'serif', 'pgf.rcfonts': False})
@@ -192,7 +192,7 @@ def test_bbox_inches():
                    tol=0)
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @pytest.mark.backend('pgf')
 @pytest.mark.parametrize('system', [
     pytest.param('lualatex', marks=[needs_lualatex]),
@@ -234,7 +234,7 @@ def test_pdf_pages(system):
         assert pdf.get_pagecount() == 3
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @pytest.mark.backend('pgf')
 @pytest.mark.parametrize('system', [
     pytest.param('lualatex', marks=[needs_lualatex]),

lib/matplotlib/tests/test_backend_svg.py

@@ -198,7 +198,7 @@ def psfont(*args, **kwargs):
 
 
 # Use Computer Modern Sans Serif, not Helvetica (which has no \textwon).
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @needs_usetex
 def test_unicode_won():
     fig = Figure()

lib/matplotlib/tests/test_category.py

@@ -2,6 +2,7 @@
 import pytest
 import numpy as np
 
+import matplotlib as mpl
 from matplotlib._api import MatplotlibDeprecationWarning
 from matplotlib.axes import Axes
 import matplotlib.pyplot as plt
@@ -281,7 +282,7 @@ def test_mixed_type_update_exception(self, plotter, xdata):
             plotter(ax, xdata, [1, 2])
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @check_figures_equal(extensions=["png"])
 def test_overriding_units_in_plot(fig_test, fig_ref):
     from datetime import datetime

lib/matplotlib/tests/test_collections.py

@@ -304,7 +304,7 @@ def test_add_collection():
     assert ax.dataLim.bounds == bounds
 
 
-@pytest.mark.style('mpl20')
+@mpl.style.context('mpl20')
 @check_figures_equal(extensions=['png'])
 def test_collection_log_datalim(fig_test, fig_ref):
     # Data limits should respect the minimum x/y when using log scale.
@@ -515,7 +515,7 @@ def test_pandas_indexing(pd):
     Collection(antialiaseds=aa)
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_lslw_bcast():
     col = mcollections.PathCollection([])
     col.set_linestyles(['-', '-'])
@@ -529,15 +529,15 @@ def test_lslw_bcast():
     assert (col.get_linewidths() == [1, 2, 3]).all()
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_capstyle():
     col = mcollections.PathCollection([], capstyle='round')
     assert col.get_capstyle() == 'round'
     col.set_capstyle('butt')
     assert col.get_capstyle() == 'butt'
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 def test_joinstyle():
     col = mcollections.PathCollection([], joinstyle='round')
     assert col.get_joinstyle() == 'round'
@@ -933,7 +933,7 @@ def test_legend_inverse_size_label_relationship():
     assert_array_almost_equal(handle_sizes, legend_sizes, decimal=1)
 
 
-@pytest.mark.style('default')
+@mpl.style.context('default')
 @pytest.mark.parametrize('pcfunc', [plt.pcolor, plt.pcolormesh])
 def test_color_logic(pcfunc):
     z = np.arange(12).reshape(3, 4)

lib/matplotlib/tests/test_contour.py

@@ -466,7 +466,7 @@ def test_contour_line_start_on_corner_edge():
     cbar.add_lines(lines)
 
 
-@pytest.mark.style("default")
+@mpl.style.context("default")
 def test_contour_autolabel_beyond_powerlimits():
     ax = plt.figure().add_subplot()
     cs = plt.contour(np.geomspace(1e-6, 1e-4, 100).reshape(10, 10),