plotnine 0.14.5__py3-none-any.whl → 0.15.0a2__py3-none-any.whl

plotnine/_utils/yippie.py

@@ -0,0 +1,115 @@
+"""
+Functions/class to quickly create plots for development and testing
+"""
+
+import pandas as pd
+
+from plotnine import (
+    aes,
+    element_blank,
+    element_rect,
+    element_text,
+    geom_col,
+    geom_point,
+    ggplot,
+    labs,
+    theme,
+)
+
+__all__ = ("geom", "legend", "plot", "rotate", "tag")
+
+
+class _Plot:
+    """
+    Create a plot
+    """
+
+    def __getattr__(self, color: str):
+        """
+        Create a blank plot with given background color
+        """
+        return (
+            ggplot()
+            + labs(
+                x="x-axis",
+                y="y-axis",
+                title=color.title(),
+            )
+            + theme(
+                figure_size=(8, 6),
+                text=element_text(color="black", size=11),
+                panel_background=element_rect(fill=color, size=1),
+                plot_background=element_rect(fill=color, alpha=0.2),
+                panel_border=element_rect(color="black"),
+                strip_background=element_rect(color="black"),
+                panel_grid=element_blank(),
+                legend_key_size=12,
+            )
+        )
+
+
+class _Geom:
+    """
+    Create some simple geoms
+    """
+
+    data = pd.DataFrame(
+        {
+            "cat": ["a", "b", "c", "d"],
+            "cat2": ["r", "r", "s", "s"],
+            "value": [1, 2, 3, 4],
+        }
+    )
+
+    @property
+    def points(self):
+        return geom_point(aes("cat", "value", color="cat"), self.data, size=2)
+
+    @property
+    def cols(self):
+        return geom_col(aes("cat", "value", fill="cat"), self.data)
+
+
+class _Legend:
+    """
+    Position Legends
+    """
+
+    @property
+    def left(self):
+        return theme(legend_position="left")
+
+    @property
+    def bottom(self):
+        return theme(legend_position="bottom")
+
+    @property
+    def right(self):
+        return theme(legend_position="right")
+
+    @property
+    def top(self):
+        return theme(legend_position="top")
+
+
+class _Rotate:
+    """
+    Rotate a text themeable
+    """
+
+    def __getattr__(self, name):
+        angle = 0 if name[-2:] == "_y" else 90
+        return theme(**{name: element_text(angle=angle)})  # pyright: ignore[reportArgumentType]
+
+
+def tag(s, position="topleft"):
+    """
+    Create a tag at a position
+    """
+    return [labs(tag=s), theme(plot_tag_position=position)]
+
+
+plot = _Plot()
+geom = _Geom()
+legend = _Legend()
+rotate = _Rotate()

plotnine/animation.py

@@ -233,6 +233,6 @@ class PlotnineAnimation(ArtistAnimation):
         plot.axs = axs
         with plot_context(plot):
             plot._build()
-            plot.figure, plot.axs = plot.facet.setup(plot)
+            plot.axs = plot.facet.setup(plot)
             plot._draw_layers()
         return plot

plotnine/coords/coord.py

@@ -35,12 +35,12 @@ class coord:
     # if the coordinate system needs them
     params: dict[str, Any]
 
-    def __radd__(self, plot: ggplot) -> ggplot:
+    def __radd__(self, other: ggplot) -> ggplot:
         """
         Add coordinates to ggplot object
         """
