API: Use self.params in geom.draw_layer & geom.draw_panel

Author: has2k1

doc/changelog.qmd

@@ -22,6 +22,9 @@ title: Changelog
 - The `stat` class methods `stat.compute_layer`, `stat.compute_panel` and `stat.compute_group` are now instance methods and they no longer accept
   `**params` arguments. Access to the parameters is through `self.params`.
 
+- The `geom` class methods `geom.draw_layer` and `geom.draw_panel` do no longer accept `**param` arguments. Access to the parameters is through `self.params`.
+
+- Method `geom.draw_group` now accepts the `params` argument as a dictionary and not `**params`.
 
 
 ### New Features

plotnine/geoms/annotation_logticks.py

@@ -46,17 +46,15 @@ class _geom_logticks(geom_rug):
     }
     draw_legend = staticmethod(geom_path.draw_legend)
 
-    def draw_layer(
-        self, data: pd.DataFrame, layout: Layout, coord: coord, **params: Any
-    ):
+    def draw_layer(self, data: pd.DataFrame, layout: Layout, coord: coord):
         """
         Draw ticks on every panel
         """
         for pid in layout.layout["PANEL"]:
             ploc = pid - 1
             panel_params = layout.panel_params[ploc]
             ax = layout.axs[ploc]
-            self.draw_panel(data, panel_params, coord, ax, **params)
+            self.draw_panel(data, panel_params, coord, ax)
 
     @staticmethod
     def _check_log_scale(
@@ -184,8 +182,8 @@ def draw_panel(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
     ):
+        params = self.params
         # Any passed data is ignored, the relevant data is created
         sides = params["sides"]
         lengths = params["lengths"]
@@ -203,9 +201,8 @@ def _draw(
         ):
             for position, length in zip(tick_positions, lengths):
                 data = pd.DataFrame({axis: position, **_aesthetics})
-                geom.draw_group(
-                    data, panel_params, coord, ax, length=length, **params
-                )
+                params["length"] = length
+                geom.draw_group(data, panel_params, coord, ax, params)
 
         if isinstance(coord, coord_flip):
             tick_range_x = panel_params.y.range

plotnine/geoms/annotation_stripes.py

@@ -96,25 +96,23 @@ class _geom_stripes(geom):
     }
     draw_legend = staticmethod(geom_polygon.draw_legend)
 
-    def draw_layer(
-        self, data: pd.DataFrame, layout: Layout, coord: coord, **params: Any
-    ):
+    def draw_layer(self, data: pd.DataFrame, layout: Layout, coord: coord):
         """
         Draw stripes on every panel
         """
         for pid in layout.layout["PANEL"]:
             ploc = pid - 1
             panel_params = layout.panel_params[ploc]
             ax = layout.axs[ploc]
-            self.draw_group(data, panel_params, coord, ax, **params)
+            self.draw_group(data, panel_params, coord, ax, self.params)
 
     @staticmethod
     def draw_group(
         data: pd.DataFrame,
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         extend = params["extend"]
         fill_range = params["fill_range"]
@@ -195,4 +193,4 @@ def draw_group(
             }
         )
 
-        return geom_rect.draw_group(data, panel_params, coord, ax, **params)
+        return geom_rect.draw_group(data, panel_params, coord, ax, params)

plotnine/geoms/geom.py

@@ -171,6 +171,21 @@ def __deepcopy__(self, memo: dict[Any, Any]) -> geom:
 
         return result
 
+    def setup_params(self, data: pd.DataFrame):
+        """
+        Override this method to verify and/or adjust parameters
+
+        Parameters
+        ----------
+        data :
+            Data
+
+        Returns
+        -------
+        out :
+            Parameters used by the geoms.
+        """
+
     def setup_data(self, data: pd.DataFrame) -> pd.DataFrame:
         """
         Modify the data before drawing takes place
@@ -261,9 +276,7 @@ def use_defaults(
 
         return data
 
-    def draw_layer(
-        self, data: pd.DataFrame, layout: Layout, coord: coord, **params: Any
-    ):
+    def draw_layer(self, data: pd.DataFrame, layout: Layout, coord: coord):
         """
         Draw layer across all panels
 
