Support vlines/hlines/stem

Author: lukelbd

docs/1dplots.py

@@ -465,12 +465,6 @@
 # `~matplotlib.axes.Axes.scatter` now optionally accepts keywords that look
 # like `~matplotlib.axes.Axes.plot` keywords (e.g. `color` instead of `c` and
 # `markersize` instead of `s`).
-#
-# We are also considering supporting 2D array input and property cycle
-# iteration for more obscure matplotlib plotting commands like
-# `~matplotlib.axes.Axes.stem`, `~matplotlib.axes.Axes.step`,
-# `~matplotlib.axes.Axes.vlines`, and `~matplotlib.axes.Axes.hlines`. Stay
-# tuned.
 
 # %%
 import proplot as plot

proplot/axes/base.py

@@ -13,10 +13,10 @@
     _get_transform,
     _add_errorbars, _bar_wrapper, _barh_wrapper, _boxplot_wrapper,
     _cmap_changer, _cycle_changer,
-    _fill_between_wrapper, _fill_betweenx_wrapper,
-    _hist_wrapper, _parametric_wrapper, _plot_wrapper, _scatter_wrapper,
+    _fill_between_wrapper, _fill_betweenx_wrapper, _hlines_wrapper,
+    _hist_wrapper, _parametric_wrapper, _plot_wrapper, _scatter_wrapper, _stem_wrapper,
     _standardize_1d, _standardize_2d,
-    _text_wrapper, _violinplot_wrapper,
+    _text_wrapper, _violinplot_wrapper, _vlines_wrapper,
     colorbar_wrapper, legend_wrapper,
 )
 from .. import gridspec as pgridspec
@@ -1671,13 +1671,21 @@ def number(self, num):
     pie = _standardize_1d(_cycle_changer(
         maxes.Axes.pie
     ))
-    stem = _standardize_1d(_cycle_changer(
-        maxes.Axes.stem
-    ))
     step = _standardize_1d(_cycle_changer(
         maxes.Axes.step
     ))
 
