Merge pull request matplotlib#24889 from anntzer/ke

Harmonize exceptions for unknown keyword arguments.

Author: QuLogic

doc/api/next_api_changes/behavior/24889-AL.rst

@@ -0,0 +1,3 @@
+``AxesImage.set_extent`` now raises ``TypeError`` for unknown keyword arguments
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+It previously raised a `ValueError`.

lib/matplotlib/_api/__init__.py

@@ -342,6 +342,23 @@ def nargs_error(name, takes, given):
                      f"{given} were given")
 
 
+def kwarg_error(name, kw):
+    """
+    Generate a TypeError to be raised by function calls with wrong kwarg.
+
+    Parameters
+    ----------
+    name : str
+        The name of the calling function.
+    kw : str or Iterable[str]
+        Either the invalid keyword argument name, or an iterable yielding
+        invalid keyword arguments (e.g., a ``kwargs`` dict).
+    """
+    if not isinstance(kw, str):
+        kw = next(iter(kw))
+    return TypeError(f"{name}() got an unexpected keyword argument '{kw}'")
+
+
 def recursive_subclasses(cls):
     """Yield *cls* and direct and indirect subclasses of *cls*."""
     yield cls

lib/matplotlib/axes/_axes.py

@@ -7787,8 +7787,7 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
         extent = xmin, xmax, freqs[0], freqs[-1]
 
         if 'origin' in kwargs:
-            raise TypeError("specgram() got an unexpected keyword argument "
-                            "'origin'")
+            raise _api.kwarg_error("specgram", "origin")
 
         im = self.imshow(Z, cmap, extent=extent, vmin=vmin, vmax=vmax,
                          origin='upper', **kwargs)
@@ -7886,8 +7885,7 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
                 kwargs['cmap'] = mcolors.ListedColormap(['w', 'k'],
                                                         name='binary')
             if 'interpolation' in kwargs:
-                raise TypeError(
-                    "spy() got an unexpected keyword argument 'interpolation'")
+                raise _api.kwarg_error("spy", "interpolation")
             if 'norm' not in kwargs:
                 kwargs['norm'] = mcolors.NoNorm()
             ret = self.imshow(mask, interpolation='nearest',
@@ -7912,8 +7910,7 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
             if markersize is None:
                 markersize = 10
             if 'linestyle' in kwargs:
-                raise TypeError(
-                    "spy() got an unexpected keyword argument 'linestyle'")
+                raise _api.kwarg_error("spy", "linestyle")
             ret = mlines.Line2D(
                 x, y, linestyle='None', marker=marker, markersize=markersize,
                 **kwargs)

lib/matplotlib/axes/_base.py

@@ -243,8 +243,7 @@ def __call__(self, *args, data=None, **kwargs):
 
         for pos_only in "xy":
             if pos_only in kwargs:
-                raise TypeError("{} got an unexpected keyword argument {!r}"
-                                .format(self.command, pos_only))
+                raise _api.kwarg_error(self.command, pos_only)
 
         if not args:
             return
@@ -2188,8 +2187,7 @@ def axis(self, arg=None, /, *, emit=True, **kwargs):
             self.set_xlim(xmin, xmax, emit=emit, auto=xauto)
             self.set_ylim(ymin, ymax, emit=emit, auto=yauto)
         if kwargs:
-            raise TypeError(f"axis() got an unexpected keyword argument "
-                            f"'{next(iter(kwargs))}'")
+            raise _api.kwarg_error("axis", kwargs)
         return (*self.get_xlim(), *self.get_ylim())
 
     def get_legend(self):

lib/matplotlib/figure.py

@@ -716,8 +716,7 @@ def add_subplot(self, *args, **kwargs):
         if 'figure' in kwargs:
             # Axes itself allows for a 'figure' kwarg, but since we want to
             # bind the created Axes to self, it is not allowed here.
-            raise TypeError(
-                "add_subplot() got an unexpected keyword argument 'figure'")
+            raise _api.kwarg_error("add_subplot", "figure")
 
         if (len(args) == 1
                 and isinstance(args[0], mpl.axes._base._AxesBase)

lib/matplotlib/image.py

@@ -978,11 +978,8 @@ def set_extent(self, extent, **kwargs):
             [("x", [extent[0], extent[1]]),
              ("y", [extent[2], extent[3]])],
             kwargs)
-        if len(kwargs):
-            raise ValueError(
-                "set_extent did not consume all of the kwargs passed." +
-                f"{list(kwargs)!r} were unused"
-            )
+        if kwargs:
+            raise _api.kwarg_error("set_extent", kwargs)
         xmin = self.axes._validate_converted_limits(
             xmin, self.convert_xunits)
         xmax = self.axes._validate_converted_limits(

lib/matplotlib/tests/test_axes.py

@@ -8248,7 +8248,7 @@ def test_automatic_legend():
 
 
 def test_plot_errors():
-    with pytest.raises(TypeError, match="plot got an unexpected keyword"):
+    with pytest.raises(TypeError, match=r"plot\(\) got an unexpected keyword"):
         plt.plot([1, 2, 3], x=1)
     with pytest.raises(ValueError, match=r"plot\(\) with multiple groups"):
         plt.plot([1, 2, 3], [1, 2, 3], [2, 3, 4], [2, 3, 4], label=['1', '2'])
@@ -8423,8 +8423,7 @@ def test_extent_units():
     axs[1, 1].xaxis.set_major_formatter(mdates.DateFormatter('%d'))
     axs[1, 1].set(xlabel='Day of Jan 2020')
 
-    with pytest.raises(ValueError,
-                       match="set_extent did not consume all of the kwargs"):
+    with pytest.raises(TypeError, match=r"set_extent\(\) got an unexpected"):
         im.set_extent([2, 12, date_first, date_last], clip=False)
 
 

lib/matplotlib/ticker.py

@@ -2069,9 +2069,7 @@ def set_params(self, **kwargs):
         if 'integer' in kwargs:
             self._integer = kwargs.pop('integer')
         if kwargs:
-            key, _ = kwargs.popitem()
-            raise TypeError(
-                f"set_params() got an unexpected keyword argument '{key}'")
+            raise _api.kwarg_error("set_params", kwargs)
 
     def _raw_ticks(self, vmin, vmax):
         """