Remove scale internals deprecated in 3.3.

Author: QuLogic

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

@@ -1,3 +1,25 @@
+``{,Symmetrical}LogScale.{,Inverted}LogTransform``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``LogScale.LogTransform``, ``LogScale.InvertedLogTransform``,
+``SymmetricalScale.SymmetricalTransform`` and
+``SymmetricalScale.InvertedSymmetricalTransform`` have been removed.  Directly
+access the transform classes from the `matplotlib.scale` module.
+
+log/symlog scale base, ticks, and nonpos specification
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+`~.Axes.semilogx`, `~.Axes.semilogy`, `~.Axes.loglog`, `.LogScale`, and
+`.SymmetricalLogScale` used to take keyword arguments that depends on the axis
+orientation ("basex" vs "basey", "subsx" vs "subsy", "nonposx" vs "nonposy");
+these parameter names have been removed in favor of "base", "subs",
+"nonpositive".  This removal also affects e.g. ``ax.set_yscale("log",
+basey=...)`` which must now be spelled ``ax.set_yscale("log", base=...)``.
+
+The change from "nonpos" to "nonpositive" also affects `~.scale.LogTransform`,
+`~.scale.InvertedLogTransform`, `~.scale.SymmetricalLogTransform`, etc.
+
+To use *different* bases for the x-axis and y-axis of a `~.Axes.loglog` plot,
+use e.g. ``ax.set_xscale("log", base=10); ax.set_yscale("log", base=2)``.
+
 Implicit initialization of ``Tick`` attributes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

lib/matplotlib/scale.py

@@ -202,7 +202,6 @@ def set_default_locators_and_formatters(self, axis):
 class LogTransform(Transform):
     input_dims = output_dims = 1
 
-    @_api.rename_parameter("3.3", "nonpos", "nonpositive")
     def __init__(self, base, nonpositive='clip'):
         super().__init__()
         if base <= 0 or base == 1:
@@ -264,17 +263,7 @@ class LogScale(ScaleBase):
     """
     name = 'log'
 
-    @_api.deprecated("3.3", alternative="scale.LogTransform")
-    @property
-    def LogTransform(self):
-        return LogTransform
-
-    @_api.deprecated("3.3", alternative="scale.InvertedLogTransform")
-    @property
-    def InvertedLogTransform(self):
-        return InvertedLogTransform
-
-    def __init__(self, axis, **kwargs):
+    def __init__(self, axis, *, base=10, subs=None, nonpositive="clip"):
         """
         Parameters
         ----------
@@ -290,18 +279,6 @@ def __init__(self, axis, **kwargs):
             in a log10 scale, ``[2, 3, 4, 5, 6, 7, 8, 9]`` will place 8
             logarithmically spaced minor ticks between each major tick.
         """
-        # After the deprecation, the whole (outer) __init__ can be replaced by
-        # def __init__(self, axis, *, base=10, subs=None, nonpositive="clip")
-        # The following is to emit the right warnings depending on the axis
-        # used, as the *old* kwarg names depended on the axis.
-        axis_name = getattr(axis, "axis_name", "x")
-        @_api.rename_parameter("3.3", f"base{axis_name}", "base")
-        @_api.rename_parameter("3.3", f"subs{axis_name}", "subs")
-        @_api.rename_parameter("3.3", f"nonpos{axis_name}", "nonpositive")
-        def __init__(*, base=10, subs=None, nonpositive="clip"):
-            return base, subs, nonpositive
-
-        base, subs, nonpositive = __init__(**kwargs)
         self._transform = LogTransform(base, nonpositive)
         self.subs = subs
 
@@ -460,28 +437,7 @@ class SymmetricalLogScale(ScaleBase):
     """
     name = 'symlog'
 