+    # Wrapped by standardizer
+    stem = _standardize_1d(_stem_wrapper(
+        maxes.Axes.stem
+    ))
+    hlines = _standardize_1d(_hlines_wrapper(
+        maxes.Axes.hlines
+    ))
+    vlines = _standardize_1d(_vlines_wrapper(
+        maxes.Axes.vlines
+    ))
+
     # Wrapped by cmap wrapper and standardized
     # Also support redirecting to Basemap methods
     hexbin = _standardize_1d(_cmap_changer(

proplot/axes/plot.py

@@ -1077,7 +1077,7 @@ def add_errorbars(
     return obj
 
 
-def _parametric_wrapper_temporary(self, func, *args, interp=0, **kwargs):
+def _parametric_wrapper_private(self, func, *args, interp=0, **kwargs):
     """
     Calls `~proplot.axes.Axes.parametric` and optionally interpolates values before
     they get passed to `cmap_changer` and the colormap boundaries are drawn.
@@ -1127,7 +1127,7 @@ def _parametric_wrapper_temporary(self, func, *args, interp=0, **kwargs):
     return func(self, x, y, values=values, **kwargs)
 
 
-def _plot_wrapper_deprecated(
+def _plot_wrapper_private(
     self, func, *args, cmap=None, values=None, **kwargs
 ):
     """
@@ -1278,6 +1278,59 @@ def scatter_wrapper(
     return obj
 
 
+def _stem_wrapper_private(self, func, *args, **kwargs):
+    """
+    Make `use_line_collection` the default to suppress annoying warning message.
+    """
+    kwargs.setdefault('use_line_collection', True)
+    kwargs.setdefault('linefmt', 'C0-')
+    kwargs.setdefault('basefmt', kwargs['linefmt'])  # use *same* for base
+    try:
+        return func(self, *args, **kwargs)
+    except TypeError:
+        kwargs.pop('use_line_collection')  # old version
+        return func(self, *args, **kwargs)
+
+
+def _parse_lines_args(x, args, kwargs):
+    """
+    Parse lines arguments. Support automatic *x* coordinates and default
+    "minima" at zero.
+    """
+    args = list(args)
+    if x in kwargs:
+        args.insert(0, kwargs.pop(x))
+    y = 'y' if x == 'x' else 'x'
+    for suffix in ('min', 'max'):
+        key = y + suffix
+        if key in kwargs:
+            args.append(kwargs.pop(key))
+    if len(args) == 1:
+        x = np.arange(len(np.atleast_1d(args[0])))
+        args.insert(0, x)
+    if len(args) == 2:
+        args.insert(1, 0.0)
+    elif len(args) != 3:
+        raise TypeError('lines() requires 1 to 3 positional arguments.')
+    return args, kwargs
+
+
+def _hlines_wrapper_private(self, func, *args, **kwargs):
+    """
+    Parse hlines arguments.
+    """
+    args, kwargs = _parse_lines_args('x', args, kwargs)
+    return func(self, *args, **kwargs)
+
+
+def _vlines_wrapper_private(self, func, *args, **kwargs):
+    """
+    Parse vlines arguments.
+    """
+    args, kwargs = _parse_lines_args('y', args, kwargs)
+    return func(self, *args, **kwargs)
+
+
 def _fill_between_apply(
     self, func, *args,
     negcolor=None, poscolor=None, negpos=False,
@@ -1938,12 +1991,12 @@ def cycle_changer(
 
     # Custom property cycler additions
     # NOTE: By default matplotlib uses _get_patches_for_fill.get_next_color
-    # for scatter properties! So we simultaneously iterate through the
-    # _get_lines property cycler and apply them.
-    apply = set()  # which keys to apply from property cycler
-    if name == 'scatter':
+    # for scatter next scatter color, but cannot get anything else! We simultaneously
+    # iterate through the _get_lines property cycler and apply relevant properties.
+    apply_from_cycler = set()  # which keys to apply from property cycler
+    if name in ('scatter',):
         # Figure out which props should be updated
-        keys = {*self._get_lines._prop_keys} - {'color', 'linestyle', 'dashes'}
+        prop_keys = set(self._get_lines._prop_keys) - {'color', 'linestyle', 'dashes'}
         for key, prop in (
             ('markersize', 's'),
             ('linewidth', 'linewidths'),
@@ -1953,8 +2006,8 @@ def cycle_changer(
             ('marker', 'marker'),
         ):
             prop = kwargs.get(prop, None)
-            if key in keys and prop is None:
-                apply.add(key)
+            if key in prop_keys and prop is None:  # if key in cycler and property unset
+                apply_from_cycler.add(key)
 
     # Handle legend labels and
     # WARNING: Most methods that accept 2d arrays use columns of data, but when
@@ -1996,9 +2049,9 @@ def cycle_changer(
     for i in range(ncols):
         # Prop cycle properties
         kw = kwargs.copy()
-        if apply:
+        if apply_from_cycler:
             props = next(self._get_lines.prop_cycler)
-            for key in apply:
+            for key in apply_from_cycler:
                 value = props[key]
                 if key in ('size', 'markersize'):
                     key = 's'
@@ -3554,10 +3607,13 @@ def _wrapper(self, *args, **kwargs):
 _fill_between_wrapper = _generate_decorator(fill_between_wrapper)
 _fill_betweenx_wrapper = _generate_decorator(fill_betweenx_wrapper)
 _hist_wrapper = _generate_decorator(hist_wrapper)
-_parametric_wrapper = _generate_decorator(_parametric_wrapper_temporary)
-_plot_wrapper = _generate_decorator(_plot_wrapper_deprecated)
+_hlines_wrapper = _generate_decorator(_hlines_wrapper_private)
+_parametric_wrapper = _generate_decorator(_parametric_wrapper_private)
+_plot_wrapper = _generate_decorator(_plot_wrapper_private)
 _scatter_wrapper = _generate_decorator(scatter_wrapper)
 _standardize_1d = _generate_decorator(standardize_1d)
 _standardize_2d = _generate_decorator(standardize_2d)
+_stem_wrapper = _generate_decorator(_stem_wrapper_private)
 _text_wrapper = _generate_decorator(text_wrapper)
 _violinplot_wrapper = _generate_decorator(violinplot_wrapper)
+_vlines_wrapper = _generate_decorator(_vlines_wrapper_private)