Remove figure-level deprecations from 3.3.

Author: QuLogic

doc/api/next_api_changes/removals/20447-ES.rst

@@ -0,0 +1,30 @@
+``figure.add_axes()`` without arguments
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Calling ``fig.add_axes()`` with no arguments will raise an error. Adding a
+free-floating axes needs a position rectangle. If you want a figure-filling
+single axes, use ``add_subplot()`` instead.
+
+All parameters of `.Figure.subplots` except *nrows* and *ncols* are now keyword-only
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This avoids typing e.g. ``subplots(1, 1, 1)`` when meaning ``subplot(1, 1, 1)``,
+but actually getting ``subplots(1, 1, sharex=1)``.
+
+``add_subplot()`` validates its inputs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+In particular, for ``add_subplot(rows, cols, index)``, all parameters must
+be integral. Previously strings and floats were accepted and converted to
+int.
+
+``SubplotSpec.get_rows_columns``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Use the ``GridSpec.nrows``, ``GridSpec.ncols``, ``SubplotSpec.rowspan``, and
+``SubplotSpec.colspan`` properties instead.
+
+``autofmt_xdate(which=None)``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Use its more explicit synonym, ``which="major"``, instead.
+
+`.pyplot.tight_layout` parameters are now keyword-only
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+All parameters of `.pyplot.tight_layout` are now keyword-only, to be consistent
+with `.Figure.tight_layout`.

lib/matplotlib/figure.py

@@ -271,11 +271,7 @@ def autofmt_xdate(
         which : {'major', 'minor', 'both'}, default: 'major'
             Selects which ticklabels to rotate.
         """
-        if which is None:
-            _api.warn_deprecated(
-                "3.3", message="Support for passing which=None to mean "
-                "which='major' is deprecated since %(since)s and will be "
-                "removed %(removal)s.")
+        _api.check_in_list(['major', 'minor', 'both'], which=which)
         allsubplots = all(hasattr(ax, 'get_subplotspec') for ax in self.axes)
         if len(self.axes) == 1:
             for label in self.axes[0].get_xticklabels(which=which):
@@ -622,12 +618,8 @@ def add_axes(self, *args, **kwargs):
         """
 
         if not len(args) and 'rect' not in kwargs:
-            _api.warn_deprecated(
-                "3.3",
-                message="Calling add_axes() without argument is "
-                "deprecated since %(since)s and will be removed %(removal)s. "
-                "You may want to use add_subplot() instead.")
-            return
+            raise TypeError(
+                "add_axes() missing 1 required positional argument: 'rect'")
         elif 'rect' in kwargs:
             if len(args):
                 raise TypeError(
@@ -795,8 +787,7 @@ def _add_axes_internal(self, ax, key):
         ax.stale_callback = _stale_figure_callback
         return ax
 
-    @_api.make_keyword_only("3.3", "sharex")
-    def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
+    def subplots(self, nrows=1, ncols=1, *, sharex=False, sharey=False,
                  squeeze=True, subplot_kw=None, gridspec_kw=None):
         """
         Add a set of subplots to this figure.

lib/matplotlib/gridspec.py

@@ -47,10 +47,10 @@ def __init__(self, nrows, ncols, height_ratios=None, width_ratios=None):
         """
         if not isinstance(nrows, Integral) or nrows <= 0:
             raise ValueError(
-                f"Number of rows must be a positive integer, not {nrows}")
+                f"Number of rows must be a positive integer, not {nrows!r}")
         if not isinstance(ncols, Integral) or ncols <= 0:
             raise ValueError(
-                f"Number of columns must be a positive integer, not {ncols}")
+                f"Number of columns must be a positive integer, not {ncols!r}")
         self._nrows, self._ncols = nrows, ncols
         self.set_height_ratios(height_ratios)
         self.set_width_ratios(width_ratios)
