Merge pull request matplotlib#20447 from QuLogic/remove-figax-deprecations

Remove Figure/Axes/Axis deprecations from 3.3

Author: tacaswell

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

@@ -0,0 +1,58 @@
+``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`.
+
+Parameters *norm* and *vmin*/*vmax* may not be used simultaneously
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Passing parameters *norm* and *vmin*/*vmax* simultaneously to functions using
+colormapping such as ``scatter()`` and ``imshow()`` is no longer supported.
+Instead of ``norm=LogNorm(), vmin=min_val, vmax=max_val`` pass
+``norm=LogNorm(min_val, max_val)``. *vmin* and *vmax* should only be used
+without setting *norm*.
+
+`.Axes.annotate` and `.pyplot.annotate` parameter name changed
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The parameter *s* to `.Axes.annotate` and  `.pyplot.annotate` has previously
+been renamed to *text*, matching `.Annotation`. The old parameter name is no
+longer supported.
+
+*orientation* of ``eventplot()`` and `.EventCollection`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Setting the *orientation* of an ``eventplot()`` or `.EventCollection` to "none"
+or None is no longer supported; set it to "horizontal" instead.  Moreover, the two
+orientations ("horizontal" and "vertical") are now case-sensitive.
+
+``ContourSet.ax``, ``Quiver.ax``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+These attributes have been removed in favor of ``ContourSet.axes`` and
+``Quiver.axes``, for consistency with other artists.
+
+*fontdict* and *minor* parameters of `.Axes.set_xticklabels` / `.Axes.set_yticklabels` are now keyword-only
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/api/prev_api_changes/api_changes_3.3.0/deprecations.rst

@@ -93,7 +93,7 @@ Parameters *norm* and *vmin*/*vmax* should not be used simultaneously
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Passing parameters *norm* and *vmin*/*vmax* simultaneously to functions using
 colormapping such as ``scatter()`` and ``imshow()`` is deprecated.
-Inestead of ``norm=LogNorm(), vmin=min_val, vmax=max_val`` pass
+Instead of ``norm=LogNorm(), vmin=min_val, vmax=max_val`` pass
 ``norm=LogNorm(min_val, max_val)``. *vmin* and *vmax* should only be used
 without setting *norm*.
 

lib/matplotlib/axes/_axes.py

@@ -661,7 +661,6 @@ def text(self, x, y, s, fontdict=None, **kwargs):
         self._add_text(t)
         return t
 
-    @_api.rename_parameter("3.3", "s", "text")
     @docstring.dedent_interpd
     def annotate(self, text, xy, *args, **kwargs):
         a = mtext.Annotation(text, xy, *args, **kwargs)
@@ -1367,10 +1366,9 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
                 minline = (lineoffsets - linelengths).min()
                 maxline = (lineoffsets + linelengths).max()
 
-                if (orientation is not None and
-                        orientation.lower() == "vertical"):
+                if orientation == "vertical":
                     corners = (minline, minpos), (maxline, maxpos)
-                else:  # "horizontal", None or "none" (see EventCollection)
+                else:  # "horizontal"
                     corners = (minpos, minline), (maxpos, maxline)
                 self.update_datalim(corners)
                 self._request_autoscale_view()
@@ -4399,7 +4397,7 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
             *vmin* and *vmax* are used in conjunction with the default norm to
             map the color array *c* to the colormap *cmap*. If None, the
             respective min and max of the color array is used.
-            It is deprecated to use *vmin*/*vmax* when *norm* is given.
+            It is an error to use *vmin*/*vmax* when *norm* is given.
 
         alpha : float, default: None
             The alpha blending value, between 0 (transparent) and 1 (opaque).
@@ -4690,7 +4688,7 @@ def hexbin(self, x, y, C=None, gridsize=100, bins=None,
             automatically chosen by the `.Normalize` instance (defaults to
             the respective min/max values of the bins in case of the default
             linear scaling).
-            It is deprecated to use *vmin*/*vmax* when *norm* is given.
+            It is an error to use *vmin*/*vmax* when *norm* is given.
 
         alpha : float between 0 and 1, optional
             The alpha blending value, between 0 (transparent) and 1 (opaque).
@@ -5487,7 +5485,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
             When using scalar data and no explicit *norm*, *vmin* and *vmax*
             define the data range that the colormap covers. By default,
             the colormap covers the complete value range of the supplied
-            data. It is deprecated to use *vmin*/*vmax* when *norm* is given.
+            data. It is an error to use *vmin*/*vmax* when *norm* is given.
             When using RGB(A) data, parameters *vmin*/*vmax* are ignored.
 
         origin : {'upper', 'lower'}, default: :rc:`image.origin`
@@ -5809,7 +5807,7 @@ def pcolor(self, *args, shading=None, alpha=None, norm=None, cmap=None,
             automatically chosen by the `.Normalize` instance (defaults to
             the respective min/max values of *C* in case of the default linear
             scaling).
-            It is deprecated to use *vmin*/*vmax* when *norm* is given.
+            It is an error to use *vmin*/*vmax* when *norm* is given.
 
         edgecolors : {'none', None, 'face', color, color sequence}, optional
             The color of the edges. Defaults to 'none'. Possible values:
@@ -6039,7 +6037,7 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
             automatically chosen by the `.Normalize` instance (defaults to
             the respective min/max values of *C* in case of the default linear
             scaling).
-            It is deprecated to use *vmin*/*vmax* when *norm* is given.
+            It is an error to use *vmin*/*vmax* when *norm* is given.
 
         edgecolors : {'none', None, 'face', color, color sequence}, optional
             The color of the edges. Defaults to 'none'. Possible values:
@@ -6290,7 +6288,7 @@ def pcolorfast(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
             automatically chosen by the `.Normalize` instance (defaults to
             the respective min/max values of *C* in case of the default linear
             scaling).
-            It is deprecated to use *vmin*/*vmax* when *norm* is given.
+            It is an error to use *vmin*/*vmax* when *norm* is given.
 
         alpha : float, default: None
             The alpha blending value, between 0 (transparent) and 1 (opaque).

lib/matplotlib/axis.py

@@ -1287,8 +1287,7 @@ def get_minorticklocs(self):
                 if ~np.isclose(tr_loc, tr_major_locs, atol=tol, rtol=0).any()]
         return minor_locs
 
-    @_api.make_keyword_only("3.3", "minor")
-    def get_ticklocs(self, minor=False):
+    def get_ticklocs(self, *, minor=False):
         """Return this Axis' tick locations in data coordinates."""
         return self.get_minorticklocs() if minor else self.get_majorticklocs()
 
@@ -1755,8 +1754,7 @@ def set_ticklabels(self, ticklabels, *, minor=False, **kwargs):
 
     # Wrapper around set_ticklabels used to generate Axes.set_x/ytickabels; can
     # go away once the API of Axes.set_x/yticklabels becomes consistent.
-    @_api.make_keyword_only("3.3", "fontdict")
-    def _set_ticklabels(self, labels, fontdict=None, minor=False, **kwargs):
+    def _set_ticklabels(self, labels, *, fontdict=None, minor=False, **kwargs):
         """
         Set this Axis' labels with list of string labels.
 

lib/matplotlib/cm.py

@@ -278,12 +278,10 @@ def _scale_norm(self, norm, vmin, vmax):
         if vmin is not None or vmax is not None:
             self.set_clim(vmin, vmax)
             if norm is not None:
-                _api.warn_deprecated(
-                    "3.3",
-                    message="Passing parameters norm and vmin/vmax "
-                            "simultaneously is deprecated since %(since)s and "
-                            "will become an error %(removal)s. Please pass "
-                            "vmin/vmax directly to the norm when creating it.")
+                raise ValueError(
+                    "Passing parameters norm and vmin/vmax simultaneously is "
+                    "not supported. Please pass vmin/vmax directly to the "
+                    "norm when creating it.")
 
         # always resolve the autoscaling so we have concrete limits
         # rather than deferring to draw time.

lib/matplotlib/collections.py

@@ -1634,32 +1634,17 @@ def switch_orientation(self):
         self._is_horizontal = not self.is_horizontal()
         self.stale = True
 
-    def set_orientation(self, orientation=None):
+    def set_orientation(self, orientation):
         """
         Set the orientation of the event line.
 
         Parameters
         ----------
         orientation : {'horizontal', 'vertical'}
         """
-        try:
-            is_horizontal = _api.check_getitem(
-                {"horizontal": True, "vertical": False},
-                orientation=orientation)
-        except ValueError:
-            if (orientation is None or orientation.lower() == "none"
-                    or orientation.lower() == "horizontal"):
-                is_horizontal = True
-            elif orientation.lower() == "vertical":
-                is_horizontal = False
-            else:
-                raise
-            normalized = "horizontal" if is_horizontal else "vertical"
-            _api.warn_deprecated(
-                "3.3", message="Support for setting the orientation of "
-                f"EventCollection to {orientation!r} is deprecated since "
-                f"%(since)s and will be removed %(removal)s; please set it to "
-                f"{normalized!r} instead.")
+        is_horizontal = _api.check_getitem(
+            {"horizontal": True, "vertical": False},
+            orientation=orientation)
         if is_horizontal == self.is_horizontal():
             return
         self.switch_orientation()

lib/matplotlib/contour.py

@@ -720,8 +720,6 @@ class ContourSet(cm.ScalarMappable, ContourLabeler):
     %(contour_set_attributes)s
     """
 
-    ax = _api.deprecated("3.3")(property(lambda self: self.axes))
-
     def __init__(self, ax, *args,
                  levels=None, filled=False, linewidths=None, linestyles=None,
                  hatches=(None,), alpha=None, origin=None, extent=None,

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."""