If stem markerfmt does not contain a color, use the color from linefmt

timhoffm · timhoffm · commit 495e76d03acd · 2022-06-19T18:41:26.000+02:00
instead of the hard-coded 'C0'. While this is technically a breaking
API change, it is unlikely that somebody wants to color their lines,
but intentionally leaves their marker color as default 'C0'. I think
there is no simple mechanism that'd allow a deprecation. All I can
think of would require user actions at the beginning and at the end
of the deprecation period. Given that this should only affect very
few users and there is a simple workaround (state both formats
explicitly).
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -2821,6 +2821,8 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0,
 
         The *locs*-positions are optional. The formats may be provided either
         as positional or as keyword-arguments.
+        Passing *markerfmt* and *basefmt* positionally is deprecated since
+        Matplotlib 3.5.
 
         Parameters
         ----------
@@ -2853,8 +2855,8 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0,
 
         markerfmt : str, optional
             A string defining the color and/or shape of the markers at the stem
-            heads.  Default: 'C0o', i.e. filled circles with the first color of
-            the color cycle.
+            heads.  Default: 'o', i.e. filled circles. If the color is not
+            given, the color from *linefmt* is used.
 
         basefmt : str, default: 'C3-' ('C2-' in classic mode)
             A format string defining the properties of the baseline.
@@ -2924,9 +2926,15 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0,
         linestyle, linemarker, linecolor = _process_plot_format(linefmt)
 
         if markerfmt is None:
-            markerfmt = args[1] if len(args) > 1 else "C0o"
+            markerfmt = args[1] if len(args) > 1 else "o"
         markerstyle, markermarker, markercolor = \
             _process_plot_format(markerfmt)
+        if markermarker is None:
+            markermarker = 'o'
+        if markercolor is None:
+            markercolor = linecolor
+
+        print(markerstyle, markermarker, markercolor)
 
         if basefmt is None:
             basefmt = (args[2] if len(args) > 2 else
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -3833,6 +3833,7 @@ def test_stem(use_line_collection):
 
 
 def test_stem_args():
+    """Test that stem() correctly identifies x and y values."""
     def _assert_equal(stem_container, expected):
         x, y = map(list, stem_container.markerline.get_data())
         assert x == expected[0]
@@ -3853,6 +3854,64 @@ def _assert_equal(stem_container, expected):
     _assert_equal(ax.stem(y, 'r--'), expected=([0, 1, 2], y))
 
 
+def test_stem_markerfmt():
+    """Test that stem(..., markerfmt=...) produces the intended markers."""
+    def _assert_equal(stem_container, linecolor=None, markercolor=None,
+                      marker=None):
+        """
+        Check that the given StemContainer has the properties listed as
+        keyword-arguments.
+        """
+        if linecolor is not None:
+            assert mcolors.same_color(
+                stem_container.stemlines.get_color(),
+                linecolor)
+        if markercolor is not None:
+            assert mcolors.same_color(
+                stem_container.markerline.get_color(),
+                markercolor)
+        if marker is not None:
+            assert stem_container.markerline.get_marker() == marker
+
+    fig, ax = plt.subplots()
+
+    x = [1, 3, 5]
+    y = [9, 8, 7]
+
+    # no linefmt
+    _assert_equal(ax.stem(x, y), markercolor='C0')
+    _assert_equal(ax.stem(x, y, markerfmt='x'), markercolor='C0', marker='x')
+    _assert_equal(ax.stem(x, y, markerfmt='rx'), markercolor='r', marker='x')
+
+    # positional linefmt
+    _assert_equal(
+        ax.stem(x, y, 'r'),  # marker color follows linefmt if not given
+        linecolor='r', markercolor='r', marker='o')
+    _assert_equal(
+        ax.stem(x, y, 'rx'),  # the marker is currently not taken from linefmt
+        linecolor='r', markercolor='r', marker='o')
+    _assert_equal(
+        ax.stem(x, y, 'r', markerfmt='x'),  # only marker type specified
+        linecolor='r', markercolor='r', marker='x')
+    _assert_equal(
+        ax.stem(x, y, 'r', markerfmt='g'),  # only marker color specified
+        linecolor='r', markercolor='g', marker='o')
+    _assert_equal(
+        ax.stem(x, y, 'r', markerfmt='gx'),  # marker type and color specified
+        linecolor='r', markercolor='g', marker='x')
+
+    # with linefmt kwarg
+    _assert_equal(
+        ax.stem(x, y, linefmt='r'),
+        linecolor='r', markercolor='r', marker='o')
+    _assert_equal(
+        ax.stem(x, y, linefmt='r', markerfmt='x'),
+        linecolor='r', markercolor='r', marker='x')
+    _assert_equal(
+        ax.stem(x, y, linefmt='r', markerfmt='gx'),
+        linecolor='r', markercolor='g', marker='x')
+
+
 def test_stem_dates():
     fig, ax = plt.subplots(1, 1)
     xs = [dateutil.parser.parse("2013-9-28 11:00:00"),
