limit StepPatch to get/set_data()

andrzejnovak · andrzejnovak · commit 1d20bb268ad9 · 2020-10-02T02:16:35.000+02:00
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -4,6 +4,7 @@
 import math
 from numbers import Number
 import textwrap
+from collections import namedtuple
 
 import numpy as np
 
@@ -993,12 +994,14 @@ def _update_path(self):
             self._path = Path(np.vstack(verts), np.hstack(codes))
 
     def get_data(self):
-        """Get `.StepPatch` values, edges and baseline."""
-        return self._values, self._edges, self._baseline
+        """Get `.StepPatch` values, edges and baseline as namedtuple."""
+        StairData = namedtuple('StairData', 'values edges baseline')
+        return StairData(self._values, self._edges, self._baseline)
 
-    def set_data(self, values, edges=None, baseline=None):
+
+    def set_data(self, values=None, edges=None, baseline=None):
         """
-        Set `.StepPatch` values and optionally edges and baseline.
+        Set `.StepPatch` values, edges and baseline.
 
         Parameters
         ----------
@@ -1007,6 +1010,8 @@ def set_data(self, values, edges=None, baseline=None):
         edges : 1D array-like, optional
         baseline : float, 1D array-like or None
         """
+        if values is None and edges is None and baseline is None:
+            raise ValueError("Must set *values*, *edges* or *baseline*.")
         if values is not None:
             self._values = np.asarray(values)
         if edges is not None:
@@ -1016,40 +1021,6 @@ def set_data(self, values, edges=None, baseline=None):
         self._update_path()
         self.stale = True
 
-    def set_values(self, values):
-        """
-        Set `.StepPatch` values.
-
-        Parameters
-        ----------
-        values : 1D array-like
-        """
-        self.set_data(values, edges=None, baseline=None)
-
-    def set_edges(self, edges):
-        """
-        Set `.StepPatch` edges.
-
-        Parameters
-        ----------
-        edges : 1D array-like
-        """
-        self.set_data(None, edges=edges, baseline=None)
-
-    def get_baseline(self):
-        """Get `.StepPatch` baseline."""
-        return self._baseline
-
-    def set_baseline(self, baseline):
-        """
-        Set `.StepPatch` baseline.
-
-        Parameters
-        ----------
-        baseline : float, array-like or None, default: 0
-        """
-        self.set_data(None, edges=None, baseline=baseline)
-
 
 class Polygon(Patch):
     """A general polygon patch."""
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -1884,15 +1884,15 @@ def test_stairs_update(fig_test, fig_ref):
     test_ax = fig_test.add_subplot()
     h = test_ax.stairs([1, 2, 3])
     test_ax.set_ylim(ylim)
-    h.set_values([3, 2, 1])
-    h.set_edges(np.arange(4)+2)
+    h.set_data([3, 2, 1])
+    h.set_data(None, np.arange(4)+2)
     h.set_data([1, 2, 1], np.arange(4)/2)
     h.set_data([1, 2, 3])
     h.set_data(None, np.arange(4))
     assert np.allclose(h.get_data()[0], np.arange(1, 4))
     assert np.allclose(h.get_data()[1], np.arange(4))
-    h.set_baseline(-2)
-    assert h.get_baseline() == -2
+    h.set_data(baseline=-2)
+    assert h.get_data().baseline == -2
 
     # Ref
     ref_ax = fig_ref.add_subplot()
@@ -1913,13 +1913,13 @@ def test_stairs_invalid_mismatch():
 def test_stairs_invalid_update():
     h = plt.stairs([1, 2], [0, 1, 2])
     with pytest.raises(ValueError, match='Nan values in "edges"'):
-        h.set_edges([1, np.nan, 2])
+        h.set_data(None, [1, np.nan, 2])
 
 
 def test_stairs_invalid_update2():
     h = plt.stairs([1, 2], [0, 1, 2])
     with pytest.raises(ValueError, match='Size mismatch'):
-        h.set_edges(np.arange(5))
+        h.set_data(None, np.arange(5))
 
 
 @image_comparison(['test_stairs_options.png'], remove_text=True)