@@ -289,15 +302,14 @@ def draw_layer(
             ploc = pdata["PANEL"].iloc[0] - 1
             panel_params = layout.panel_params[ploc]
             ax = layout.axs[ploc]
-            self.draw_panel(pdata, panel_params, coord, ax, **params)
+            self.draw_panel(pdata, panel_params, coord, ax)
 
     def draw_panel(
         self,
         data: pd.DataFrame,
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
     ):
         """
         Plot all groups
@@ -331,15 +343,15 @@ def draw_panel(
         """
         for _, gdata in data.groupby("group"):
             gdata.reset_index(inplace=True, drop=True)
-            self.draw_group(gdata, panel_params, coord, ax, **params)
+            self.draw_group(gdata, panel_params, coord, ax, self.params)
 
     @staticmethod
     def draw_group(
         data: pd.DataFrame,
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         """
         Plot data belonging to a group.
@@ -376,7 +388,7 @@ def draw_unit(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         """
         Plot data belonging to a unit.

plotnine/geoms/geom_abline.py

@@ -102,7 +102,6 @@ def draw_panel(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
     ):
         """
         Plot all groups
@@ -116,4 +115,6 @@ def draw_panel(
 
         for _, gdata in data.groupby("group"):
             gdata.reset_index(inplace=True)
-            geom_segment.draw_group(gdata, panel_params, coord, ax, **params)
+            geom_segment.draw_group(
+                gdata, panel_params, coord, ax, self.params
+            )

plotnine/geoms/geom_blank.py

@@ -6,8 +6,6 @@
 from .geom import geom
 
 if typing.TYPE_CHECKING:
-    from typing import Any
-
     import pandas as pd
     from matplotlib.axes import Axes
 
@@ -39,7 +37,6 @@ def draw_panel(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
     ):
         pass
 

plotnine/geoms/geom_boxplot.py

@@ -183,7 +183,7 @@ def draw_group(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         def flat(*args: pd.Series[Any]) -> npt.NDArray[Any]:
             """Flatten list-likes"""
@@ -245,11 +245,11 @@ def outlier_value(param: str) -> Any:
             outliers["shape"] = outlier_value("shape")
             outliers["size"] = outlier_value("size")
             outliers["stroke"] = outlier_value("stroke")
-            geom_point.draw_group(outliers, panel_params, coord, ax, **params)
+            geom_point.draw_group(outliers, panel_params, coord, ax, params)
 
         # plot
-        geom_segment.draw_group(whiskers, panel_params, coord, ax, **params)
-        geom_crossbar.draw_group(box, panel_params, coord, ax, **params)
+        geom_segment.draw_group(whiskers, panel_params, coord, ax, params)
+        geom_crossbar.draw_group(box, panel_params, coord, ax, params)
 
     @staticmethod
     def draw_legend(

plotnine/geoms/geom_crossbar.py

@@ -78,7 +78,7 @@ def draw_group(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         y = data["y"]
         xmin = data["xmin"]
@@ -160,8 +160,8 @@ def flat(*args: pd.Series[Any]) -> npt.NDArray[Any]:
             )
 
         copy_missing_columns(box, data)
-        geom_polygon.draw_group(box, panel_params, coord, ax, **params)
-        geom_segment.draw_group(middle, panel_params, coord, ax, **params)
+        geom_polygon.draw_group(box, panel_params, coord, ax, params)
+        geom_segment.draw_group(middle, panel_params, coord, ax, params)
 
     @staticmethod
     def draw_legend(

plotnine/geoms/geom_dotplot.py

@@ -186,7 +186,7 @@ def draw_group(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         from matplotlib.collections import PatchCollection
         from matplotlib.patches import Ellipse

plotnine/geoms/geom_errorbar.py

@@ -67,7 +67,7 @@ def draw_group(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         f = np.hstack
         # create (two horizontal bars) + vertical bar
@@ -81,4 +81,4 @@ def draw_group(
         )
 
         copy_missing_columns(bars, data)
-        geom_segment.draw_group(bars, panel_params, coord, ax, **params)
+        geom_segment.draw_group(bars, panel_params, coord, ax, params)

plotnine/geoms/geom_errorbarh.py

@@ -67,7 +67,7 @@ def draw_group(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         f = np.hstack
         # create (two vertical bars) + horizontal bar
@@ -81,4 +81,4 @@ def draw_group(
         )
 
         copy_missing_columns(bars, data)
-        geom_segment.draw_group(bars, panel_params, coord, ax, **params)
+        geom_segment.draw_group(bars, panel_params, coord, ax, params)

plotnine/geoms/geom_hline.py

@@ -80,7 +80,6 @@ def draw_panel(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
     ):
         """
         Plot all groups
@@ -94,4 +93,6 @@ def draw_panel(
 
         for _, gdata in data.groupby("group"):
             gdata.reset_index(inplace=True)
-            geom_segment.draw_group(gdata, panel_params, coord, ax, **params)
+            geom_segment.draw_group(
+                gdata, panel_params, coord, ax, self.params
+            )

plotnine/geoms/geom_linerange.py

@@ -49,7 +49,7 @@ def draw_group(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         data.eval(
             """
@@ -59,4 +59,4 @@ def draw_group(
             """,
             inplace=True,
         )
-        geom_segment.draw_group(data, panel_params, coord, ax, **params)
+        geom_segment.draw_group(data, panel_params, coord, ax, params)

plotnine/geoms/geom_map.py

@@ -119,11 +119,11 @@ def draw_panel(
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
     ):
         if not len(data):
             return
 
+        params = self.params
         data.loc[data["color"].isna(), "color"] = "none"
         data.loc[data["fill"].isna(), "fill"] = "none"
         data["fill"] = to_rgba(data["fill"], data["alpha"])
@@ -153,7 +153,7 @@ def draw_panel(
             for _, gdata in data.groupby("group"):
                 gdata.reset_index(inplace=True, drop=True)
                 gdata.is_copy = None
-                geom_point.draw_group(gdata, panel_params, coord, ax, **params)
+                geom_point.draw_group(gdata, panel_params, coord, ax, params)
         elif geom_type == "MultiPoint":
             # Where n is the length of the dataframe (no. of multipoints),
             #       m is the number of all points in all multipoints
@@ -168,7 +168,7 @@ def draw_panel(
             data = data.explode("points", ignore_index=True)
             data["x"] = [p[0] for p in data["points"]]
             data["y"] = [p[1] for p in data["points"]]
-            geom_point.draw_group(data, panel_params, coord, ax, **params)
+            geom_point.draw_group(data, panel_params, coord, ax, params)
         elif geom_type in ("LineString", "MultiLineString"):
             from matplotlib.collections import LineCollection