plotnine 0.15.0a2__tar.gz → 0.15.0a4__tar.gz

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/Makefile

@@ -119,6 +119,7 @@ doc-dependencies:
 
 develop: clean-cache
 	$(PIP) install -e ".[all]"
+	$(MAKE) doc-dependencies
 
 develop-update: clean-cache
 	$(PIP) install --upgrade -e ".[all]"

{plotnine-0.15.0a2/plotnine.egg-info → plotnine-0.15.0a4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plotnine
-Version: 0.15.0a2
+Version: 0.15.0a4
 Summary: A Grammar of Graphics for Python
 Author-email: Hassan Kibirige <has2k1@gmail.com>
 License: The MIT License (MIT)
@@ -46,9 +46,9 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: matplotlib>=3.8.0
 Requires-Dist: pandas>=2.2.0
-Requires-Dist: mizani~=0.13.0
+Requires-Dist: mizani~=0.14.0
 Requires-Dist: numpy>=1.23.5
-Requires-Dist: scipy>=1.8.0
+Requires-Dist: scipy<1.16.0,>=1.8.0
 Requires-Dist: statsmodels>=0.14.0
 Provides-Extra: all
 Requires-Dist: plotnine[extra]; extra == "all"
@@ -82,7 +82,7 @@ Requires-Dist: twine; extra == "dev"
 Requires-Dist: plotnine[typing]; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Provides-Extra: typing
-Requires-Dist: pyright==1.1.400; extra == "typing"
+Requires-Dist: pyright==1.1.402; extra == "typing"
 Requires-Dist: ipython; extra == "typing"
 Requires-Dist: pandas-stubs; extra == "typing"
 Dynamic: license-file

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/doc/Makefile

@@ -66,7 +66,7 @@ config:  ## Configure project for quartodoc and quarto
 docstrings: config  ## Generate qmd files from the docstrings
 	$(PYTHON) -m quartodoc build --config _quartodoc.yml
 	# Create a objects.inv
-	@$(PYTHON) -m sphobjinv convert zlib objects.txt
+	@$(PYTHON) -m sphobjinv convert -o zlib objects.txt
 
 html: docstrings  ## Build html site
 	quarto render

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/doc/_quartodoc.yml

@@ -540,27 +540,27 @@ quartodoc:
     - subtitle: Accessing the Options
       desc: |
         These are the methods that access the options.
-      package: plotnine.options
+      package: plotnine
       options:
         dynamic: false
       contents:
-        - get_option
-        - set_option
+        - options.get_option
+        - options.set_option
 
     - subtitle: The Available Options
       desc: |
         These are _all_ the options that you can set or get the values of.
-      package: plotnine.options
+      package: plotnine
       options:
         dynamic: false
       contents:
-        - aspect_ratio
-        - base_family
-        - base_margin
-        - current_theme
-        - dpi
-        - figure_size
-        - figure_format
+        - options.aspect_ratio
+        - options.base_family
+        - options.base_margin
+        - options.current_theme
+        - options.dpi
+        - options.figure_size
+        - options.figure_format
 
     - title: Tools
       desc: |

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/doc/_renderer.py

@@ -4,7 +4,12 @@ import re
 from pathlib import Path
 from textwrap import dedent
 
-from qrenderer import QRenderer, RenderDoc, RenderDocClass, extend_base_class
+from qrenderer import (
+    QRenderer,
+    RenderDoc,
+    RenderDocClass,
+    exclude_parameters,
+)
 from qrenderer._pandoc.inlines import shortcode
 from quartodoc.pandoc.blocks import Blocks, CodeBlock, Div, Header
 from quartodoc.pandoc.components import Attr
@@ -30,7 +35,13 @@ class Renderer(QRenderer):
     pass
 
 
-@extend_base_class
+exclude_parameters(
+    {
+        "plotnine.scale_color_hue": ("s", "color_space"),
+    }
+)
+
+
 class _RenderDoc(RenderDoc):
     def render_body(self):
         body = super().render_body()
@@ -46,8 +57,17 @@ class _RenderDoc(RenderDoc):
         header = Header(self.level + 1, "Examples")
         return Blocks([body, header, embed_notebook])
 
+    # Until quartodoc makes it possible to use a tilde to use
+    # and objects name and not the qualified path, we have to
+    # create exceptions for all the qualified paths that we want
+    # to be short.
+    # Ref: https://github.com/machow/quartodoc/issues/230
+    @property
+    def summary_name(self):
+        name = super().summary_name
+        return name[8:] if name.startswith("options.") else name
+
 
-@extend_base_class
 class _RenderDocClass(RenderDocClass):
     def render_signature(self):
         signature = super().render_signature()

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/doc/changelog.qmd

@@ -19,6 +19,14 @@ title: Changelog
    or `axis_text_y` to control the spacing between the axis text and the ticks.
    ({{< issue 843 >}})
 
+- 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
 
 - Plot Composition is here. Using an intuitive algebra, you can
@@ -80,6 +88,16 @@ title: Changelog
 
 - Gained new helper function [](:func:`~plotnine.helpers.get_aesthetic_limits`).
 
+- [](:class:`~plotnine.geom_point`) gained the ability to handle shapes of the form
+  `Sequence[tuple[float, float]]` e.g.
+
+   ```python 
+   ((-2, -4), (-2, -1), (0, 1), (2, -1), (2, -4), (-2, -4))
+   ```
+
+   Which declares the vertices of a polygon shape.
+   
+
 ### Enhancements
 
 - Included datasets [](:attr:`~plotnine.data.mpg`), [](:attr:`~plotnine.data.msleep`) and
@@ -137,6 +155,12 @@ title: Changelog
 - Fixed bug in [](:class:`~plotnine.geom_histogram`) where mapping to the `weight` aesthetic
   lead to an error. {{< issue 936 >}}
 
+- Fixed bug in [](:class:`~plotnine.geom_vline`) where you could not map the `xintercept`
+  aesthetic to a discrete variable.
+
+- Fixed bug in [](:class:`~plotnine.geom_hline`) where you could not map the `yintercept`
+  aesthetic to a discrete variable.
+
 ## v0.14.5
 (2025-01-02)
 [![](https://zenodo.org/badge/DOI/10.5281/zenodo.14587381.svg)](https://doi.org/10.5281/zenodo.14587381)

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/plotnine/_mpl/layout_manager/_layout_tree.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import abc
 from dataclasses import dataclass
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 import numpy as np
 
@@ -528,8 +528,9 @@ class ColumnsTree(LayoutTree):
         if self.bottom_tags_align:
             return
 
-        values = max(self.bottom_tag_heights) - np.array(
-            self.bottom_tag_heights
+        values = cast(
+            "Sequence[float]",
+            max(self.bottom_tag_heights) - np.array(self.bottom_tag_heights),
         )
         for item, value in zip(self.nodes, values):
             if isinstance(item, LayoutSpaces):
@@ -541,7 +542,10 @@ class ColumnsTree(LayoutTree):
         if self.top_tags_align:
             return
 
-        values = max(self.top_tag_heights) - np.array(self.top_tag_heights)
+        values = cast(
+            "Sequence[float]",
+            max(self.top_tag_heights) - np.array(self.top_tag_heights),
+        )
         for item, value in zip(self.nodes, values):
             if isinstance(item, LayoutSpaces):
                 item.t.tag_alignment = value
@@ -776,7 +780,10 @@ class RowsTree(LayoutTree):
         if self.left_tags_align:
             return
 
-        values = max(self.left_tag_widths) - np.array(self.left_tag_widths)
+        values = cast(
+            "Sequence[float]",
+            max(self.left_tag_widths) - np.array(self.left_tag_widths),
+        )
         for item, value in zip(self.nodes, values):
             if isinstance(item, LayoutSpaces):
                 item.l.tag_alignment = value
@@ -787,7 +794,10 @@ class RowsTree(LayoutTree):
         if self.right_tags_align:
             return
 
-        values = max(self.right_tag_widths) - np.array(self.right_tag_widths)
+        values = cast(
+            "Sequence[float]",
+            max(self.right_tag_widths) - np.array(self.right_tag_widths),
+        )
         for item, value in zip(self.nodes, values):
             if isinstance(item, LayoutSpaces):
                 item.r.tag_alignment = value

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/plotnine/_utils/__init__.py

@@ -12,9 +12,10 @@ from collections.abc import Iterable, Sequence
 from contextlib import suppress
 from copy import deepcopy
 from dataclasses import field
-from typing import TYPE_CHECKING, cast, overload
+from typing import TYPE_CHECKING
 from warnings import warn
 
+import mizani._colors.utils as color_utils
 import numpy as np
 import pandas as pd
 from pandas.core.groupby import DataFrameGroupBy
@@ -26,12 +27,10 @@ if TYPE_CHECKING:
     from typing import Any, Callable, Literal, TypeVar
 
     import numpy.typing as npt
-    from matplotlib.typing import ColorType
     from typing_extensions import TypeGuard
 
     from plotnine.typing import (
         AnyArrayLike,
-        AnySeries,
         DataLike,
         FloatArray,
         FloatArrayLike,
@@ -60,6 +59,8 @@ BOX_LOCATIONS: dict[str, tuple[float, float]] = {
     "centre": (0.5, 0.5),
 }
 
+to_rgba = color_utils.to_rgba
+
 
 def is_scalar(val):
     """
@@ -346,6 +347,8 @@ def _id_var(x: AnyArrayLike, drop: bool = False) -> list[int]:
                 # NaNs are -1, we give them the highest code
                 nan_code = -1
                 new_nan_code = np.max(x.cat.codes) + 1
+                # TODO: We are assuming that x is of type Sequence[int|nan]
+                # is that accurate.
                 lst = [val if val != nan_code else new_nan_code for val in x]
             else:
                 lst = list(x.cat.codes + 1)
@@ -513,7 +516,7 @@ def remove_missing(
     if finite:
         lst = [np.inf, -np.inf]
         to_replace = {v: lst for v in vars}
-        data.replace(to_replace, np.nan, inplace=True)  # pyright: ignore[reportArgumentType,reportCallIssue]
+        data.replace(to_replace, np.nan, inplace=True)
         txt = "non-finite"
     else:
         txt = "missing"
@@ -528,105 +531,6 @@ def remove_missing(
     return data
 
 
-@overload
-def to_rgba(colors: ColorType, alpha: float) -> ColorType: ...
-
-
-@overload
-def to_rgba(
-    colors: Sequence[ColorType], alpha: float
-) -> Sequence[ColorType] | ColorType: ...
-
-
-@overload
-def to_rgba(
-    colors: AnySeries, alpha: AnySeries
-) -> Sequence[ColorType] | ColorType: ...
-
-
-def to_rgba(
-    colors: Sequence[ColorType] | AnySeries | ColorType,
-    alpha: float | Sequence[float] | AnySeries,
-) -> Sequence[ColorType] | ColorType:
-    """
-    Convert hex colors to rgba values.
-
-    Parameters
-    ----------
-    colors : iterable | str
-        colors to convert
-    alphas : iterable | float
-        alpha values
-
-    Returns
-    -------
-    out : ndarray | tuple
-        rgba color(s)
-
-    Notes
-    -----
-    Matplotlib plotting functions only accept scalar
-    alpha values. Hence no two objects with different
-    alpha values may be plotted in one call. This would
-    make plots with continuous alpha values innefficient.
-    However :), the colors can be rgba hex values or
-    list-likes and the alpha dimension will be respected.
-    """
-
-    def is_iterable(var):
-        return np.iterable(var) and not isinstance(var, str)
-
-    def has_alpha(c):
-        return (isinstance(c, tuple) and len(c) == 4) or (
-            isinstance(c, str) and len(c) == 9 and c[0] == "#"
-        )
-
-    def no_color(c):
-        return c is None or c.lower() in ("none", "")
-
-    def to_rgba_hex(c: ColorType, a: float) -> str:
-        """
-        Convert rgb color to rgba hex value
-
-        If color c has an alpha channel, then alpha value
-        a is ignored
-        """
-        from matplotlib.colors import colorConverter, to_hex
-
-        if c in ("None", "none"):
-            return c
-
-        _has_alpha = has_alpha(c)
-        c = to_hex(c, keep_alpha=_has_alpha)
-
-        if not _has_alpha:
-            arr = colorConverter.to_rgba(c, a)
-            return to_hex(arr, keep_alpha=True)
-
-        return c
-
-    if is_iterable(colors):
-        colors = cast("Sequence[ColorType]", colors)
-
-        if all(no_color(c) for c in colors):
-            return "none"
-
-        if isinstance(alpha, (Sequence, pd.Series)):
-            return [to_rgba_hex(c, a) for c, a in zip(colors, alpha)]
-        else:
-            return [to_rgba_hex(c, alpha) for c in colors]
-    else:
-        colors = cast("ColorType", colors)
-
-        if no_color(colors):
-            return colors
-
-        if isinstance(alpha, (Sequence, pd.Series)):
-            return [to_rgba_hex(colors, a) for a in alpha]
-        else:
-            return to_rgba_hex(colors, alpha)
-
-
 def groupby_apply(
     df: pd.DataFrame,
     cols: str | list[str],

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/plotnine/doctools.py

@@ -71,7 +71,7 @@ STAT_SIGNATURE_TPL = """
 
 common_params_doc = {
     "mapping": """\
-Aesthetic mappings created with [aes](:class:`plotnine.mapping.aes`). If \
+Aesthetic mappings created with [aes](:class:`plotnine.mapping.aes.aes`). If \
 specified and `inherit_aes=True`{.py}, it is combined with the default \
 mapping for the plot. You must supply mapping if there is no plot mapping.""",
     "data": """\
@@ -103,7 +103,7 @@ the final image is in vector format.""",
 
 
 GEOM_PARAMS_TPL = """
-mapping : ~plotnine.mapping.aes, default=None
+mapping : ~plotnine.mapping.aes.aes, default=None
     {mapping}
     {_aesthetics_doc}
 data : ~pandas.DataFrame, default=None
@@ -124,7 +124,7 @@ raster : bool, default={default_raster}
 """
 
 STAT_PARAMS_TPL = """
-mapping : ~plotnine.mapping.aes, default=None
+mapping : ~plotnine.mapping.aes.aes, default=None
     {mapping}
     {_aesthetics_doc}
 data : ~pandas.DataFrame, default=None

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/plotnine/geoms/annotate.py

@@ -64,16 +64,16 @@ class annotate:
     def __init__(
         self,
         geom: str | type[geom_base_class],
-        x: float | None = None,
-        y: float | None = None,
-        xmin: float | None = None,
-        xmax: float | None = None,
-        xend: float | None = None,
-        xintercept: float | None = None,
-        ymin: float | None = None,
-        ymax: float | None = None,
-        yend: float | None = None,
-        yintercept: float | None = None,
+        x: float | list[float] | None = None,
+        y: float | list[float] | None = None,
+        xmin: float | list[float] | None = None,
+        xmax: float | list[float] | None = None,
+        xend: float | list[float] | None = None,
+        xintercept: float | list[float] | None = None,
+        ymin: float | list[float] | None = None,
+        ymax: float | list[float] | None = None,
+        yend: float | list[float] | None = None,
+        yintercept: float | list[float] | None = None,
         **kwargs: Any,
     ):
         variables = locals()

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/plotnine/geoms/annotation_logticks.py

@@ -46,9 +46,7 @@ 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
         """
@@ -56,7 +54,7 @@ class _geom_logticks(geom_rug):
             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 @@ class _geom_logticks(geom_rug):
         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 @@ class _geom_logticks(geom_rug):
         ):
             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-0.15.0a2 → plotnine-0.15.0a4}/plotnine/geoms/annotation_stripes.py

@@ -96,9 +96,7 @@ 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
         """
@@ -106,7 +104,7 @@ class _geom_stripes(geom):
             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(
@@ -114,7 +112,7 @@ class _geom_stripes(geom):
         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 @@ class _geom_stripes(geom):
             }
         )
 
-        return geom_rect.draw_group(data, panel_params, coord, ax, **params)
+        return geom_rect.draw_group(data, panel_params, coord, ax, params)

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/plotnine/geoms/geom.py

@@ -7,13 +7,12 @@ from itertools import chain, repeat
 
 from .._utils import (
     data_mapping_as_kwargs,
-    is_list_like,
     remove_missing,
 )
 from .._utils.registry import Register, Registry
 from ..exceptions import PlotnineError
 from ..layer import layer
-from ..mapping.aes import is_valid_aesthetic, rename_aesthetics
+from ..mapping.aes import RepeatAesthetic, rename_aesthetics
 from ..mapping.evaluation import evaluate
 from ..positions.position import position
 from ..stats.stat import stat
@@ -171,6 +170,26 @@ class geom(ABC, metaclass=Register):
 
         return result
 
+    def setup_params(self, data: pd.DataFrame):
+        """
+        Override this method to verify and/or adjust parameters
+
+        Parameters
+        ----------
+        data :
+            Data
+        """
+
+    def setup_aes_params(self, data: pd.DataFrame):
+        """
+        Override this method to verify and/or adjust aesthetic parameters
+
+        Parameters
+        ----------
+        data :
+            Data
+        """
+
     def setup_data(self, data: pd.DataFrame) -> pd.DataFrame:
         """
         Modify the data before drawing takes place
@@ -240,30 +259,33 @@ class geom(ABC, metaclass=Register):
             data[ae] = evaled[ae]
 
         num_panels = len(data["PANEL"].unique()) if "PANEL" in data else 1
+        across_panels = num_panels > 1 and not self.params["inherit_aes"]
 
         # Aesthetics set as parameters to the geom/stat
         for ae, value in self.aes_params.items():
             try:
                 data[ae] = value
             except ValueError as e:
-                # sniff out the special cases, like custom
-                # tupled linetypes, shapes and colors
-                if is_valid_aesthetic(value, ae):
-                    data[ae] = [value] * len(data)
-                elif num_panels > 1 and is_list_like(value):
-                    data[ae] = list(chain(*repeat(value, num_panels)))
+                # NOTE: Handling of the edgecases in this exception is not
+                # foolproof.
+                repeat_ae = getattr(RepeatAesthetic, ae, None)
+                if across_panels:
+                    # Adding an annotation/abline/hline/vhline with multiple
+                    # items across to more than 1 panel
+                    value = list(chain(*repeat(value, num_panels)))
+                    data[ae] = value
+                elif repeat_ae:
+                    # Some aesthetics may have valid values that are not
+                    # scalar. e.g. sequences. For such case, we need to
+                    # insert a sequence of the same value.
+                    data[ae] = repeat_ae(value, len(data))
                 else:
-                    msg = (
-                        f"'{value}' does not look like a "
-                        f"valid value for `{ae}`"
-                    )
+                    msg = f"'{ae}={value}' does not look like a valid value"
                     raise PlotnineError(msg) from e
 
         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,7 +311,7 @@ class geom(ABC, metaclass=Register):
             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,
@@ -297,7 +319,6 @@ class geom(ABC, metaclass=Register):
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
     ):
         """
         Plot all groups
@@ -331,7 +352,7 @@ class geom(ABC, metaclass=Register):
         """
         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(
@@ -339,7 +360,7 @@ class geom(ABC, metaclass=Register):
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         """
         Plot data belonging to a group.
@@ -376,7 +397,7 @@ class geom(ABC, metaclass=Register):
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
+        params: dict[str, Any],
     ):
         """
         Plot data belonging to a unit.

{plotnine-0.15.0a2 → plotnine-0.15.0a4}/plotnine/geoms/geom_abline.py

@@ -102,7 +102,6 @@ class geom_abline(geom):
         panel_params: panel_view,
         coord: coord,
         ax: Axes,
-        **params: Any,
     ):
         """
         Plot all groups
@@ -116,4 +115,6 @@ class geom_abline(geom):
 
         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
+            )