Don't check length of arguments in quiver collection and increase coverage

ericpre · ericpre · commit 9b5bc95614dc · 2024-03-28T08:17:17.000Z
diff --git a/lib/matplotlib/quiver.py b/lib/matplotlib/quiver.py
@@ -454,11 +454,10 @@ class Quiver(mcollections.PolyCollection):
     """
     Specialized PolyCollection for arrows.
 
-    The API methods are set_UVC(), set_U(), set_V() and set_C(), which
-    can be used to change the size, orientation, and color of the
-    arrows; their locations are fixed when the class is
-    instantiated.  Possibly these methods will be useful
-    in animations.
+    The API methods are set_XYUVC(), set_X(), set_Y(), set_U() and set_V(),
+    which can be used to change the size, orientation, and color of the
+    arrows; their locations are fixed when the class is instantiated.
+    Possibly these methods will be useful in animations.
 
     Much of the work in this class is done in the draw()
     method so that as much information as possible is available
@@ -512,7 +511,7 @@ def __init__(self, ax, *args,
         X, Y, U, V, C, self._nr, self._nc = _parse_args(
             *args, caller_name='quiver()'
         )
-        self.set_XYUVC(X=X, Y=Y, U=U, V=V, C=C)
+        self.set_XYUVC(X=X, Y=Y, U=U, V=V, C=C, check_shape=True)
         self._dpi_at_last_init = None
 
     def _init(self):
@@ -547,59 +546,49 @@ def X(self):
         return self.get_X()
 
     @X.setter
-    def X(self):
+    def X(self, value):
         _api.warn_deprecated("3.9", alternative="set_X")
-        return self.set_X()
+        return self.set_X(value)
 
     @property
     def Y(self):
         _api.warn_deprecated("3.9", alternative="get_Y")
         return self.get_Y()
 
     @Y.setter
-    def Y(self):
+    def Y(self, value):
         _api.warn_deprecated("3.9", alternative="set_Y")
-        return self.set_Y()
+        return self.set_Y(value)
 
     @property
     def U(self):
         _api.warn_deprecated("3.9", alternative="get_U")
         return self.get_U()
 
     @U.setter
-    def U(self):
+    def U(self, value):
         _api.warn_deprecated("3.9", alternative="set_U")
-        return self.set_U()
+        return self.set_U(value)
 
     @property
     def V(self):
         _api.warn_deprecated("3.9", alternative="get_V")
         return self.get_V()
 
     @V.setter
-    def V(self):
+    def V(self, value):
         _api.warn_deprecated("3.9", alternative="set_V")
-        return self.set_V()
-
-    @property
-    def C(self):
-        _api.warn_deprecated("3.9", alternative="get_C")
-        return self.get_C()
-
-    @C.setter
-    def C(self):
-        _api.warn_deprecated("3.9", alternative="set_C")
-        return self.set_C()
+        return self.set_V(value)
 
     @property
     def XY(self):
-        _api.warn_deprecated("3.9", alternative="get_XY")
+        _api.warn_deprecated("3.9", alternative="get_offsets")
         return self.get_offsets()
 
     @XY.setter
-    def XY(self, XY):
-        _api.warn_deprecated("3.9", alternative="set_XY")
-        self.set_offsets(offsets=XY)
+    def XY(self, value):
+        _api.warn_deprecated("3.9", alternative="set_offsets")
+        self.set_offsets(offsets=value)
 
     def set_offsets(self, offsets):
         self.set_XYUVC(X=offsets[:, 0], Y=offsets[:, 1])
@@ -621,23 +610,6 @@ def draw(self, renderer):
         super().draw(renderer)
         self.stale = False
 
-    def get_XY(self):
-        """Returns the positions. Alias for ``get_offsets``."""
-        return self.get_offsets()
-
-    def set_XY(self, XY):
-        """
-        Set positions. Alias for ``set_offsets``. If the size
-        changes and it is not compatible with ``U``, ``V`` or
-        ``C``, use ``set_XYUVC`` instead.
-
-        Parameters
-        ----------
-        X : array-like
-            The size must be compatible with ``U``, ``V`` and ``C``.
-        """
-        self.set_offsets(offsets=XY)
-
     def set_X(self, X):
         """
         Set positions in the horizontal direction.