@@ -604,51 +604,40 @@ def _from_subplot_args(figure, args):
         - a `.SubplotSpec` -- returned as is;
         - one or three numbers -- a MATLAB-style subplot specifier.
         """
-        message = ("Passing non-integers as three-element position "
-                   "specification is deprecated since %(since)s and will be "
-                   "removed %(removal)s.")
         if len(args) == 1:
             arg, = args
             if isinstance(arg, SubplotSpec):
                 return arg
-            else:
-                if not isinstance(arg, Integral):
-                    _api.warn_deprecated("3.3", message=message)
-                    arg = str(arg)
-                try:
-                    rows, cols, num = map(int, str(arg))
-                except ValueError:
-                    raise ValueError(
-                        f"Single argument to subplot must be a three-digit "
-                        f"integer, not {arg}") from None
-                i = j = num
+            elif not isinstance(arg, Integral):
+                raise ValueError(
+                    f"Single argument to subplot must be a three-digit "
+                    f"integer, not {arg!r}")
+            try:
+                rows, cols, num = map(int, str(arg))
+            except ValueError:
+                raise ValueError(
+                    f"Single argument to subplot must be a three-digit "
+                    f"integer, not {arg!r}") from None
         elif len(args) == 3:
             rows, cols, num = args
-            if not (isinstance(rows, Integral) and isinstance(cols, Integral)):
-                _api.warn_deprecated("3.3", message=message)
-                rows, cols = map(int, [rows, cols])
-            gs = GridSpec(rows, cols, figure=figure)
-            if isinstance(num, tuple) and len(num) == 2:
-                if not all(isinstance(n, Integral) for n in num):
-                    _api.warn_deprecated("3.3", message=message)
-                    i, j = map(int, num)
-                else:
-                    i, j = num
-            else:
-                if not isinstance(num, Integral):
-                    _api.warn_deprecated("3.3", message=message)
-                    num = int(num)
-                if num < 1 or num > rows*cols:
-                    raise ValueError(
-                        f"num must be 1 <= num <= {rows*cols}, not {num}")
-                i = j = num
         else:
             raise TypeError(f"subplot() takes 1 or 3 positional arguments but "
                             f"{len(args)} were given")
 
         gs = GridSpec._check_gridspec_exists(figure, rows, cols)
         if gs is None:
             gs = GridSpec(rows, cols, figure=figure)
+        if isinstance(num, tuple) and len(num) == 2:
+            if not all(isinstance(n, Integral) for n in num):
+                raise ValueError(
+                    f"Subplot specifier tuple must contain integers, not {num}"
+                )
+            i, j = num
+        else:
+            if not isinstance(num, Integral) or num < 1 or num > rows*cols:
+                raise ValueError(
+                    f"num must be 1 <= num <= {rows*cols}, not {num!r}")
+            i = j = num
         return gs[i-1:j]
 
     # num2 is a property only to handle the case where it is None and someone
@@ -679,18 +668,6 @@ def get_geometry(self):
         rows, cols = self.get_gridspec().get_geometry()
         return rows, cols, self.num1, self.num2
 
-    @_api.deprecated("3.3", alternative="rowspan, colspan")
-    def get_rows_columns(self):
-        """
-        Return the subplot row and column numbers as a tuple
-        ``(n_rows, n_cols, row_start, row_stop, col_start, col_stop)``.
-        """
-        gridspec = self.get_gridspec()
-        nrows, ncols = gridspec.get_geometry()
-        row_start, col_start = divmod(self.num1, ncols)
-        row_stop, col_stop = divmod(self.num2, ncols)
-        return nrows, ncols, row_start, row_stop, col_start, col_stop
-
     @property
     def rowspan(self):
         """The rows spanned by this subplot, as a `range` object."""

lib/matplotlib/pyplot.py

@@ -1289,8 +1289,7 @@ def subplot(*args, **kwargs):
     return ax
 
 
-@_api.make_keyword_only("3.3", "sharex")
-def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
+def subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True,
              subplot_kw=None, gridspec_kw=None, **fig_kw):
     """
     Create a figure and a set of subplots.
@@ -1633,27 +1632,6 @@ def subplot_tool(targetfig=None):
     return SubplotTool(targetfig, tool_fig)
 
 