-        plot.coordinates = copy(self)
-        return plot
+        other.coordinates = copy(self)
+        return other
 
     def setup_data(self, data: list[pd.DataFrame]) -> list[pd.DataFrame]:
         """

plotnine/coords/coord_trans.py

@@ -117,7 +117,7 @@ class coord_trans(coord):
                 range=ranges.range,
             )
             sv.range = tuple(sorted(ranges.range_coord))  # type: ignore
-            breaks = cast(tuple[float, float], sv.breaks)
+            breaks = cast("tuple[float, float]", sv.breaks)
             sv.breaks = transform_value(trans, breaks)
             sv.minor_breaks = transform_value(trans, sv.minor_breaks)
             return sv

plotnine/data/__init__.py

@@ -8,6 +8,7 @@ import pandas as pd
 from pandas.api.types import CategoricalDtype
 
 __all__ = (
+    "anscombe_quartet",
     "diamonds",
     "economics",
     "economics_long",
@@ -42,6 +43,7 @@ penguins = pd.read_csv(DATA_DIR / "penguins.csv")
 luv_colours = pd.read_csv(DATA_DIR / "luv_colours.csv")
 faithfuld = pd.read_csv(DATA_DIR / "faithfuld.csv")
 faithful = pd.read_csv(DATA_DIR / "faithful.csv")
+anscombe_quartet = pd.read_csv(DATA_DIR / "anscombe-quartet.csv")
 
 # For convenience to the user, we set some columns in these
 # dataframes to categoricals.
@@ -81,20 +83,24 @@ def _process_categories():
     """
     Set columns in some of the dataframes to categoricals
     """
-    global diamonds, midwest, mpg, msleep, penguins
+    global diamonds, penguins
     diamonds = _ordered_categories(
         diamonds,
         {
-            "cut": "Fair, Good, Very Good, Premium, Ideal".split(", "),
-            "clarity": "I1 SI2 SI1 VS2 VS1 VVS2 VVS1 IF".split(),
+            "cut": ["Fair", "Good", "Very Good", "Premium", "Ideal"],
+            "clarity": [
+                "I1",
+                "SI2",
+                "SI1",
+                "VS2",
+                "VS1",
+                "VVS2",
+                "VVS1",
+                "IF",
+            ],
             "color": list("DEFGHIJ"),
         },
     )
-    mpg = _unordered_categories(
-        mpg, "manufacturer model trans fl drv class".split()
-    )
-    midwest = _unordered_categories(midwest, ["category"])
-    msleep = _unordered_categories(msleep, ["vore", "conservation"])
     penguins = _unordered_categories(penguins, ["species", "island", "sex"])
 
 
@@ -614,3 +620,32 @@ A data frame with 83 rows and 11 variables
 Additional variables order, conservation status and
 vore were added from wikipedia.
 """
+
+anscombe_quartet.__doc__ = """
+Anscombe's Quartet
+
+## Description
+
+A dataset by Statistician Francis Anscombe that challenged the commonly held
+belief that "numerical calculations are exact, but graphs are rough"
+(Anscombe, 1973). 
+
+It comprises of 4 (the quartet!) small sub-datasets, each with 11 points that
+have different distributions but nearly identical descriptive statistics.
+It is perhaps the best argument for visualising data.
+
+## Format
+
+A dataframe with 44 rows and 3 variables
+
+| Column       | Description                           |
+|--------------|---------------------------------------|
+| dataset      | The Dataset                           |
+| x            | x                                     |
+| y            | y                                     |
+
+## References
+
+Anscombe, F. J. (1973). "Graphs in Statistical Analysis".
+American Statistician. 27 (1): 17–21.
+"""

plotnine/data/anscombe-quartet.csv

@@ -0,0 +1,45 @@
+dataset,x,y
+I,10,8.04
+I,8,6.95
+I,13,7.58
+I,9,8.81
+I,11,8.33
+I,14,9.96
+I,6,7.24
+I,4,4.26
+I,12,10.84
+I,7,4.82
+I,5,5.68
+II,10,9.14
+II,8,8.14
+II,13,8.74
+II,9,8.77
+II,11,9.26
+II,14,8.1
+II,6,6.13
+II,4,3.1
+II,12,9.13
+II,7,7.26
+II,5,4.74
+III,10,7.46
+III,8,6.77
+III,13,12.74
+III,9,7.11
+III,11,7.81
+III,14,8.84
+III,6,6.08
+III,4,5.39
+III,12,8.15
+III,7,6.42
+III,5,5.73
+IV,8,6.58
+IV,8,5.76
+IV,8,7.71
+IV,8,8.84
+IV,8,8.47
+IV,8,7.04
+IV,8,5.25
+IV,19,12.5
+IV,8,5.56
+IV,8,7.91
+IV,8,6.89

plotnine/doctools.py

