xkcd.mplstyle w/ quasi parsing of patheffects.{functions} and

story645 · story645 · commit e4730c21a8ba · 2023-09-21T06:16:06.000-04:00
new validate_anydict method in rcsetup
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -209,7 +209,7 @@ def __init__(self):
         self._gid = None
         self._snap = None
         self._sketch = mpl.rcParams['path.sketch']
-        self._path_effects = mpl.rcParams['path.effects']
+        self._path_effects = []
         self._sticky_edges = _XYPair([], [])
         self._in_layout = True
 
diff --git a/lib/matplotlib/mpl-data/matplotlibrc b/lib/matplotlib/mpl-data/matplotlibrc
@@ -678,7 +678,7 @@
                     #     - *randomness* is the factor by which the length is
                     #         randomly scaled.
 #path.effects:
-
+#path.effects.withStroke: None  # {"argument":value } passed to withStroke
 
 ## ***************************************************************************
 ## * SAVING FIGURES                                                          *
diff --git a/lib/matplotlib/mpl-data/stylelib/xkcd.mplstyle b/lib/matplotlib/mpl-data/stylelib/xkcd.mplstyle
@@ -0,0 +1,30 @@
+## default xkcd style
+
+# line
+lines.linewidth : 2.0
+
+# font
+font.family : xkcd, xkcd Script, Humor Sans, Comic Neue, Comic Sans MS
+font.size   : 14.0
+
+# axes
+axes.linewidth  : 1.5
+axes.grid       : False
+axes.unicode_minus: False
+axes.edgecolor: black
+
+# ticks
+xtick.major.size : 8
+xtick.major.width: 3
+ytick.major.size : 8
+ytick.major.width: 3
+
+# grids
+grid.linewidth: 0.0
+
+# figure
+figure.facecolor: white
+
+# path
+path.sketch             : (1, 100, 2)
+path.effects.withStroke : {"linewidth": 4, "foreground": 'w' }
diff --git a/lib/matplotlib/patheffects.py b/lib/matplotlib/patheffects.py
@@ -5,8 +5,11 @@
 .. seealso::
    :ref:`patheffects_guide`
 """
+import sys
 
+import matplotlib as mpl
 from matplotlib.backend_bases import RendererBase
+import matplotlib.cbook as cbook
 from matplotlib import colors as mcolors
 from matplotlib import patches as mpatches
 from matplotlib import transforms as mtransforms
@@ -90,7 +93,13 @@ def __init__(self, path_effects, renderer):
         renderer : `~matplotlib.backend_bases.RendererBase` subclass
 
         """
-        self._path_effects = path_effects
+        compound_path_effects = mpl.rcParams['path.effects']
+        for k, v in mpl.rcParams.find_all('path.effects.*').copy().items():
+            if path_effect_name := k.lstrip('path.effects') and v is not None:
+                path_effect_function = sys.modules[__name__].__dict__[path_effect_name]
+                compound_path_effects.append(path_effect_function(**v))
+        compound_path_effects.append(path_effects)
+        self._path_effects = cbook.flatten(compound_path_effects)
         self._renderer = renderer
 
     def copy_with_path_effect(self, path_effects):
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -748,27 +748,8 @@ def xkcd(
     stack = ExitStack()
     stack.callback(dict.update, rcParams, rcParams.copy())  # type: ignore
 
-    from matplotlib import patheffects
-    rcParams.update({
-        'font.family': ['xkcd', 'xkcd Script', 'Humor Sans', 'Comic Neue',
-                        'Comic Sans MS'],
-        'font.size': 14.0,
-        'path.sketch': (scale, length, randomness),
-        'path.effects': [
-            patheffects.withStroke(linewidth=4, foreground="w")],
-        'axes.linewidth': 1.5,
-        'lines.linewidth': 2.0,
-        'figure.facecolor': 'white',
-        'grid.linewidth': 0.0,
-        'axes.grid': False,
-        'axes.unicode_minus': False,
-        'axes.edgecolor': 'black',
-        'xtick.major.size': 8,
-        'xtick.major.width': 3,
-        'ytick.major.size': 8,
-        'ytick.major.width': 3,
-    })
-
+    rcParams.update({**style.library["xkcd"],
+                    'path.sketch': (scale, length, randomness)})
     return stack
 
 
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -871,6 +871,19 @@ def validate_hist_bins(s):
                      " a sequence of floats")
 
 
