Deprecate accepting arbitrary parameters in some get_window_extent() methods

timhoffm · timhoffm · commit 22bb5278f7b8 · 2022-01-06T02:03:08.000+01:00
diff --git a/doc/api/next_api_changes/deprecations/22123-TH.rst b/doc/api/next_api_changes/deprecations/22123-TH.rst
@@ -0,0 +1,4 @@
+``Axes.get_window_extent`` and ``Figure.get_window_extent`` won't accept parameters other than *renderer* anymore
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This aligns the API with the general `.Artist.get_window_extent` API.
+All parameters were ignored anyway.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -734,6 +734,16 @@ def get_window_extent(self, *args, **kwargs):
         matplotlib.axis.Axis.get_tightbbox
         matplotlib.spines.Spine.get_window_extent
         """
+        kwargs.pop('renderer', None)
+        if len(args) > 1 or kwargs:
+            # when this expires coerce the API to
+            # get_window_extent(renderer=None) in line with
+            # Artist.get_window_extent
+            _api.warn_deprecated(
+                "3.6",
+                message="Passing any argument except 'renderer' to "
+                        "Axes.get_window_extent is deprecated in Matplotlib "
+                        "%(since)s and will be removed %(removal)s")
         return self.bbox
 
     def _init_axis(self):
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -318,6 +318,16 @@ def contains(self, mouseevent):
 
     def get_window_extent(self, *args, **kwargs):
         # docstring inherited
+        kwargs.pop('renderer', None)
+        if len(args) > 1 or kwargs:
+            # when this expires coerce the API to
+            # get_window_extent(renderer=None) in line with
+            # Artist.get_window_extent
+            _api.warn_deprecated(
+                "3.6",
+                message="Passing any argument except 'renderer' to "
+                        "Figure.get_window_extent is deprecated in Matplotlib "
+                        "%(since)s and will be removed %(removal)s")
         return self.bbox
 
     def _suplabels(self, t, info, **kwargs):