@@ -711,9 +683,9 @@ def set_C(self, C):
 
     def get_C(self):
         """Returns the arrow colors."""
-        return self._C
+        return self.get_array()
 
-    def set_XYUVC(self, X=None, Y=None, U=None, V=None, C=None):
+    def set_XYUVC(self, X=None, Y=None, U=None, V=None, C=None, check_shape=False):
         """
         Set the positions (X, Y) and components (U, V) of the arrow vectors
         and arrow colors (C) values of the arrows.
@@ -733,6 +705,9 @@ def set_XYUVC(self, X=None, Y=None, U=None, V=None, C=None):
         C : array-like or None, optional
             The arrow colors. The default is None.
             The size must the same as the existing U, V or be one.
+        check_shape : bool
+            Whether to check if the shape of the parameters are
+            consistent. Default is False.
         """
 
         X = self.get_X() if X is None else X
@@ -752,13 +727,14 @@ def set_XYUVC(self, X=None, Y=None, U=None, V=None, C=None):
             C = ma.masked_invalid(
                 self._C if C is None else C, copy=True
             ).ravel()
-        for name, var in zip(('U', 'V', 'C'), (U, V, C)):
-            if not (var is None or var.size == N or var.size == 1):
-                raise ValueError(
-                    f'Argument {name} has a size {var.size}'
-                    f' which does not match {N},'
-                    ' the number of arrow positions'
-                )
+        if check_shape:
+            for name, var in zip(('U', 'V', 'C'), (U, V, C)):
+                if not (var is None or var.size == N or var.size == 1):
+                    raise ValueError(
+                        f'Argument {name} has a size {var.size}'
+                        f' which does not match {N},'
+                        ' the number of arrow positions'
+                    )
 
         # now shapes are validated and we can start assigning things
         mask = ma.mask_or(U.mask, V.mask, copy=False, shrink=True)
diff --git a/lib/matplotlib/quiver.pyi b/lib/matplotlib/quiver.pyi
@@ -125,8 +125,6 @@ class Quiver(mcollections.PolyCollection):
     def N(self) -> int: ...
     def get_datalim(self, transData: Transform) -> Bbox: ...
     def set_offsets(self, offsets: ArrayLike) -> None: ...
-    def set_XY(self, XY: ArrayLike) -> None: ...
-    def get_XY(self) -> ArrayLike: ...
     def set_X(self, X: ArrayLike) -> None: ...
     def get_X(self) -> ArrayLike: ...
     def set_Y(self, Y: ArrayLike) -> None: ...
@@ -143,7 +141,8 @@ class Quiver(mcollections.PolyCollection):
         Y: ArrayLike | None = ...,
         U: ArrayLike | None = ...,
         V: ArrayLike | None = ...,
-        C: ArrayLike | None = ...
+        C: ArrayLike | None = ...,
+        check_shape: bool = ...,
     ) -> None: ...
 
 class Barbs(mcollections.PolyCollection):
diff --git a/lib/matplotlib/tests/test_collections.py b/lib/matplotlib/tests/test_collections.py
@@ -389,17 +389,9 @@ def test_quiver_offsets():
 
     # new length
     L = 2
-    with pytest.raises(ValueError):
-        qc.set_X(qc.get_X()[:L])
-
-    with pytest.raises(ValueError):
-        qc.set_Y(qc.get_Y()[:L])
-
-    with pytest.raises(ValueError):
-        qc.set_offsets(qc.get_offsets()[:L])
-
-    with pytest.raises(ValueError):
-        qc.set_XYUVC(X=new_X[:L], Y=new_Y[:L])
+    qc.set_XYUVC(X=new_X[:L], Y=new_Y[:L])
+    np.testing.assert_allclose(qc.get_X(), new_X[:L])
+    np.testing.assert_allclose(qc.get_Y(), new_Y[:L])
 
     qc.set_XYUVC(X=X[:L], Y=Y[:L], U=qc.get_U()[:L], V=qc.get_V()[:L])
     np.testing.assert_allclose(qc.get_X(), X[:L])
