Inherit OffsetBox.{get_offset,get_window_extent}.

anntzer · anntzer · commit 78d087f03bf5 · 2022-02-13T16:09:27.000+01:00
By making the parameters of OffsetBox.get_offset optional (which matches
the fact that there are currently subclasses for which get_offset does
*not* take any parameters), and adjusting OffsetBox.get_window_extent to
use get_extent (which is typically redefined in subclasses) instead of
get_extent_offsets (which is not), we can inherit the implementation of
OffsetBox.get_window_extent across most subclasses instead of having to
copy-paste it again and again.
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -272,23 +272,15 @@ def offset(width, height, xdescent, ydescent, renderer) \
         self._offset = xy
         self.stale = True
 
-    def get_offset(self, width, height, xdescent, ydescent, renderer):
+    def get_offset(self, *args, **kwargs):
         """
-        Return the offset as a tuple (x, y).
-
-        The extent parameters have to be provided to handle the case where the
-        offset is dynamically determined by a callable (see
-        `~.OffsetBox.set_offset`).
-
-        Parameters
-        ----------
-        width, height, xdescent, ydescent
-            Extent parameters.
-        renderer : `.RendererBase` subclass
+        Return the (x, y) offset.
 
+        Parameters must be passed if the offset is dynamically determined by a
+        callable (see `~.OffsetBox.set_offset`), and are forwarded to that
+        callable.
         """
-        return (self._offset(width, height, xdescent, ydescent, renderer)
-                if callable(self._offset)
+        return (self._offset(*args, **kwargs) if callable(self._offset)
                 else self._offset)
 
     def set_width(self, width):
@@ -347,7 +339,7 @@ def get_extent(self, renderer):
 
     def get_window_extent(self, renderer):
         # docstring inherited
-        w, h, xd, yd, offsets = self.get_extent_offsets(renderer)
+        w, h, xd, yd = self.get_extent(renderer)
         px, py = self.get_offset(w, h, xd, yd, renderer)
         return mtransforms.Bbox.from_bounds(px - xd, py - yd, w, h)
 
@@ -622,21 +614,9 @@ def set_offset(self, xy):
         xy : (float, float)
             The (x, y) coordinates of the offset in display units.
         """
-        self._offset = xy
         self.offset_transform.clear()
         self.offset_transform.translate(xy[0], xy[1])
-        self.stale = True
-
-    def get_offset(self):
-        """Return offset of the container."""
-        return self._offset
-
-    def get_window_extent(self, renderer):
-        # docstring inherited
-        w, h, xd, yd = self.get_extent(renderer)
-        ox, oy = self.get_offset()  # w, h, xd, yd)
-
-        return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
+        super().set_offset(xy)
 
     def get_extent(self, renderer):
         """Return width, height, xdescent, ydescent of box."""
@@ -782,20 +762,9 @@ def set_offset(self, xy):
         xy : (float, float)
             The (x, y) coordinates of the offset in display units.
         """
-        self._offset = xy
         self.offset_transform.clear()
         self.offset_transform.translate(xy[0], xy[1])
-        self.stale = True
-
-    def get_offset(self):
-        """Return offset of the container."""
-        return self._offset
-
-    def get_window_extent(self, renderer):
-        # docstring inherited
-        w, h, xd, yd = self.get_extent(renderer)
-        ox, oy = self.get_offset()
-        return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
+        super().set_offset(xy)
 
     def get_extent(self, renderer):
         _, h_, d_ = renderer.get_text_width_height_descent(
@@ -883,20 +852,9 @@ def set_offset(self, xy):
         xy : (float, float)
             The (x, y) coordinates of the offset in display units.
         """
-        self._offset = xy
         self.offset_transform.clear()
         self.offset_transform.translate(xy[0], xy[1])
-        self.stale = True
-
-    def get_offset(self):
-        """Return offset of the container."""
-        return self._offset
-
-    def get_window_extent(self, renderer):
-        # docstring inherited
-        w, h, xd, yd = self.get_extent(renderer)
-        ox, oy = self.get_offset()  # w, h, xd, yd)
-        return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
+        super().set_offset(xy)
 
     def get_extent(self, renderer):
         # clear the offset transforms
@@ -1078,9 +1036,7 @@ def set_bbox_to_anchor(self, bbox, transform=None):
     def get_window_extent(self, renderer):
         # docstring inherited
         self._update_offset_func(renderer)
-        w, h, xd, yd = self.get_extent(renderer)
-        ox, oy = self.get_offset(w, h, xd, yd, renderer)
-        return Bbox.from_bounds(ox - xd, oy - yd, w, h)
+        return super().get_window_extent(renderer)
 
     def _update_offset_func(self, renderer, fontsize=None):
         """
@@ -1231,10 +1187,6 @@ def set_zoom(self, zoom):
     def get_zoom(self):
         return self._zoom
 
-    def get_offset(self):
-        """Return offset of the container."""
-        return self._offset
-
     def get_children(self):
         return [self.image]
 
