Make _side_spaces instances know if they have a legend

Author: has2k1

plotnine/_mpl/layout_manager/_layout_items.py

@@ -723,7 +723,7 @@ def set_position(
     if legends.right:
         y = rel_position(
             legends.right.justification,
-            spaces.r._legend_height,
+            spaces.r.legend_height,
             params.bottom,
             params.top,
         )
@@ -733,7 +733,7 @@ def set_position(
     if legends.left:
         y = rel_position(
             legends.left.justification,
-            spaces.l._legend_height,
+            spaces.l.legend_height,
             params.bottom,
             params.top,
         )
@@ -743,7 +743,7 @@ def set_position(
     if legends.top:
         x = rel_position(
             legends.top.justification,
-            spaces.t._legend_width,
+            spaces.t.legend_width,
             params.left,
             params.right,
         )
@@ -753,7 +753,7 @@ def set_position(
     if legends.bottom:
         x = rel_position(
             legends.bottom.justification,
-            spaces.b._legend_width,
+            spaces.b.legend_width,
             params.left,
             params.right,
         )

plotnine/_mpl/layout_manager/_spaces.py

@@ -26,6 +26,7 @@
 
     from plotnine import ggplot
     from plotnine._mpl.gridspec import p9GridSpec
+    from plotnine.iapi import outside_legend
     from plotnine.typing import Side
 
 # Note
@@ -79,7 +80,7 @@ class _side_spaces(ABC):
     """
 
     def __post_init__(self):
-        self.side = cast("Side", self.__class__.__name__[:-7])
+        self.side: Side = cast("Side", self.__class__.__name__[:-7])
         """
         Side of the panel(s) that this class applies to
         """
@@ -136,17 +137,21 @@ def _legend_size(self) -> tuple[float, float]:
         values e.g. 0.2, instead of just left, right, top,  bottom &
         center.
         """
-        return (0, 0)
+        if not self.has_legend:
+            return (0, 0)
+
+        ol: outside_legend = getattr(self.items.legends, self.side)
+        return self.items.calc.size(ol.box)
 
     @cached_property
-    def _legend_width(self) -> float:
+    def legend_width(self) -> float:
         """
         Return width of legend in figure coordinates
         """
         return self._legend_size[0]
 
     @cached_property
-    def _legend_height(self) -> float:
+    def legend_height(self) -> float:
         """
         Return height of legend in figure coordinates
         """
@@ -220,6 +225,17 @@ def has_tag(self) -> bool:
             "plot_tag_position"
         )
 
+    @property
+    def has_legend(self) -> bool:
+        """
+        Return True if the space/margin to this side of the panel has a legend
+
+        If it does, then it will be included in the layout
+        """
+        if not self.items.legends:
+            return False
+        return hasattr(self.items.legends, self.side)
+
 
 @dataclass
 class left_spaces(_side_spaces):
@@ -257,7 +273,7 @@ def _calculate(self):
             self.plot_tag_margin_right = m.r
 
         if items.legends and items.legends.left:
-            self.legend = self._legend_width
+            self.legend = self.legend_width
             self.legend_box_spacing = theme.getp("legend_box_spacing")
 
         if items.axis_title_y:
@@ -283,13 +299,6 @@ def _calculate(self):
         if adjustment > 0:
             self.plot_margin += adjustment
 
-    @cached_property
-    def _legend_size(self) -> tuple[float, float]:
-        if not (self.items.legends and self.items.legends.left):
-            return (0, 0)
-
-        return self.items.calc.size(self.items.legends.left.box)
-
     @property
     def offset(self) -> float:
         """
@@ -370,7 +379,7 @@ def _calculate(self):
             self.plot_tag_margin_left = m.l
 
         if items.legends and items.legends.right:
-            self.legend = self._legend_width
+            self.legend = self.legend_width
             self.legend_box_spacing = theme.getp("legend_box_spacing")
 
         self.strip_text_y_width_right = items.strip_text_y_width("right")
@@ -383,13 +392,6 @@ def _calculate(self):
         if adjustment > 0:
             self.plot_margin += adjustment
 
-    @cached_property
-    def _legend_size(self) -> tuple[float, float]:
-        if not (self.items.legends and self.items.legends.right):
-            return (0, 0)
-
-        return self.items.calc.size(self.items.legends.right.box)
-
     @property
     def offset(self):
         """
@@ -490,7 +492,7 @@ def _calculate(self):
             self.plot_subtitle_margin_bottom = m.b * F
 
         if items.legends and items.legends.top:
-            self.legend = self._legend_height
+            self.legend = self.legend_height
             self.legend_box_spacing = theme.getp("legend_box_spacing") * F
 
         self.strip_text_x_height_top = items.strip_text_x_height("top")
@@ -503,13 +505,6 @@ def _calculate(self):
         if adjustment > 0:
             self.plot_margin += adjustment
 
-    @cached_property
-    def _legend_size(self) -> tuple[float, float]:
-        if not (self.items.legends and self.items.legends.top):
-            return (0, 0)
-
-        return self.items.calc.size(self.items.legends.top.box)
-
     @property
     def offset(self) -> float:
         """
@@ -610,7 +605,7 @@ def _calculate(self):
             self.plot_caption_margin_top = m.t * F
 
         if items.legends and items.legends.bottom:
-            self.legend = self._legend_height
+            self.legend = self.legend_height
             self.legend_box_spacing = theme.getp("legend_box_spacing") * F
 
         if items.axis_title_x:
@@ -635,13 +630,6 @@ def _calculate(self):
         if adjustment > 0:
             self.plot_margin += adjustment
 
-    @cached_property
-    def _legend_size(self) -> tuple[float, float]:
-        if not (self.items.legends and self.items.legends.bottom):
-            return (0, 0)
-
-        return self.items.calc.size(self.items.legends.bottom.box)
-
     @property
     def offset(self) -> float:
         """