Adds xkcd style sheet, replicates tests using plt.xkcd with xkcd style,

story645 · anntzer · story645 · commit 931cf4ab517e · 2023-11-06T22:32:24.000-05:00
Co-authored-by: Antony Lee &lt;anntzer.lee@gmail.com&gt;
diff --git a/doc/users/next_whats_new/sketch_xkcd.rst b/doc/users/next_whats_new/sketch_xkcd.rst
@@ -0,0 +1,26 @@
+path.effects rcParam can be set in stylesheet and new xkcd stylesheet
+---------------------------------------------------------------------
+
+Can now set the ``path.effects`` :ref:`rcParam in a style sheet <customizing>`
+using a list of ``(patheffects function name, {**kwargs})``::
+
+    path.effects: ('Normal', ), ('Stroke', {'offset': (1, 2)}), ('withStroke', {'linewidth': 4, 'foreground': 'w'})
+
+
+This feature means that the xkcd style can be used like any other stylesheet:
+
+.. plot::
+    :include-source: true
+    :alt: plot where graph and text appear in a hand drawn comic like style
+
+    import numpy as np
+    import matplotlib.pyplot as plt
+
+    x = np.linspace(0, 2* np.pi, 100)
+    y = np.sin(x)
+
+    with plt.style.context('xkcd'):
+
+        fig, ax = plt.subplots()
+        ax.set_title("sine curve")
+        ax.plot(x, y)
diff --git a/galleries/examples/style_sheets/style_sheets_reference.py b/galleries/examples/style_sheets/style_sheets_reference.py
@@ -23,6 +23,7 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
+import matplotlib as mpl
 import matplotlib.colors as mcolors
 from matplotlib.patches import Rectangle
 
@@ -47,7 +48,7 @@ def plot_colored_lines(ax):
     def sigmoid(t, t0):
         return 1 / (1 + np.exp(-(t - t0)))
 
-    nb_colors = len(plt.rcParams['axes.prop_cycle'])
+    nb_colors = len(mpl.rcParams['axes.prop_cycle'])
     shifts = np.linspace(-5, 5, nb_colors)
     amplitudes = np.linspace(1, 1.5, nb_colors)
     for t0, a in zip(shifts, amplitudes):
