Deprecate Quiver.color in favor of Quiver.get_facecolor().

anntzer · anntzer · commit 3c0559ca4274 · 2019-02-12T19:21:55.000+01:00
See changelog for rationale.
diff --git a/doc/api/next_api_changes/2019-02-14-AL.rst b/doc/api/next_api_changes/2019-02-14-AL.rst
@@ -0,0 +1,7 @@
+Deprecations
+````````````
+
+The ``.color`` attribute of `Quiver` objects is deprecated.  Instead, use (as
+for any `Collection`) the ``get_facecolor`` method.  Note that setting to the
+``.color`` attribute did not update the quiver artist, whereas calling
+``set_facecolor`` does.
diff --git a/lib/matplotlib/quiver.py b/lib/matplotlib/quiver.py
@@ -455,7 +455,6 @@ def __init__(self, ax, *args,
         self.scale_units = scale_units
         self.angles = angles
         self.width = width
-        self.color = color
 
         if pivot.lower() == 'mid':
             pivot = 'middle'
@@ -466,7 +465,7 @@ def __init__(self, ax, *args,
                       keys=self._PIVOT_VALS, inp=pivot))
 
         self.transform = kw.pop('transform', ax.transData)
-        kw.setdefault('facecolors', self.color)
+        kw.setdefault('facecolors', color)
         kw.setdefault('linewidths', (0,))
         mcollections.PolyCollection.__init__(self, [], offsets=self.XY,
                                              transOffset=self.transform,
@@ -495,6 +494,11 @@ def on_dpi_change(fig):
         self._cid = self.ax.figure.callbacks.connect('dpi_changed',
                                                      on_dpi_change)
 
+    @cbook.deprecated("3.1", alternative="get_facecolor()")
+    @property
+    def color(self):
+        return self.get_facecolor()
+
     def remove(self):
         """
         Overload the remove method
