Merge pull request #24664 from oscargus/deprecateinoffsetbox

rcomer · web-flow · commit 1d2abe7ab909 · 2022-12-09T18:14:19.000Z
Deprecate offsetbox.bbox_artist
diff --git a/doc/api/next_api_changes/deprecations/24664-OG.rst b/doc/api/next_api_changes/deprecations/24664-OG.rst
@@ -0,0 +1,5 @@
+``offsetbox.bbox_artist``
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+... is deprecated. This is just a wrapper to call `.patches.bbox_artist` if a
+flag is set in the file, so use that directly if you need the behavior.
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -40,12 +40,18 @@
 DEBUG = False
 
 
-# for debugging use
+@_api.deprecated("3.7", alternative='patches.bbox_artist')
 def bbox_artist(*args, **kwargs):
     if DEBUG:
         mbbox_artist(*args, **kwargs)
 
 
+# for debugging use
+def _bbox_artist(*args, **kwargs):
+    if DEBUG:
+        mbbox_artist(*args, **kwargs)
+
+
 def _get_packed_offsets(widths, total, sep, mode="fixed"):
     r"""
     Pack boxes specified by their *widths*.
@@ -364,7 +370,7 @@ def draw(self, renderer):
         for c, (ox, oy) in zip(self.get_visible_children(), offsets):
             c.set_offset((px + ox, py + oy))
             c.draw(renderer)
-        bbox_artist(self, renderer, fill=False, props=dict(pad=0.))
+        _bbox_artist(self, renderer, fill=False, props=dict(pad=0.))
         self.stale = False
 
 
@@ -672,7 +678,7 @@ def draw(self, renderer):
                 c.set_clip_path(tpath)
             c.draw(renderer)
 
-        bbox_artist(self, renderer, fill=False, props=dict(pad=0.))
+        _bbox_artist(self, renderer, fill=False, props=dict(pad=0.))
         self.stale = False
 
 
@@ -794,7 +800,7 @@ def get_extent(self, renderer):
     def draw(self, renderer):
         # docstring inherited
         self._text.draw(renderer)
-        bbox_artist(self, renderer, fill=False, props=dict(pad=0.))
+        _bbox_artist(self, renderer, fill=False, props=dict(pad=0.))
         self.stale = False
 
 
@@ -877,7 +883,7 @@ def draw(self, renderer):
         # docstring inherited
         for c in self._children:
             c.draw(renderer)
-        bbox_artist(self, renderer, fill=False, props=dict(pad=0.))
+        _bbox_artist(self, renderer, fill=False, props=dict(pad=0.))
         self.stale = False
 
 