@@ -408,23 +400,21 @@ def test_quiver_offsets():
     np.testing.assert_allclose(qc.get_V(), V.ravel()[:L])
 
 
-def test_quiver_change_UVC():
+def test_quiver_change_XYUVC():
     fig, ax = plt.subplots()
     X = np.arange(-10, 10, 1)
     Y = np.arange(-10, 10, 1)
     U, V = np.meshgrid(X, Y)
-    M = np.hypot(U, V)
-    qc = mquiver.Quiver(
-        ax, X, Y, U, V, M
-        )
+    C = np.hypot(U, V)
+    qc = mquiver.Quiver(ax, X, Y, U, V, C)
     ax.add_collection(qc)
     ax.autoscale_view()
 
     np.testing.assert_allclose(qc.get_U(), U.ravel())
     np.testing.assert_allclose(qc.get_V(), V.ravel())
-    np.testing.assert_allclose(qc.get_array(), M.ravel())
+    np.testing.assert_allclose(qc.get_C(), C.ravel())
 
-    qc.set_XYUVC(U=U/2, V=V/3)
+    qc.set(U=U/2, V=V/3)
     np.testing.assert_allclose(qc.get_U(), U.ravel() / 2)
     np.testing.assert_allclose(qc.get_V(), V.ravel() / 3)
 
@@ -434,23 +424,65 @@ def test_quiver_change_UVC():
     qc.set_V(V/6)
     np.testing.assert_allclose(qc.get_V(), V.ravel() / 6)
 
-    qc.set_C(C=M/10)
-    np.testing.assert_allclose(qc.get_array(), M.ravel() / 10)
+    qc.set_C(C/3)
+    np.testing.assert_allclose(qc.get_C(), C.ravel() / 3)
 
+    # check consistency not enable
+    qc.set_XYUVC(X=X[:2], Y=Y[:2])
     with pytest.raises(ValueError):
-        qc.set_X(X[:2])
-    with pytest.raises(ValueError):
-        qc.set_Y(Y[:2])
-    with pytest.raises(ValueError):
-        qc.set_U(U[:2])
-    with pytest.raises(ValueError):
-        qc.set_V(V[:2])
+        # setting only one of the two X, Y fails because X and Y needs
+        # to be stacked when passed to `offsets`
+        qc.set(Y=Y[:3])
 
-    qc.set_XYUVC()
+    qc.set()
     np.testing.assert_allclose(qc.get_U(), U.ravel() / 4)
     np.testing.assert_allclose(qc.get_V(), V.ravel() / 6)
 
 
+def test_quiver_deprecated_attribute():
+    fig, ax = plt.subplots()
+    X = np.arange(-10, 10, 1)
+    Y = np.arange(-10, 10, 1)
+    U, V = np.meshgrid(X, Y)
+    C = np.hypot(U, V)
+    qc = mquiver.Quiver(ax, X, Y, U, V, C)
+    ax.add_collection(qc)
+    ax.autoscale_view()
+
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        x = qc.X
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        qc.X = x * 2
+    np.testing.assert_allclose(qc.get_X(), x * 2)
+
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        y = qc.Y
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        qc.Y = y * 2
+    np.testing.assert_allclose(qc.get_Y(), y * 2)
+
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        np.testing.assert_allclose(qc.N, len(qc.get_offsets()))
+
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        u = qc.U
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        qc.U = u * 2
+    np.testing.assert_allclose(qc.get_U(), u * 2)
+
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        v = qc.V
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        qc.V = v * 2
+    np.testing.assert_allclose(qc.get_V(), v * 2)
+
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        xy = qc.XY
+    with pytest.warns(mpl.MatplotlibDeprecationWarning):
+        qc.XY = xy * 2
+    np.testing.assert_allclose(qc.get_offsets(), xy * 2)
+
+
 def test_quiver_limits():
     ax = plt.axes()
     x, y = np.arange(8), np.arange(10)
