adapt hatch for matplotlib 3.10 (#143)

* adapt hatch for matplotlib ge 3.10

* changelog

Author: mathause

CHANGELOG.md

@@ -27,7 +27,9 @@
   2. `mpu.hatch_map`: for cartopy GeoAxes
   3. `mpu.hatch_map_global`: as 2. but also adds a cyclic point to the array
 
-  all three functions expect a 2D boolean `xr.DataArray` and a hatch pattern. Values that are `True` are hatched.
+  all three functions expect a 2D boolean `xr.DataArray` and a hatch pattern. Values that are `True` are hatched
+  ([#123](https://github.com/mathause/mplotutils/pull/123) and [#143](https://github.com/mathause/mplotutils/pull/143)).
+
 
 - Enable passing `AxesGrid` (from `mpl_toolkits.axes_grid1`) to `set_map_layout` ([#116](https://github.com/mathause/mplotutils/pull/116)).
 - Raise more informative error when a wrong type is passed to `set_map_layout` ([#121](https://github.com/mathause/mplotutils/pull/121)).

mplotutils/_hatch.py

@@ -4,6 +4,7 @@
 import matplotlib as mpl
 import numpy as np
 import xarray as xr
+from packaging.version import Version
 
 import mplotutils as mpu
 
@@ -12,6 +13,8 @@
 
 from mplotutils._mpl import _maybe_gca
 
+MPL_GE_310 = Version(Version(mpl.__version__).base_version) >= Version("3.10")
+
 
 def hatch(da, hatch, *, ax=None, label=None, linewidth=None, color="0.1"):
     """add hatch pattern to an axes
@@ -185,22 +188,29 @@ def _hatch(
 
     fig = ax.figure
 
-    # only one linewidth is possible per figure (actually it is just read before
-    # saving the figure, so the above is not 100 % correct)
-    if linewidth is None:
-        # only set linewidth if not yet set
-        if not _HATCHES_PER_FIGURE.get(fig):
-            mpl.rcParams["hatch.linewidth"] = 0.25
+    if not MPL_GE_310:
+        # only one linewidth is possible per figure (actually it is just read before
+        # saving the figure, so the above is not 100 % correct)
+        if linewidth is None:
+            # only set linewidth if not yet set
+            if not _HATCHES_PER_FIGURE.get(fig):
+                mpl.rcParams["hatch.linewidth"] = 0.25
+        else:
+            if _HATCHES_PER_FIGURE.get(fig):
+                warnings.warn(
+                    "Setting more than one hatch `linewidth` per figure requires"
+                    " matplotlib v3.10 or later Overwriting previous value of"
+                    f" {_HATCHES_PER_FIGURE[fig]}."
+                )
+
+            mpl.rcParams["hatch.linewidth"] = linewidth
+
+            _HATCHES_PER_FIGURE[fig] = linewidth
     else:
-        if _HATCHES_PER_FIGURE.get(fig):
-            warnings.warn(
-                "Can only set one `linewidth` per figure. Overwriting previous value of"
-                f" {_HATCHES_PER_FIGURE[fig]}."
-            )
-
-        mpl.rcParams["hatch.linewidth"] = linewidth
-
-        _HATCHES_PER_FIGURE[fig] = linewidth
+        if linewidth is None:
+            mpl.rcParams["hatch.linewidth"] = 0.25
+        else:
+            mpl.rcParams["hatch.linewidth"] = linewidth
 
     mpl.rcParams["hatch.color"] = color
 

mplotutils/tests/test_hatch.py

@@ -3,11 +3,16 @@
 import numpy as np
 import pytest
 import xarray as xr
+from packaging.version import Version
 
 import mplotutils as mpu
 
 from . import assert_no_warnings, subplots_context
 
+MPL_GE_310 = Version(Version(mpl.__version__).base_version) >= Version("3.10")
+requires_mpl_ge_310 = pytest.mark.skipif(not MPL_GE_310, reason="requires mpl >= 3.10")
+
+
 HATCH_FUNCTIONS = (
     pytest.param(mpu.hatch, id="hatch"),
     pytest.param(mpu.hatch_map, id="hatch_map"),
@@ -104,8 +109,9 @@ def test_hatch_label(function):
             assert mpl.colors.to_rgba("#2ca25f") == rect._hatch_color
 
 
+@pytest.mark.skipif(MPL_GE_310, reason="only for mpl < 3.10")
 @pytest.mark.parametrize("function", HATCH_FUNCTIONS)
-def test_hatch_linewidth(function):
+def test_hatch_linewidth_mpl_lt_310(function):
 
     da = xr.DataArray(
         np.ones([3, 3], dtype=bool),
@@ -132,18 +138,67 @@ def test_hatch_linewidth(function):
 
         assert mpl.rcParams["hatch.linewidth"] == 1
 
-    # changing away from the default linewidth does not raise a warning
+    # changing away from the linewidth does raise a warning
     with subplots_context(1, 1, subplot_kw=subplot_kw) as (__, ax):
 
         function(da, "*", ax=ax, linewidth=2)
         assert mpl.rcParams["hatch.linewidth"] == 2
 
-        with pytest.warns(match="Can only set one `linewidth` per figure"):
+        with pytest.warns(match="Setting more than one hatch `linewidth`"):
             function(da, "*", ax=ax, linewidth=1)
 
         assert mpl.rcParams["hatch.linewidth"] == 1
 
 
+@requires_mpl_ge_310
+@pytest.mark.parametrize("function", HATCH_FUNCTIONS)
+def test_hatch_linewidth_mpl_ge_310(function):
+
+    da = xr.DataArray(
+        np.ones([3, 3], dtype=bool),
+        dims=("lat", "lon"),
+        coords={"lat": [0, 1, 2], "lon": [1, 2, 3]},
+    )
+
+    subplot_kw = {"projection": ccrs.PlateCarree()}
+
+    # test linewidth default width
+    with subplots_context(1, 1, subplot_kw=subplot_kw) as (__, ax):
+        q = function(da, "*", ax=ax)
+        assert q.get_hatch_linewidth() == 0.25
+        assert mpl.rcParams["hatch.linewidth"] == 0.25
+
+    # changing away from the default linewidth does not raise a warning
+    with subplots_context(1, 1, subplot_kw=subplot_kw) as (__, ax):
+
+        q = function(da, "*", ax=ax)
+        assert q.get_hatch_linewidth() == 0.25
+        assert mpl.rcParams["hatch.linewidth"] == 0.25
+
+        with assert_no_warnings():
+            q = function(da, "*", ax=ax, linewidth=1)
+
+        assert q.get_hatch_linewidth() == 1
+        assert mpl.rcParams["hatch.linewidth"] == 1
+
+        q = function(da, "*", ax=ax)
+        assert q.get_hatch_linewidth() == 0.25
+        assert mpl.rcParams["hatch.linewidth"] == 0.25
+
+    # changing away from the linewidth does NOT raise a warning
+    with subplots_context(1, 1, subplot_kw=subplot_kw) as (__, ax):
+
+        q = function(da, "*", ax=ax, linewidth=2)
+        assert q.get_hatch_linewidth() == 2
+        assert mpl.rcParams["hatch.linewidth"] == 2
+
+        with assert_no_warnings():
+            q = function(da, "*", ax=ax, linewidth=1)
+
+        assert q.get_hatch_linewidth() == 1
+        assert mpl.rcParams["hatch.linewidth"] == 1
+
+
 @pytest.mark.parametrize("function", HATCH_FUNCTIONS)
 def test_hatch_color(function):