@@ -188,7 +188,7 @@ def dict_to_table(header: tuple[str, str], contents: dict[str, str]) -> str:
     fill       `None`
     """
     rows = [
-        (name, value if value == "" else f"`{value!r}`" "{.py}")
+        (name, value if value == "" else f"`{value!r}`{{.py}}")
         for name, value in contents.items()
     ]
     return table_function(rows, headers=header, tablefmt="grid")
@@ -451,7 +451,7 @@ def document_geom(geom: type[geom]) -> type[geom]:
     table = dict_to_table(("Aesthetic", "Default value"), contents)
     aesthetics_table = AESTHETICS_TABLE_TPL.format(table=table)
     tpl = dedent(geom._aesthetics_doc).strip()
-    aesthetics_doc = tpl.format(aesthetics_table=aesthetics_table)
+    aesthetics_doc = tpl.replace("{aesthetics_table}", aesthetics_table)
     aesthetics_doc = indent(aesthetics_doc, " " * 4)
 
     # common_parameters

plotnine/facets/facet.py

@@ -20,9 +20,9 @@ if typing.TYPE_CHECKING:
     import numpy.typing as npt
     from matplotlib.axes import Axes
     from matplotlib.figure import Figure
-    from matplotlib.gridspec import GridSpec
 
     from plotnine import ggplot, theme
+    from plotnine._mpl.gridspec import p9GridSpec
     from plotnine.coords.coord import coord
     from plotnine.facets.labelling import CanBeStripLabellingFunc
     from plotnine.facets.layout import Layout
@@ -93,6 +93,7 @@ class facet:
 
     # Axes
     axs: list[Axes]
+    _panels_gridspec: p9GridSpec
 
     # ggplot object that the facet belongs to
     plot: ggplot
@@ -100,8 +101,6 @@ class facet:
     # Facet strips
     strips: Strips
 
-    grid_spec: GridSpec
-
     # The plot environment
     environment: Environment
 
@@ -121,33 +120,39 @@ class facet:
         self.as_table = as_table
         self.drop = drop
         self.dir = dir
+        allowed_scales = ["fixed", "free", "free_x", "free_y"]
+        if scales not in allowed_scales:
+            raise ValueError(
+                "Argument `scales` must be one of {allowed_scales}."
+            )
         self.free = {
             "x": scales in ("free_x", "free"),
             "y": scales in ("free_y", "free"),
         }
 
-    def __radd__(self, plot: ggplot) -> ggplot:
+    def __radd__(self, other: ggplot) -> ggplot:
         """
         Add facet to ggplot object
         """
-        plot.facet = copy(self)
-        plot.facet.environment = plot.environment
-        return plot
+        other.facet = copy(self)
+        other.facet.environment = other.environment
+        return other
 
     def setup(self, plot: ggplot):
         self.plot = plot
         self.layout = plot.layout
+        self.figure = plot.figure
 
-        if hasattr(plot, "figure"):
-            self.figure, self.axs = plot.figure, plot.axs
+        if hasattr(plot, "axs"):
+            self.axs = plot.axs
         else:
-            self.figure, self.axs = self.make_figure()
+            self.axs = self._make_axes()
 
         self.coordinates = plot.coordinates
         self.theme = plot.theme
         self.layout.axs = self.axs
         self.strips = Strips.from_facet(self)
-        return self.figure, self.axs
+        return self.axs
 
     def setup_data(self, data: list[pd.DataFrame]) -> list[pd.DataFrame]:
         """
@@ -346,17 +351,8 @@ class facet:
         ax.xaxis.set_major_formatter(MyFixedFormatter(panel_params.x.labels))
         ax.yaxis.set_major_formatter(MyFixedFormatter(panel_params.y.labels))
 
-        pad_x = (
-            margin.get_as("t", "pt")
-            if (margin := theme.getp(("axis_text_x", "margin")))
-            else 0
-        )
-
-        pad_y = (
-            margin.get_as("r", "pt")
-            if (margin := theme.getp(("axis_text_y", "margin")))
-            else 0
-        )
+        pad_x = theme.get_margin("axis_text_x").pt.t
+        pad_y = theme.get_margin("axis_text_y").pt.r
 
         ax.tick_params(axis="x", which="major", pad=pad_x)
         ax.tick_params(axis="y", which="major", pad=pad_y)
@@ -372,7 +368,7 @@ class facet:
         new = result.__dict__
 
         # don't make a deepcopy of the figure & the axes
-        shallow = {"figure", "axs", "first_ax", "last_ax"}
+        shallow = {"axs", "first_ax", "last_ax"}
         for key, item in old.items():
             if key in shallow:
                 new[key] = item
@@ -382,35 +378,31 @@ class facet:
 
         return result
 
-    def _make_figure(self) -> tuple[Figure, GridSpec]:
+    def _get_panels_gridspec(self) -> p9GridSpec:
         """
-        Create figure & gridspec
+        Create gridspec for the panels
         """
-        import matplotlib.pyplot as plt
-        from matplotlib.gridspec import GridSpec
+        from plotnine._mpl.gridspec import p9GridSpec
 
-        return plt.figure(), GridSpec(self.nrow, self.ncol)
+        return p9GridSpec(
+            self.nrow, self.ncol, self.figure, nest_into=self.plot._gridspec[0]
+        )
 