+def validate_anydict(allow_none=True):
+    def _validate_dict(d):
+        try:
+            d = ast.literal_eval(d)
+        except ValueError:
+            pass
+        if isinstance(d, dict) or (allow_none and (d is None)):
+            return d
+        raise ValueError(f"Input {d!r} must be a dictionary {{'k': v}} "
+                         f"{'or None' if allow_none else ''}")
+    return _validate_dict
+
+
 class _ignorecase(list):
     """A marker class indicating that a list-of-str is case-insensitive."""
 
@@ -1291,6 +1304,7 @@ def _convert_validator_spec(key, conv):
     "path.snap":               validate_bool,
     "path.sketch":             validate_sketch,
     "path.effects":            validate_anylist,
+    "path.effects.withStroke": validate_anydict(True),
     "agg.path.chunksize":      validate_int,  # 0 to disable chunking
 
     # key-mappings (multi-character mappings should be a list/tuple)
diff --git a/lib/matplotlib/rcsetup.pyi b/lib/matplotlib/rcsetup.pyi
@@ -28,6 +28,7 @@ class ValidateInStrings:
 
 def validate_any(s: Any) -> Any: ...
 def validate_anylist(s: Any) -> list[Any]: ...
+def validate_anydict(allow_none: bool) -> Callable[[dict[str, Any]|None], dict[str, Any]]: ...
 def validate_bool(b: Any) -> bool: ...
 def validate_axisbelow(s: Any) -> bool | Literal["line"]: ...
 def validate_dpi(s: Any) -> Literal["figure"] | float: ...
diff --git a/lib/matplotlib/tests/test_rcparams.py b/lib/matplotlib/tests/test_rcparams.py
@@ -12,6 +12,9 @@
 from matplotlib import _api, _c_internal_utils
 import matplotlib.pyplot as plt
 import matplotlib.colors as mcolors
+import matplotlib.patheffects as path_effects
+from matplotlib.testing.decorators import check_figures_equal
+
 import numpy as np
 from matplotlib.rcsetup import (
     validate_bool,
@@ -28,7 +31,9 @@
     validate_markevery,
     validate_stringlist,
     _validate_linestyle,
-    _listify_validator)
+     validate_anydict,
+    _listify_validator,
+    )
 
 
 def test_rcparams(tmpdir):
@@ -628,3 +633,35 @@ def test_rcparams_legend_loc_from_file(tmpdir, value):
 
     with mpl.rc_context(fname=rc_path):
         assert mpl.rcParams["legend.loc"] == value
+
+
+@pytest.mark.parametrize("allow_none", [True, False])
+def test_validate_dict(allow_none):
+    fval = validate_anydict(allow_none)
+    assert fval("{'a':1, 'b':2}") == {'a': 1, 'b': 2}
+    with pytest.raises(ValueError, match=r"Input \['a', 'b'\] "):
+        fval(['a', 'b'])
+
+
+def test_validate_dict_none():
+    assert validate_anydict()(None) is None
+    with pytest.raises(ValueError,
+                       match=r"Input None must be a dictionary "):
+        validate_anydict(False)(None)
+    with pytest.raises(ValueError,
+                       match=r"Input 0 must be a dictionary {'k': v} or None"):
+        validate_anydict(True)(0)
+
+
+def test_path_effects():
+    mpl.rcParams['path.effects.withStroke'] = {'linewidth': 4}
+    assert mpl.rcParams['path.effects.withStroke'] == {'linewidth': 4}
+
+
+@check_figures_equal()
+def test_path_effects_specific(fig_test, fig_ref):
+    with mpl.rc_context({'path.effects.withStroke': {'linewidth': 4}}):
+        fig_test.subplots().plot([1, 2, 3])
+
+    with mpl.rc_context({'path.effects': [path_effects.withStroke(linewidth=4)]}):
+        fig_ref.subplots().plot([1, 2, 3])
