refactor(facet): pass scales into compute_layout

Author: has2k1

plotnine/facets/facet.py

@@ -137,18 +137,6 @@ def __radd__(self, other: ggplot) -> ggplot:
         other.facet.environment = other.environment
         return other
 
-    def axis_positions(self, scales: Scales) -> tuple[str, str]:
-        """
-        The sides the x and y axes occupy, as `(x_side, y_side)`
-        """
-        # `scales.add_missing` adds the default x/y scales *after* the layout
-        # is computed (see ggplot._build), so scales.x / scales.y can still be
-        # None here. A missing scale takes the default side of the position
-        # scale that will replace it: "bottom" for x, "left" for y.
-        x_side = "bottom" if scales.x is None else scales.x.position
-        y_side = "left" if scales.y is None else scales.y.position
-        return x_side, y_side
-
     def setup(self, plot: ggplot):
         self.plot = plot
         self.layout = plot.layout
@@ -238,7 +226,7 @@ def map(self, data: pd.DataFrame, layout: pd.DataFrame) -> pd.DataFrame:
     def compute_layout(
         self,
         data: list[pd.DataFrame],
-        axis_positions: tuple[str, str],
+        scales: Scales,
     ) -> pd.DataFrame:
         """
         Compute layout
@@ -247,8 +235,8 @@ def compute_layout(
         ----------
         data :
             Dataframe for a each layer
-        axis_positions :
-            The sides the x and y axes occupy, as `(x_side, y_side)`
+        scales :
+            The plot's scales
         """
         msg = "{} should implement this method."
         raise NotImplementedError(msg.format(self.__class__.__name__))

plotnine/facets/facet_grid.py

@@ -24,6 +24,8 @@
     from plotnine.iapi import layout_details
     from plotnine.typing import FacetSpaceRatios
 
+    from ..scales.scales import Scales
+
 
 class facet_grid(facet):
     """
@@ -168,7 +170,7 @@ def _make_gridspec(self):
     def compute_layout(
         self,
         data: list[pd.DataFrame],
-        axis_positions: tuple[str, str],
+        scales: Scales,
     ) -> pd.DataFrame:
         if not self.rows and not self.cols:
             self.nrow, self.ncol = 1, 1
@@ -219,7 +221,7 @@ def compute_layout(
         # Relax constraints, if necessary
         layout["SCALE_X"] = layout["COL"] if self.free["x"] else 1
         layout["SCALE_Y"] = layout["ROW"] if self.free["y"] else 1
-        x_side, y_side = axis_positions
+        x_side, y_side = scales.axis_positions
         if x_side == "top":
             layout["AXIS_X"] = layout["ROW"] == layout["ROW"].min()
         else:

plotnine/facets/facet_null.py

@@ -7,6 +7,8 @@
 if typing.TYPE_CHECKING:
     import pandas as pd
 
+    from ..scales.scales import Scales
+
 
 class facet_null(facet):
     """
@@ -31,6 +33,6 @@ def map(self, data: pd.DataFrame, layout: pd.DataFrame) -> pd.DataFrame:
     def compute_layout(
         self,
         data: list[pd.DataFrame],
-        axis_positions: tuple[str, str],
+        scales: Scales,
     ) -> pd.DataFrame:
         return layout_null()

plotnine/facets/facet_wrap.py

@@ -25,6 +25,8 @@
 
     from plotnine.iapi import layout_details
 
+    from ..scales.scales import Scales
+
 
 class facet_wrap(facet):
     """
@@ -93,7 +95,7 @@ def __init__(
     def compute_layout(
         self,
         data: list[pd.DataFrame],
-        axis_positions: tuple[str, str],
+        scales: Scales,
     ) -> pd.DataFrame:
         if not self.vars:
             self.nrow, self.ncol = 1, 1
@@ -136,7 +138,7 @@ def compute_layout(
         # Figure out where axes should go.
         # The row/column of each panel that shows the axis, on the side the
         # axis sits (default: bottom-most row, left-most column)
-        x_side, y_side = axis_positions
+        x_side, y_side = scales.axis_positions
         if x_side == "top":
             x_idx = [df["ROW"].idxmin() for _, df in layout.groupby("COL")]
         else:

plotnine/facets/layout.py

@@ -74,8 +74,7 @@ def setup(self, layers: Layers, plot: ggplot):
 
         # Generate panel layout
         data = self.facet.setup_data(data)
-        axis_positions = self.facet.axis_positions(plot.scales)
-        self.layout = self.facet.compute_layout(data, axis_positions)
+        self.layout = self.facet.compute_layout(data, plot.scales)
         self.layout = self.coord.setup_layout(self.layout)
         self.check_layout()