-    def make_figure(self) -> tuple[Figure, list[Axes]]:
+    def _make_axes(self) -> list[Axes]:
         """
-        Create and return Matplotlib figure and subplot axes
+        Create and return subplot axes
         """
         num_panels = len(self.layout.layout)
         axsarr = np.empty((self.nrow, self.ncol), dtype=object)
 
-        # Create figure & gridspec
-        figure, gs = self._make_figure()
-        self.grid_spec = gs
+        self._panels_gridspec = self._get_panels_gridspec()
 
         # Create axes
         it = itertools.product(range(self.nrow), range(self.ncol))
         for i, (row, col) in enumerate(it):
-            axsarr[row, col] = figure.add_subplot(gs[i])
-
-        # axsarr = np.array([
-        #     figure.add_subplot(gs[i])
-        #     for i in range(self.nrow * self.ncol)
-        # ]).reshape((self.nrow, self.ncol))
+            axsarr[row, col] = self.figure.add_subplot(
+                self._panels_gridspec[i]
+            )
 
         # Rearrange axes
         # They are ordered to match the positions in the layout table
@@ -429,9 +421,9 @@ class facet:
 
         # Delete unused axes
         for ax in axs[num_panels:]:
-            figure.delaxes(ax)
+            self.figure.delaxes(ax)
         axs = axs[:num_panels]
-        return figure, list(axs)
+        return list(axs)
 
     def _aspect_ratio(self) -> Optional[float]:
         """
@@ -477,8 +469,7 @@ def combine_vars(
     has_all = [x.shape[1] == len(vars) for x in values]
     if not any(has_all):
         raise PlotnineError(
-            "At least one layer must contain all variables "
-            "used for facetting"
+            "At least one layer must contain all variables used for facetting"
         )
     base = pd.concat([x for i, x in enumerate(values) if has_all[i]], axis=0)
     base = base.drop_duplicates()

plotnine/facets/facet_grid.py

@@ -107,9 +107,11 @@ class facet_grid(facet):
         self.space = space
         self.margins = margins
 
-    def _make_figure(self):
-        import matplotlib.pyplot as plt
-        from matplotlib.gridspec import GridSpec
+    def _get_panels_gridspec(self):
+        """
+        Create gridspec for the panels
+        """
+        from plotnine._mpl.gridspec import p9GridSpec
 
         layout = self.layout
         space = self.space
@@ -155,7 +157,13 @@ class facet_grid(facet):
             ratios["width_ratios"] = self.space.get("x")
             ratios["height_ratios"] = self.space.get("y")
 
-        return plt.figure(), GridSpec(self.nrow, self.ncol, **ratios)
+        return p9GridSpec(
+            self.nrow,
+            self.ncol,
+            self.figure,
+            nest_into=self.plot._gridspec[0],
+            **ratios,
+        )
 
     def compute_layout(self, data: list[pd.DataFrame]) -> pd.DataFrame:
         if not self.rows and not self.cols:
@@ -302,7 +310,7 @@ def parse_grid_facets_old(
         "((var1, var2), (var3, var4))",
     ]
     error_msg_s = (
-        "Valid sequences for specifying 'facets' look like" f" {valid_seqs}"
+        f"Valid sequences for specifying 'facets' look like {valid_seqs}"
     )
 
     valid_forms = [
@@ -314,7 +322,7 @@ def parse_grid_facets_old(
         ". ~ func(var1) + func(var2)",
         ". ~ func(var1+var3) + func(var2)",
     ] + valid_seqs
-    error_msg_f = "Valid formula for 'facet_grid' look like" f" {valid_forms}"
+    error_msg_f = f"Valid formula for 'facet_grid' look like {valid_forms}"
 
     if not isinstance(facets, str):
         if len(facets) == 1:

plotnine/facets/facet_wrap.py

@@ -198,8 +198,7 @@ def check_dimensions(
     if nrow is not None:
         if nrow < 1:
             warn(
-                "'nrow' must be greater than 0. "
-                "Your value has been ignored.",
+                "'nrow' must be greater than 0. Your value has been ignored.",
                 PlotnineWarning,
             )
             nrow = None
@@ -209,8 +208,7 @@ def check_dimensions(
     if ncol is not None:
         if ncol < 1:
             warn(
-                "'ncol' must be greater than 0. "
-                "Your value has been ignored.",
+                "'ncol' must be greater than 0. Your value has been ignored.",
                 PlotnineWarning,
             )
             ncol = None
@@ -241,7 +239,7 @@ def parse_wrap_facets_old(facets: str | Sequence[str]) -> Sequence[str]:
     This handles the old & silently deprecated r-style formulas
     """
     valid_forms = ["~ var1", "~ var1 + var2"]
