Use one TextJustifier class

Author: has2k1

plotnine/_mpl/layout_manager/_composition_layout_items.py

@@ -7,7 +7,6 @@
 
 from plotnine._mpl.utils import (
     ArtistGeometry,
-    JustifyBoundaries,
     TextJustifier,
 )
 
@@ -64,7 +63,17 @@ def _move_artists(self, spaces: CompositionSideSpaces):
         plot_title_position = theme.getp("plot_title_position", "panel")
         plot_caption_position = theme.getp("plot_caption_position", "panel")
         plot_footer_position = theme.getp("plot_footer_position", "plot")
-        justify = CompositionTextJustifier(spaces)
+        justify = TextJustifier.from_boundaries(
+            spaces.cmp.figure,
+            plot_left=spaces.plot_left,
+            plot_right=spaces.plot_right,
+            plot_bottom=spaces.plot_bottom,
+            plot_top=spaces.plot_top,
+            panel_left=spaces.panel_left,
+            panel_right=spaces.panel_right,
+            panel_bottom=spaces.panel_bottom,
+            panel_top=spaces.panel_top,
+        )
 
         if self.plot_title:
             ha = theme.getp(("plot_title", "ha"))
@@ -120,22 +129,3 @@ def _resize_plot_footer_line(self, spaces: CompositionSideSpaces):
         y1 = y2 = spaces.b.offset + spaces.b.footer_height
         self.plot_footer_line.set_xdata([x1, x2])
         self.plot_footer_line.set_ydata([y1, y2])
-
-
-class CompositionTextJustifier(TextJustifier):
-    """
-    Justify Text about a composition or it's panels
-    """
-
-    def __init__(self, spaces: CompositionSideSpaces):
-        boundaries = JustifyBoundaries(
-            plot_left=spaces.plot_left,
-            plot_right=spaces.plot_right,
-            plot_bottom=spaces.plot_bottom,
-            plot_top=spaces.plot_top,
-            panel_left=spaces.panel_left,
-            panel_right=spaces.panel_right,
-            panel_bottom=spaces.panel_bottom,
-            panel_top=spaces.panel_top,
-        )
-        super().__init__(spaces.cmp.figure, boundaries)

plotnine/_mpl/layout_manager/_plot_layout_items.py

@@ -10,7 +10,6 @@
 
 from ..utils import (
     ArtistGeometry,
-    JustifyBoundaries,
     TextJustifier,
     get_subplotspecs,
     rel_position,
@@ -354,7 +353,17 @@ def _move_artists(self, spaces: PlotSideSpaces):
         plot_title_position = theme.getp("plot_title_position", "panel")
         plot_caption_position = theme.getp("plot_caption_position", "panel")
         plot_footer_position = theme.getp("plot_footer_position", "plot")
-        justify = PlotTextJustifier(spaces)
+        justify = TextJustifier.from_boundaries(
+            spaces.plot.figure,
+            plot_left=spaces.l.plot_left,
+            plot_right=spaces.r.plot_right,
+            plot_bottom=spaces.b.plot_bottom,
+            plot_top=spaces.t.plot_top,
+            panel_left=spaces.l.panel_left,
+            panel_right=spaces.r.panel_right,
+            panel_bottom=spaces.b.panel_bottom,
+            panel_top=spaces.t.panel_top,
+        )
 
         if self.plot_tag:
             set_plot_tag_position(self.plot_tag, spaces)
@@ -407,7 +416,7 @@ def _move_artists(self, spaces: PlotSideSpaces):
         self._strip_text_x_background_equal_heights()
         self._strip_text_y_background_equal_widths()
 
-    def _adjust_axis_text_x(self, justify: PlotTextJustifier):
+    def _adjust_axis_text_x(self, justify: TextJustifier):
         """
         Adjust x-axis text, justifying vertically as necessary
         """
@@ -438,7 +447,7 @@ def to_vertical_axis_dimensions(value: float, ax: Axes) -> float:
                     text, va, -axis_text_row_height, 0, height=height
                 )
 
-    def _adjust_axis_text_y(self, justify: PlotTextJustifier):
+    def _adjust_axis_text_y(self, justify: TextJustifier):
         """
         Adjust x-axis text, justifying horizontally as necessary
         """
@@ -556,25 +565,6 @@ def _text_is_visible(text: Text) -> bool:
     return text.get_visible() and text._text  # type: ignore
 
 
-class PlotTextJustifier(TextJustifier):
-    """
-    Justify Text about a plot or it's panels
-    """
-
-    def __init__(self, spaces: PlotSideSpaces):
-        boundaries = JustifyBoundaries(
-            plot_left=spaces.l.plot_left,
-            plot_right=spaces.r.plot_right,
-            plot_bottom=spaces.b.plot_bottom,
-            plot_top=spaces.t.plot_top,
-            panel_left=spaces.l.panel_left,
-            panel_right=spaces.r.panel_right,
-            panel_bottom=spaces.b.panel_bottom,
-            panel_top=spaces.t.panel_top,
-        )
-        super().__init__(spaces.plot.figure, boundaries)
-
-
 def set_legends_position(legends: legend_artists, spaces: PlotSideSpaces):
     """
     Place legend on the figure and justify is a required
@@ -752,7 +742,17 @@ def set_plot_tag_position_in_margin(tag: Text, spaces: PlotSideSpaces):
         tag.set_y(y)
         tag.set_verticalalignment("bottom")
 
-    justify = PlotTextJustifier(spaces)
+    justify = TextJustifier.from_boundaries(
+        spaces.plot.figure,
+        plot_left=spaces.l.plot_left,
+        plot_right=spaces.r.plot_right,
+        plot_bottom=spaces.b.plot_bottom,
+        plot_top=spaces.t.plot_top,
+        panel_left=spaces.l.panel_left,
+        panel_right=spaces.r.panel_right,
+        panel_bottom=spaces.b.panel_bottom,
+        panel_top=spaces.t.panel_top,
+    )
     if position in ("left", "right"):
         justify.vertically_along_plot(tag, va)
     elif position in ("top", "bottom"):

plotnine/_mpl/utils.py

@@ -304,6 +304,35 @@ def __init__(self, figure: Figure, boundaries: JustifyBoundaries):
         self.geometry = ArtistGeometry(figure)
         self.boundaries = boundaries
 
+    @classmethod
+    def from_boundaries(
+        cls,
+        figure: Figure,
+        *,
+        plot_left: float,
+        plot_right: float,
+        plot_bottom: float,
+        plot_top: float,
+        panel_left: float,
+        panel_right: float,
+        panel_bottom: float,
+        panel_top: float,
+    ) -> TextJustifier:
+        """
+        Create a TextJustifier from boundary coordinates
+        """
+        boundaries = JustifyBoundaries(
+            plot_left=plot_left,
+            plot_right=plot_right,
+            plot_bottom=plot_bottom,
+            plot_top=plot_top,
+            panel_left=panel_left,
+            panel_right=panel_right,
+            panel_bottom=panel_bottom,
+            panel_top=panel_top,
+        )
+        return cls(figure, boundaries)
+
     def horizontally(
         self,
         text: Text,