Also change the kwarg names on semilogx/y and loglog.

anntzer · anntzer · commit dee07b263250 · 2020-02-04T08:27:22.000+01:00
diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/next_api_changes/deprecations.rst
@@ -174,12 +174,14 @@ variables is deprecated.  Additional fonts may be registered using
 ~~~~~~~~~~~~~~~~~~~~~
 This module is deprecated.
 
-Signature of `.LogScale` and `.SymmetricalLogScale`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-These classes used to take keyword arguments that depends on the axis
-orientation ("basex" vs "basey", "nonposx" vs "nonposy"); these parameter
-names are now deprecated in favor of "base", "nonpos", etc.  This deprecation
-also affects e.g. ``ax.set_yscale("log", basey=...)`` which must now be
-spelled ``ax.set_yscale("log", base=...)``.  The only place where "basex", etc.
-remain in use is in the helper functions `~.Axes.loglog`, `~.Axes.semilogx`,
-and `~.Axes.semilogy` (because `~.Axes.loglog` takes both "basex" and "basey").
+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", "nonposx" vs "nonposy"); these parameter names
+are now deprecated in favor of "base", "nonpos", etc.  This deprecation also
+affects e.g. ``ax.set_yscale("log", basey=...)`` which must now be spelled
+``ax.set_yscale("log", base=...)``.
+
+To use *different* bases for the x-axis and y-axei of a `~.Axes.loglog` plot,
+use e.g. ``ax.set_xscale("log", base=10); ax.set_yscale("log", base=2)``.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1766,24 +1766,25 @@ def loglog(self, *args, **kwargs):
         both the x-axis and the y-axis to log scaling. All of the concepts and
         parameters of plot can be used here as well.
 
-        The additional parameters *basex/y*, *subsx/y* and *nonposx/y* control
-        the x/y-axis properties. They are just forwarded to `.Axes.set_xscale`
-        and `.Axes.set_yscale`.
+        The additional parameters *base*, *subs* and *nonpos* control the
+        x/y-axis properties. They are just forwarded to `.Axes.set_xscale` and
+        `.Axes.set_yscale`. To use different properties on the x-axis and the
+        y-axis, use e.g.
+        ``ax.set_xscale("log", base=10); ax.set_yscale("log", base=2)``.
 
         Parameters
         ----------
-        basex, basey : float, default: 10
-            Base of the x/y logarithm.
+        base : float, default: 10
+            Base of the logarithm.
 
-        subsx, subsy : sequence, optional
-            The location of the minor x/y ticks. If *None*, reasonable
-            locations are automatically chosen depending on the number of
-            decades in the plot.
-            See `.Axes.set_xscale` / `.Axes.set_yscale` for details.
+        subs : sequence, optional
+            The location of the minor ticks. If *None*, reasonable locations
+            are automatically chosen depending on the number of decades in the
+            plot. See `.Axes.set_xscale`/`.Axes.set_yscale` for details.
 
-        nonposx, nonposy : {'mask', 'clip'}, default: 'mask'
-            Non-positive values in x or y can be masked as invalid, or clipped
-            to a very small positive number.
+        nonpos : {'mask', 'clip'}, default: 'mask'
+            Non-positive values can be masked as invalid, or clipped to a very
+            small positive number.
 
         Returns
         -------
@@ -1795,13 +1796,14 @@ def loglog(self, *args, **kwargs):
         **kwargs
             All parameters supported by `.plot`.
         """
-        dx = {k[:-1]: kwargs.pop(k) for k in ['basex', 'subsx', 'nonposx']
-              if k in kwargs}
+        dx = {k: v for k, v in kwargs.items()
+              if k in ['base', 'subs', 'nonpos', 'basex', 'subsx', 'nonposx']}
         self.set_xscale('log', **dx)
-        dy = {k[:-1]: kwargs.pop(k) for k in ['basey', 'subsy', 'nonposy']
-              if k in kwargs}
+        dy = {k: v for k, v in kwargs.items()
+              if k in ['base', 'subs', 'nonpos', 'basey', 'subsy', 'nonposy']}
         self.set_yscale('log', **dy)
-        return self.plot(*args, **kwargs)
+        return self.plot(
+            *args, **{k: v for k, v in kwargs.items() if k not in {*dx, *dy}})
 
     # @_preprocess_data() # let 'plot' do the unpacking..
     @docstring.dedent_interpd
@@ -1818,20 +1820,20 @@ def semilogx(self, *args, **kwargs):
         the x-axis to log scaling. All of the concepts and parameters of plot
         can be used here as well.
 
-        The additional parameters *basex*, *subsx* and *nonposx* control the
+        The additional parameters *base*, *subs*, and *nonpos* control the
         x-axis properties. They are just forwarded to `.Axes.set_xscale`.
 
         Parameters
         ----------
-        basex : float, default: 10
+        base : float, default: 10
             Base of the x logarithm.
 
-        subsx : array-like, optional
+        subs : array-like, optional
             The location of the minor xticks. If *None*, reasonable locations
             are automatically chosen depending on the number of decades in the
             plot. See `.Axes.set_xscale` for details.
 
-        nonposx : {'mask', 'clip'}, default: 'mask'
+        nonpos : {'mask', 'clip'}, default: 'mask'
             Non-positive values in x can be masked as invalid, or clipped to a
             very small positive number.
 
@@ -1845,10 +1847,11 @@ def semilogx(self, *args, **kwargs):
         **kwargs
             All parameters supported by `.plot`.
         """