-    error_msg = "Valid formula for 'facet_wrap' look like" f" {valid_forms}"
+    error_msg = f"Valid formula for 'facet_wrap' look like {valid_forms}"
 
     if isinstance(facets, (list, tuple)):
         return facets

plotnine/facets/strips.py

@@ -63,62 +63,49 @@ class strip:
         """
         theme = self.theme
         position = self.position
+
         if position == "top":
             # The x & y values are just starting locations
             # The final location is determined by the layout manager.
-            y = 1
-            ha, va = "center", "bottom"
+            bg_y = 1
+            ha = theme.getp(("strip_text_x", "ha"), "center")
+            va = theme.getp(("strip_text_x", "va"), "center")
             rotation = theme.getp(("strip_text_x", "rotation"))
-            box_width = 1
-            box_height = 0  # Determined by the text size
-            # TODO: Allow two unique paddings for either side.
-            # Requires implementing an mpl.patches.boxstyle that recognises
-            # two padding values.
-
-            strip_text_margin = (
-                margin.get_as("b", "lines")
-                if (margin := theme.getp(("strip_text_x", "margin")))
-                else 0
-            )
+            bg_height = 0  # Determined by the text size
+            margin = theme.getp(("strip_text_x", "margin")).to("lines")
             strip_align = theme.getp("strip_align_x")
 
             # x & width properties of the background slide and
             # shrink the strip horizontally.
-            x = theme.getp(("strip_text_x", "x"), 0)
-            box_width = theme.getp(("strip_background_x", "width"), 1)
+            bg_x = theme.getp(("strip_text_x", "x"), 0)
+            bg_width = theme.getp(("strip_background_x", "width"), 1)
 
         elif position == "right":
             # The x & y values are just starting locations
             # The final location is determined by the layout manager.
-            x = 1
-            ha, va = "left", "center"
+            bg_x = 1
+            ha = theme.getp(("strip_text_y", "ha"), "center")
+            va = theme.getp(("strip_text_y", "va"), "center")
             rotation = theme.getp(("strip_text_y", "rotation"))
-            box_width = 0  # Determine by the text height
-            # TODO: Allow two unique paddings for either side.
-            # Requires implementing an mpl.patches.boxstyle that recognises
-            # two padding values.
-            strip_text_margin = (
-                margin.get_as("r", "lines")
-                if (margin := theme.getp(("strip_text_y", "margin")))
-                else 0
-            )
+            bg_width = 0  # Determine by the text height
+            margin = theme.getp(("strip_text_y", "margin")).to("lines")
             strip_align = theme.getp("strip_align_y")
 
             # y & height properties of the background slide and
             # shrink the strip vertically.
-            y = theme.getp(("strip_text_y", "y"), 0)
-            box_height = theme.getp(("strip_background_y", "height"), 1)
+            bg_y = theme.getp(("strip_text_y", "y"), 0)
+            bg_height = theme.getp(("strip_background_y", "height"), 1)
         else:
             raise ValueError(f"Unknown position for strip text: {position!r}")
 
         return strip_draw_info(
-            x=x,
-            y=y,
+            bg_x=bg_x,
+            bg_y=bg_y,
             ha=ha,
             va=va,
-            box_width=box_width,
-            box_height=box_height,
-            strip_text_margin=strip_text_margin,
+            bg_width=bg_width,
+            bg_height=bg_height,
+            margin=margin,
             strip_align=strip_align,
             position=position,
             label=self.label_info.text(),

plotnine/geoms/annotate.py

@@ -131,12 +131,12 @@ class annotate:
             **kwargs,
         )
 
-    def __radd__(self, plot: ggplot) -> ggplot:
+    def __radd__(self, other: ggplot) -> ggplot:
         """
         Add to ggplot
         """
-        plot += self.to_layer()  # Add layer
-        return plot
+        other += self.to_layer()  # Add layer
+        return other
 
     def to_layer(self) -> layer:
         """

plotnine/geoms/annotation_logticks.py

@@ -285,4 +285,6 @@ class annotation_logticks(annotate):
             linetype=linetype,
             lengths=lengths,
             base=base,
+            inherit_aes=False,
+            show_legend=False,
         )

plotnine/geoms/annotation_stripes.py

@@ -72,6 +72,8 @@ class annotation_stripes(annotate):
             fill_range=fill_range,
             extend=extend,
             direction=direction,
+            inherit_aes=False,
+            show_legend=False,
             **kwargs,
         )