-    @_api.deprecated("3.3", alternative="scale.SymmetricalLogTransform")
-    @property
-    def SymmetricalLogTransform(self):
-        return SymmetricalLogTransform
-
-    @_api.deprecated(
-        "3.3", alternative="scale.InvertedSymmetricalLogTransform")
-    @property
-    def InvertedSymmetricalLogTransform(self):
-        return InvertedSymmetricalLogTransform
-
-    def __init__(self, axis, **kwargs):
-        axis_name = getattr(axis, "axis_name", "x")
-        # See explanation in LogScale.__init__.
-        @_api.rename_parameter("3.3", f"base{axis_name}", "base")
-        @_api.rename_parameter("3.3", f"linthresh{axis_name}", "linthresh")
-        @_api.rename_parameter("3.3", f"subs{axis_name}", "subs")
-        @_api.rename_parameter("3.3", f"linscale{axis_name}", "linscale")
-        def __init__(*, base=10, linthresh=2, subs=None, linscale=1):
-            return base, linthresh, subs, linscale
-
-        base, linthresh, subs, linscale = __init__(**kwargs)
+    def __init__(self, axis, *, base=10, linthresh=2, subs=None, linscale=1):
         self._transform = SymmetricalLogTransform(base, linthresh, linscale)
         self.subs = subs
 
@@ -505,7 +461,6 @@ def get_transform(self):
 class LogitTransform(Transform):
     input_dims = output_dims = 1
 
-    @_api.rename_parameter("3.3", "nonpos", "nonpositive")
     def __init__(self, nonpositive='mask'):
         super().__init__()
         _api.check_in_list(['mask', 'clip'], nonpositive=nonpositive)
@@ -531,7 +486,6 @@ def __str__(self):
 class LogisticTransform(Transform):
     input_dims = output_dims = 1
 
-    @_api.rename_parameter("3.3", "nonpos", "nonpositive")
     def __init__(self, nonpositive='mask'):
         super().__init__()
         self._nonpositive = nonpositive
@@ -556,7 +510,6 @@ class LogitScale(ScaleBase):
     """
     name = 'logit'
 
-    @_api.rename_parameter("3.3", "nonpos", "nonpositive")
     def __init__(self, axis, nonpositive='mask', *,
                  one_half=r"\frac{1}{2}", use_overline=False):
         r"""

lib/matplotlib/tests/test_axes.py

@@ -5577,38 +5577,26 @@ def test_loglog():
     ax.tick_params(length=15, width=2, which='minor')
 
 
-@pytest.mark.parametrize("new_api", [False, True])
 @image_comparison(["test_loglog_nonpos.png"], remove_text=True, style='mpl20')
-def test_loglog_nonpos(new_api):
+def test_loglog_nonpos():
     fig, axs = plt.subplots(3, 3)
     x = np.arange(1, 11)
     y = x**3
     y[7] = -3.
     x[4] = -10
-    for (i, j), ax in np.ndenumerate(axs):
-        mcx = ['mask', 'clip', ''][j]
-        mcy = ['mask', 'clip', ''][i]
-        if new_api:
-            if mcx == mcy:
-                if mcx:
-                    ax.loglog(x, y**3, lw=2, nonpositive=mcx)
-                else:
-                    ax.loglog(x, y**3, lw=2)
+    for (mcy, mcx), ax in zip(product(['mask', 'clip', ''], repeat=2),
+                              axs.flat):
+        if mcx == mcy:
+            if mcx:
+                ax.loglog(x, y**3, lw=2, nonpositive=mcx)
             else:
                 ax.loglog(x, y**3, lw=2)
-                if mcx:
-                    ax.set_xscale("log", nonpositive=mcx)
-                if mcy:
-                    ax.set_yscale("log", nonpositive=mcy)
         else:
-            kws = {}
+            ax.loglog(x, y**3, lw=2)
             if mcx:
-                kws['nonposx'] = mcx
+                ax.set_xscale("log", nonpositive=mcx)
             if mcy:
-                kws['nonposy'] = mcy
-            with (pytest.warns(MatplotlibDeprecationWarning) if kws
-                  else nullcontext()):
-                ax.loglog(x, y**3, lw=2, **kws)
+                ax.set_yscale("log", nonpositive=mcy)
 
 
 @pytest.mark.style('default')