-        d = {k[:-1]: kwargs.pop(k) for k in ['basex', 'subsx', 'nonposx']
-             if k in kwargs}
+        d = {k: v for k, v in kwargs.items()
+             if k in ['base', 'subs', 'nonpos', 'basex', 'subsx', 'nonposx']}
         self.set_xscale('log', **d)
-        return self.plot(*args, **kwargs)
+        return self.plot(
+            *args, **{k: v for k, v in kwargs.items() if k not in d})
 
     # @_preprocess_data() # let 'plot' do the unpacking..
     @docstring.dedent_interpd
@@ -1865,20 +1868,20 @@ def semilogy(self, *args, **kwargs):
         the y-axis to log scaling. All of the concepts and parameters of plot
         can be used here as well.
 
-        The additional parameters *basey*, *subsy* and *nonposy* control the
+        The additional parameters *base*, *subs*, and *nonpos* control the
         y-axis properties. They are just forwarded to `.Axes.set_yscale`.
 
         Parameters
         ----------
-        basey : float, default: 10
+        base : float, default: 10
             Base of the y logarithm.
 
-        subsy : array-like, optional
+        subs : array-like, optional
             The location of the minor yticks. If *None*, reasonable locations
             are automatically chosen depending on the number of decades in the
             plot. See `.Axes.set_yscale` for details.
 
-        nonposy : {'mask', 'clip'}, default: 'mask'
+        nonpos : {'mask', 'clip'}, default: 'mask'
             Non-positive values in y can be masked as invalid, or clipped to a
             very small positive number.
 
@@ -1892,10 +1895,11 @@ def semilogy(self, *args, **kwargs):
         **kwargs
             All parameters supported by `.plot`.
         """
-        d = {k[:-1]: kwargs.pop(k) for k in ['basey', 'subsy', 'nonposy']
-             if k in kwargs}
+        d = {k: v for k, v in kwargs.items()
+             if k in ['base', 'subs', 'nonpos', 'basey', 'subsy', 'nonposy']}
         self.set_yscale('log', **d)
-        return self.plot(*args, **kwargs)
+        return self.plot(
+            *args, **{k: v for k, v in kwargs.items() if k not in d})
 
     @_preprocess_data(replace_names=["x"], label_namer="x")
     def acorr(self, x, **kwargs):
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -1,16 +1,19 @@
 from collections import namedtuple
-from itertools import product
+import datetime
+from decimal import Decimal
 import io
+from itertools import product
 import platform
-
-import datetime
+try:
+    from contextlib import nullcontext
+except ImportError:
+    from contextlib import ExitStack as nullcontext  # Py3.6.
 
 import dateutil.tz as dutz
 
 import numpy as np
 from numpy import ma
 from cycler import cycler
-from decimal import Decimal
 import pytest
 
 import matplotlib
@@ -5661,21 +5664,38 @@ 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():
-    fig, ax = plt.subplots(3, 3)
+def test_loglog_nonpos(new_api):
+    fig, axs = plt.subplots(3, 3)
     x = np.arange(1, 11)
     y = x**3
     y[7] = -3.
     x[4] = -10
-    for nn, mcx in enumerate(['mask', 'clip', '']):
-        for mm, mcy in enumerate(['mask', 'clip', '']):
+    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, nonpos=mcx)
+                else:
+                    ax.loglog(x, y**3, lw=2)
+            else:
+                ax.loglog(x, y**3, lw=2)
+                if mcx:
+                    ax.set_xscale("log", nonpos=mcx)
+                if mcy:
+                    ax.set_yscale("log", nonpos=mcy)
+        else:
             kws = {}
             if mcx:
                 kws['nonposx'] = mcx
             if mcy:
                 kws['nonposy'] = mcy
-            ax[mm, nn].loglog(x, y**3, lw=2, **kws)
+            with (pytest.warns(MatplotlibDeprecationWarning) if kws
+                  else nullcontext()):
+                ax.loglog(x, y**3, lw=2, **kws)
 
 
 @pytest.mark.style('default')
