Cleanup axes_size.

anntzer · anntzer · commit a118e75029e9 · 2020-03-09T10:37:23.000+01:00
Rewrite MaxWidth, MaxHeight to reuse the MaxExtent logic; fix MaxExtent
to work even if artist_list is empty.
Docstrings cleanups.
Move some typechecks (`float(...)` -&gt; check_isinstance) to the class
constructors (so that all calls benefit from it).
diff --git a/lib/mpl_toolkits/axes_grid1/axes_size.py b/lib/mpl_toolkits/axes_grid1/axes_size.py
@@ -18,16 +18,13 @@ class (or others) to determine the size of each axes. The unit
 class _Base:
 
     def __rmul__(self, other):
-        float(other)  # just to check if number if given
         return Fraction(other, self)
 
     def __add__(self, other):
         if isinstance(other, _Base):
             return Add(self, other)
         else:
-            float(other)
-            other = Fixed(other)
-            return Add(self, other)
+            return Add(self, Fixed(other))
 
 
 class Add(_Base):
@@ -55,7 +52,9 @@ class Fixed(_Base):
     """
     Simple fixed size with absolute part = *fixed_size* and relative part = 0.
     """
+
     def __init__(self, fixed_size):
+        cbook._check_isinstance(Number, fixed_size=fixed_size)
         self.fixed_size = fixed_size
 
     def get_size(self, renderer):
@@ -93,6 +92,7 @@ class AxesX(_Base):
     Scaled size whose relative part corresponds to the data width
     of the *axes* multiplied by the *aspect*.
     """
+
     def __init__(self, axes, aspect=1., ref_ax=None):
         self._axes = axes
         self._aspect = aspect
@@ -118,6 +118,7 @@ class AxesY(_Base):
     Scaled size whose relative part corresponds to the data height
     of the *axes* multiplied by the *aspect*.
     """
+
     def __init__(self, axes, aspect=1., ref_ax=None):
         self._axes = axes
         self._aspect = aspect
@@ -141,12 +142,12 @@ def get_size(self, renderer):
 
 class MaxExtent(_Base):
     """
-    Size whose absolute part is the largest width (or height) of
-    the given *artist_list*.
+    Size whose absolute part is either the largest width or the largest height
+    of the given *artist_list*.
     """
+
     def __init__(self, artist_list, w_or_h):
         self._artist_list = artist_list
-
         cbook._check_in_list(["width", "height"], w_or_h=w_or_h)
         self._w_or_h = w_or_h
 
@@ -155,74 +156,40 @@ def add_artist(self, a):
 
     def get_size(self, renderer):
         rel_size = 0.
-        w_list, h_list = [], []
-        for a in self._artist_list:
-            bb = a.get_window_extent(renderer)
-            w_list.append(bb.width)
-            h_list.append(bb.height)
-        dpi = a.get_figure().get_dpi()
-        if self._w_or_h == "width":
-            abs_size = max(w_list)/dpi
-        elif self._w_or_h == "height":
-            abs_size = max(h_list)/dpi
-
+        extent_list = [
+            getattr(a.get_window_extent(renderer), self._w_or_h) / a.figure.dpi
+            for a in self._artist_list]
+        abs_size = max(extent_list, default=0)
         return rel_size, abs_size
 
 
-class MaxWidth(_Base):
+class MaxWidth(MaxExtent):
     """
-    Size whose absolute part is the largest width of
-    the given *artist_list*.
+    Size whose absolute part is the largest width of the given *artist_list*.
     """
-    def __init__(self, artist_list):
-        self._artist_list = artist_list
-
-    def add_artist(self, a):
-        self._artist_list.append(a)
 
-    def get_size(self, renderer):
-        rel_size = 0.
-        w_list = []
-        for a in self._artist_list:
-            bb = a.get_window_extent(renderer)
-            w_list.append(bb.width)
-        dpi = a.get_figure().get_dpi()
-        abs_size = max(w_list)/dpi
-
-        return rel_size, abs_size
+    def __init__(self, artist_list):
+        super().__init__(artist_list, "width")
 
 
-class MaxHeight(_Base):
+class MaxHeight(MaxExtent):
     """
-    Size whose absolute part is the largest height of
-    the given *artist_list*.
+    Size whose absolute part is the largest height of the given *artist_list*.
     """
-    def __init__(self, artist_list):
-        self._artist_list = artist_list
-
-    def add_artist(self, a):
-        self._artist_list.append(a)
-
-    def get_size(self, renderer):
-        rel_size = 0.
-        h_list = []
-        for a in self._artist_list:
-            bb = a.get_window_extent(renderer)
-            h_list.append(bb.height)
-        dpi = a.get_figure().get_dpi()
-        abs_size = max(h_list)/dpi
 
-        return rel_size, abs_size
+    def __init__(self, artist_list):
+        super().__init__(artist_list, "height")
 
 
 class Fraction(_Base):
     """
     An instance whose size is a *fraction* of the *ref_size*.
 
     >>> s = Fraction(0.3, AxesX(ax))
-
     """
+
     def __init__(self, fraction, ref_size):
+        cbook._check_isinstance(Number, fraction=fraction)
         self._fraction_ref = ref_size
         self._fraction = fraction
 
@@ -241,6 +208,7 @@ class Padded(_Base):
     Return a instance where the absolute part of *size* is
     increase by the amount of *pad*.
     """
+
     def __init__(self, size, pad):
         self._size = size
         self._pad = pad
@@ -256,18 +224,16 @@ def from_any(size, fraction_ref=None):
     """
     Creates Fixed unit when the first argument is a float, or a
     Fraction unit if that is a string that ends with %. The second
-    argument is only meaningful when Fraction unit is created.::
-
-      >>> a = Size.from_any(1.2) # => Size.Fixed(1.2)
-      >>> Size.from_any("50%", a) # => Size.Fraction(0.5, a)
+    argument is only meaningful when Fraction unit is created.
 
+    >>> a = Size.from_any(1.2) # => Size.Fixed(1.2)
+    >>> Size.from_any("50%", a) # => Size.Fraction(0.5, a)
     """
     if isinstance(size, Number):
         return Fixed(size)
     elif isinstance(size, str):
         if size[-1] == "%":
             return Fraction(float(size[:-1]) / 100, fraction_ref)
-
     raise ValueError("Unknown format")
 
 