-# After deprecation elapses, this can be autogenerated by boilerplate.py.
-@_api.make_keyword_only("3.3", "pad")
-def tight_layout(pad=1.08, h_pad=None, w_pad=None, rect=None):
-    """
-    Adjust the padding between and around subplots.
-
-    Parameters
-    ----------
-    pad : float, default: 1.08
-        Padding between the figure edge and the edges of subplots,
-        as a fraction of the font size.
-    h_pad, w_pad : float, default: *pad*
-        Padding (height/width) between edges of adjacent subplots,
-        as a fraction of the font size.
-    rect : tuple (left, bottom, right, top), default: (0, 0, 1, 1)
-        A rectangle in normalized figure coordinates into which the whole
-        subplots area (including labels) will fit.
-    """
-    gcf().tight_layout(pad=pad, h_pad=h_pad, w_pad=w_pad, rect=rect)
-
-
 def box(on=None):
     """
     Turn the axes box on or off on the current axes.
@@ -2559,6 +2537,12 @@ def suptitle(t, **kwargs):
     return gcf().suptitle(t, **kwargs)
 
 
+# Autogenerated by boilerplate.py.  Do not edit as changes will be lost.
+@_copy_docstring_and_deprecators(Figure.tight_layout)
+def tight_layout(*, pad=1.08, h_pad=None, w_pad=None, rect=None):
+    return gcf().tight_layout(pad=pad, h_pad=h_pad, w_pad=w_pad, rect=rect)
+
+
 # Autogenerated by boilerplate.py.  Do not edit as changes will be lost.
 @_copy_docstring_and_deprecators(Figure.waitforbuttonpress)
 def waitforbuttonpress(timeout=-1):

lib/matplotlib/tests/test_figure.py

@@ -1,4 +1,3 @@
-from contextlib import nullcontext
 from datetime import datetime
 import io
 from pathlib import Path
@@ -151,8 +150,7 @@ def test_figure_legend():
 def test_gca():
     fig = plt.figure()
 
-    with pytest.warns(MatplotlibDeprecationWarning):
-        # empty call to add_axes() will throw deprecation warning
+    with pytest.raises(TypeError):
         assert fig.add_axes() is None
 
     ax0 = fig.add_axes([0, 0, 1, 1])
@@ -249,14 +247,14 @@ def test_add_subplot_invalid():
     with pytest.raises(TypeError, match='takes 1 or 3 positional arguments '
                                         'but 4 were given'):
         fig.add_subplot(1, 2, 3, 4)
-    with pytest.warns(cbook.MatplotlibDeprecationWarning,
-                      match='Passing non-integers as three-element position '
-                            'specification is deprecated'):
+    with pytest.raises(ValueError,
+                       match="Number of rows must be a positive integer, "
+                             "not '2'"):
         fig.add_subplot('2', 2, 1)
-    with pytest.warns(cbook.MatplotlibDeprecationWarning,
-                      match='Passing non-integers as three-element position '
-                            'specification is deprecated'):
-        fig.add_subplot(2.0, 2, 1)
+    with pytest.raises(ValueError,
+                       match='Number of columns must be a positive integer, '
+                             'not 2.0'):
+        fig.add_subplot(2, 2.0, 1)
     _, ax = plt.subplots()
     with pytest.raises(ValueError,
                        match='The Subplot must have been created in the '
@@ -371,7 +369,7 @@ def test_figaspect():
     assert h / w == 1
 
 
-@pytest.mark.parametrize('which', [None, 'both', 'major', 'minor'])
+@pytest.mark.parametrize('which', ['both', 'major', 'minor'])
 def test_autofmt_xdate(which):
     date = ['3 Jan 2013', '4 Jan 2013', '5 Jan 2013', '6 Jan 2013',
             '7 Jan 2013', '8 Jan 2013', '9 Jan 2013', '10 Jan 2013',
@@ -400,11 +398,9 @@ def test_autofmt_xdate(which):
             'FixedFormatter should only be used together with FixedLocator')
         ax.xaxis.set_minor_formatter(FixedFormatter(minors))
 
-    with (pytest.warns(mpl.MatplotlibDeprecationWarning) if which is None else
-          nullcontext()):
-        fig.autofmt_xdate(0.2, angle, 'right', which)
+    fig.autofmt_xdate(0.2, angle, 'right', which)
 
-    if which in ('both', 'major', None):
+    if which in ('both', 'major'):
         for label in fig.axes[0].get_xticklabels(False, 'major'):
             assert int(label.get_rotation()) == angle
 

lib/matplotlib/tests/test_subplots.py

@@ -144,17 +144,6 @@ def test_exceptions():
         plt.subplots(2, 2, sharex='blah')
     with pytest.raises(ValueError):
         plt.subplots(2, 2, sharey='blah')
-    # We filter warnings in this test which are genuine since
-    # the point of this test is to ensure that this raises.
-    with pytest.warns(UserWarning, match='.*sharex argument to subplots'), \
-         pytest.raises(ValueError):
-        plt.subplots(2, 2, -1)
-    with pytest.warns(UserWarning, match='.*sharex argument to subplots'), \
-         pytest.raises(ValueError):
-        plt.subplots(2, 2, 0)
-    with pytest.warns(UserWarning, match='.*sharex argument to subplots'), \
-         pytest.raises(ValueError):
-        plt.subplots(2, 2, 5)
 
 
 @image_comparison(['subplots_offset_text'], remove_text=False)

tools/boilerplate.py

@@ -202,6 +202,7 @@ def boilerplate_gen():
         'ginput',
         'subplots_adjust',
         'suptitle',
+        'tight_layout',
         'waitforbuttonpress',
     )