@@ -75,14 +76,15 @@ def plot_colored_circles(ax, prng, nb_samples=15):
     the color cycle, because different styles may have different numbers
     of colors.
     """
-    for sty_dict, j in zip(plt.rcParams['axes.prop_cycle'](),
+    for sty_dict, j in zip(mpl.rcParams['axes.prop_cycle'](),
                            range(nb_samples)):
         ax.add_patch(plt.Circle(prng.normal(scale=3, size=2),
                                 radius=1.0, color=sty_dict['color']))
     ax.grid(visible=True)
 
     # Add title for enabling grid
-    plt.title('ax.grid(True)', family='monospace', fontsize='small')
+    font_family = mpl.rcParams.get('font.family', 'monospace')
+    ax.set_title('ax.grid(True)', family=font_family, fontsize='medium')
 
     ax.set_xlim([-4, 8])
     ax.set_ylim([-5, 6])
@@ -133,11 +135,12 @@ def plot_figure(style_label=""):
     # make a suptitle, in the same style for all subfigures,
     # except those with dark backgrounds, which get a lighter color:
     background_color = mcolors.rgb_to_hsv(
-        mcolors.to_rgb(plt.rcParams['figure.facecolor']))[2]
+        mcolors.to_rgb(mpl.rcParams['figure.facecolor']))[2]
     if background_color < 0.5:
         title_color = [0.8, 0.8, 1]
     else:
         title_color = np.array([19, 6, 84]) / 256
+
     fig.suptitle(style_label, x=0.01, ha='left', color=title_color,
                  fontsize=14, fontfamily='DejaVu Sans', fontweight='normal')
 
@@ -147,28 +150,25 @@ def plot_figure(style_label=""):
     plot_colored_lines(axs[3])
     plot_histograms(axs[4], prng)
     plot_colored_circles(axs[5], prng)
-
     # add divider
     rec = Rectangle((1 + 0.025, -2), 0.05, 16,
                     clip_on=False, color='gray')
 
     axs[4].add_artist(rec)
 
-if __name__ == "__main__":
-
-    # Set up a list of all available styles, in alphabetical order but
-    # the `default` and `classic` ones, which will be forced resp. in
-    # first and second position.
-    # styles with leading underscores are for internal use such as testing
-    # and plot types gallery. These are excluded here.
-    style_list = ['default', 'classic'] + sorted(
-        style for style in plt.style.available
-        if style != 'classic' and not style.startswith('_'))
-
-    # Plot a demonstration figure for every available style sheet.
-    for style_label in style_list:
-        with plt.rc_context({"figure.max_open_warning": len(style_list)}):
-            with plt.style.context(style_label):
-                plot_figure(style_label=style_label)
 
-    plt.show()
+# Set up a list of all available styles, in alphabetical order but
+# the `default` and `classic` ones, which will be forced resp. in
+# first and second position.
+# styles with leading underscores are for internal use such as testing
+# and plot types gallery. These are excluded here.
+style_list = ['default', 'classic'] + sorted(
+    style for style in mpl.style.available
+    if style != 'classic' and not style.startswith('_'))
+
+# Plot a demonstration figure for every available style sheet:
+for style_label in style_list:
+    with mpl.rc_context({"figure.max_open_warning": len(style_list)}):
+        with mpl.style.context(style_label, after_reset=True):
+            plot_figure(style_label=style_label)
+            plt.show()
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, 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/pyplot.py b/lib/matplotlib/pyplot.py
@@ -747,27 +747,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/tests/test_path.py b/lib/matplotlib/tests/test_path.py
@@ -253,6 +253,18 @@ def test_xkcd():
         ax.plot(x, y)
 
 
+@image_comparison(['xkcd.png'], remove_text=True)
+def test_xkcd_style():
+    np.random.seed(0)
+
+    x = np.linspace(0, 2 * np.pi, 100)
+    y = np.sin(x)
+
+    with plt.style.context('xkcd'):
+        fig, ax = plt.subplots()
+        ax.plot(x, y)
+
+
 @image_comparison(['xkcd_marker.png'], remove_text=True)
 def test_xkcd_marker():
     np.random.seed(0)
@@ -269,6 +281,22 @@ def test_xkcd_marker():
         ax.plot(x, y3, '^', ms=10)
 
 
+@image_comparison(['xkcd_marker.png'], remove_text=True)
+def test_xkcd_marker_style():
+    np.random.seed(0)
+
+    x = np.linspace(0, 5, 8)
+    y1 = x
+    y2 = 5 - x
+    y3 = 2.5 * np.ones(8)
+
+    with plt.style.context('xkcd'):
+        fig, ax = plt.subplots()
+        ax.plot(x, y1, '+', ms=10)
+        ax.plot(x, y2, 'o', ms=10)
+        ax.plot(x, y3, '^', ms=10)
+
+
 @image_comparison(['marker_paths.pdf'], remove_text=True)
 def test_marker_paths_pdf():
     N = 7
diff --git a/lib/matplotlib/tests/test_style.py b/lib/matplotlib/tests/test_style.py
@@ -8,6 +8,7 @@
 
 import matplotlib as mpl
 from matplotlib import pyplot as plt, style
+from matplotlib.testing.decorators import check_figures_equal
 from matplotlib.style.core import USER_LIBRARY_PATHS, STYLE_EXTENSION
 
 
@@ -170,13 +171,40 @@ def test_xkcd_no_cm():
     assert mpl.rcParams["path.sketch"] == (1, 100, 2)
 
 
+def test_xkcd_no_cm_style():
+    assert mpl.rcParams["path.sketch"] is None
+    plt.style.use('xkcd')
+    assert mpl.rcParams["path.sketch"] == (1, 100, 2)
+    np.testing.break_cycles()
+    assert mpl.rcParams["path.sketch"] == (1, 100, 2)
+
+
 def test_xkcd_cm():
     assert mpl.rcParams["path.sketch"] is None
     with plt.xkcd():
         assert mpl.rcParams["path.sketch"] == (1, 100, 2)
     assert mpl.rcParams["path.sketch"] is None
 
 
+def test_xkcd_cm_style():
+    assert mpl.rcParams["path.sketch"] is None
+    with style.context('xkcd'):
+        assert mpl.rcParams["path.sketch"] == (1, 100, 2)
+    assert mpl.rcParams["path.sketch"] is None
+
+
+@check_figures_equal()
+def test_xkcd_style(fig_test, fig_ref):
+
+    with style.context('xkcd'):
+        fig_test.subplots().plot([1, 2, 3])
+        fig_test.text(.5, .5, "Hello World!")
+
+    with plt.xkcd():
+        fig_ref.subplots().plot([1, 2, 3])
+        fig_ref.text(.5, .5, "Hello World!")
+
+
 def test_up_to_date_blacklist():
     assert mpl.style.core.STYLE_BLACKLIST <= {*mpl.rcsetup._validators}
 
