Use setters in constructor, add docstring to setters and improve tests

ericpre · ericpre · commit ed91d6edeb41 · 2024-01-27T13:08:00.000Z
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -1745,9 +1745,9 @@ def __init__(self, widths, heights, angles, *, units='points', **kwargs):
             Forwarded to `Collection`.
         """
         super().__init__(**kwargs)
-        self._widths = 0.5 * np.asarray(widths).ravel()
-        self._heights = 0.5 * np.asarray(heights).ravel()
-        self._angles = np.deg2rad(angles).ravel()
+        self._set_widths(widths)
+        self._set_heights(heights)
+        self._set_angles(angles)
         self._units = units
         self.set_transform(transforms.IdentityTransform())
         self._transforms = np.empty((0, 3, 3))
@@ -1795,16 +1795,28 @@ def _set_transforms(self):
             m[:2, 2:] = 0
             self.set_transform(_affine(m))
 
-    def set_widths(self, widths):
+    def _set_widths(self, widths):
         self._widths = 0.5 * np.asarray(widths).ravel()
-        self.stale = True
 
-    def set_angles(self, angles):
+    def _set_heights(self, heights):
+        self._heights = 0.5 * np.asarray(heights).ravel()
+
+    def _set_angles(self, angles):
         self._angles = np.deg2rad(angles).ravel()
+
+    def set_widths(self, widths):
+        """Set the lengths of the first axes (e.g., major axis lengths)."""
+        self._set_widths(widths)
         self.stale = True
 
     def set_heights(self, heights):
-        self._heights = 0.5 * np.asarray(heights).ravel()
+        """Set the lengths of second axes.."""
+        self._set_heights(heights)
+        self.stale = True
+
+    def set_angles(self, angles):
+        """Set the angles of the first axes, degrees CCW from the x-axis."""
+        self._set_angles(angles)
         self.stale = True
 
     @artist.allow_rasterization
diff --git a/lib/matplotlib/tests/test_collections.py b/lib/matplotlib/tests/test_collections.py
@@ -428,6 +428,10 @@ def test_EllipseCollection_setter():
         offset_transform=ax.transData,
         )
 
+    assert_array_almost_equal(ec._widths, np.array(widths).ravel() * 0.5)
+    assert_array_almost_equal(ec._heights, np.array(heights).ravel() * 0.5)
+    assert_array_almost_equal(ec._angles, np.deg2rad(angles).ravel())
+
     ax.add_collection(ec)
     ax.set_xlim(-2, 12)
     ax.set_ylim(-2, 12)
@@ -438,6 +442,10 @@ def test_EllipseCollection_setter():
 
     ec.set(widths=new_widths, heights=new_heights, angles=new_angles)
 
+    assert_array_almost_equal(ec._widths, np.array(new_widths).ravel() * 0.5)
+    assert_array_almost_equal(ec._heights, np.array(new_heights).ravel() * 0.5)
+    assert_array_almost_equal(ec._angles, np.deg2rad(new_angles).ravel())
+
 
 @image_comparison(['polycollection_close.png'], remove_text=True, style='mpl20')
 def test_polycollection_close():
