Normalize aspect="equal" to aspect=1 in the setter.

anntzer · anntzer · commit ad8f969fae62 · 2019-12-23T23:02:40.000+01:00
This avoids having to redo the normalization later.

`aspect="equal"` is probably too widely used to be worth deprecating,
but we can also deemphasize it in the docs.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1216,18 +1216,17 @@ def set_aspect(self, aspect, adjustable=None, anchor=None, share=False):
 
         Parameters
         ----------
-        aspect : {'auto', 'equal'} or num
+        aspect : {'auto'} or num
             Possible values:
 
-            ========   ================================================
+            ========   =================================================
             value      description
-            ========   ================================================
-            'auto'     automatic; fill the position rectangle with data
-            'equal'    same scaling from data to plot units for x and y
-             num       a circle will be stretched such that the height
-                       is num times the width. aspect=1 is the same as
-                       aspect='equal'.
-            ========   ================================================
+            ========   =================================================
+            'auto'     automatic; fill the position rectangle with data.
+            num        a circle will be stretched such that the height
+                       is *num* times the width.  'equal' is a synonym
+                       for ``aspect=1``, i.e. same scaling for x and y.
+            ========   =================================================
 
         adjustable : None or {'box', 'datalim'}, optional
             If not ``None``, this defines which parameter will be adjusted to
@@ -1262,15 +1261,15 @@ def set_aspect(self, aspect, adjustable=None, anchor=None, share=False):
         matplotlib.axes.Axes.set_anchor
             defining the position in case of extra space.
         """
-        if not (cbook._str_equal(aspect, 'equal')
-                or cbook._str_equal(aspect, 'auto')):
+        if cbook._str_equal(aspect, 'equal'):
+            aspect = 1
+        if not cbook._str_equal(aspect, 'auto'):
+            if self.name == '3d':
+                raise NotImplementedError(
+                    'It is not currently possible to manually set the aspect '
+                    'on 3D axes')
             aspect = float(aspect)  # raise ValueError if necessary
 
-        if (not cbook._str_equal(aspect, 'auto')) and self.name == '3d':
-            raise NotImplementedError(
-                'It is not currently possible to manually set the aspect '
-                'on 3D axes')
-
         if share:
             axes = {*self._shared_x_axes.get_siblings(self),
                     *self._shared_y_axes.get_siblings(self)}
@@ -1532,9 +1531,6 @@ def apply_aspect(self, position=None):
             self._set_position(position, which='active')
             return
 
-        if aspect == 'equal':
-            aspect = 1
-
         fig_width, fig_height = self.get_figure().get_size_inches()
         fig_aspect = fig_height / fig_width
 
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -5435,13 +5435,11 @@ def test_square_plot():
     ax.axis('square')
     xlim, ylim = ax.get_xlim(), ax.get_ylim()
     assert np.diff(xlim) == np.diff(ylim)
-    assert ax.get_aspect() == 'equal'
+    assert ax.get_aspect() == 1
     assert_array_almost_equal(
-            ax.get_position(original=True).extents,
-            np.array((0.125, 0.1, 0.9, 0.9)))
+        ax.get_position(original=True).extents, (0.125, 0.1, 0.9, 0.9))
     assert_array_almost_equal(
-        ax.get_position(original=False).extents,
-        np.array((0.2125, 0.1, 0.8125, 0.9)))
+        ax.get_position(original=False).extents, (0.2125, 0.1, 0.8125, 0.9))
 
 
 def test_no_None():
diff --git a/lib/mpl_toolkits/axes_grid1/axes_size.py b/lib/mpl_toolkits/axes_grid1/axes_size.py
@@ -84,14 +84,8 @@ def get_size(self, renderer):
 
 def _get_axes_aspect(ax):
     aspect = ax.get_aspect()
-    # when aspec is "auto", consider it as 1.
-    if aspect in ('normal', 'auto'):
+    if aspect == "auto":
         aspect = 1.
-    elif aspect == "equal":
-        aspect = 1
-    else:
-        aspect = float(aspect)
-
     return aspect
 
 
