plotnine 0.15.0a3__tar.gz → 0.15.0a4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plotnine
-Version: 0.15.0a3
+Version: 0.15.0a4
 Summary: A Grammar of Graphics for Python
 Author-email: Hassan Kibirige <has2k1@gmail.com>
 License: The MIT License (MIT)
@@ -48,7 +48,7 @@ Requires-Dist: matplotlib>=3.8.0
 Requires-Dist: pandas>=2.2.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"

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

@@ -9,7 +9,6 @@ from qrenderer import (
     RenderDoc,
     RenderDocClass,
     exclude_parameters,
-    extend_base_class,
 )
 from qrenderer._pandoc.inlines import shortcode
 from quartodoc.pandoc.blocks import Blocks, CodeBlock, Div, Header
@@ -43,7 +42,6 @@ exclude_parameters(
 )
 
 
-@extend_base_class
 class _RenderDoc(RenderDoc):
     def render_body(self):
         body = super().render_body()
@@ -70,7 +68,6 @@ class _RenderDoc(RenderDoc):
         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.0a3 → plotnine-0.15.0a4}/doc/changelog.qmd

@@ -88,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

{plotnine-0.15.0a3 → 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):
     """
@@ -361,7 +362,7 @@ def _id_var(x: AnyArrayLike, drop: bool = False) -> list[int]:
         lst = match(x, levels)
         lst = [item + 1 for item in lst]
 
-    return lst  # pyright: ignore[reportReturnType]
+    return lst
 
 
 def join_keys(x, y, by=None):
@@ -530,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.0a3 → 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.0a3 → 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.0a3 → 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
@@ -179,11 +178,16 @@ class geom(ABC, metaclass=Register):
         ----------
         data :
             Data
+        """
 
-        Returns
-        -------
-        out :
-            Parameters used by the geoms.
+    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:
@@ -255,23 +259,28 @@ 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

{plotnine-0.15.0a3 → plotnine-0.15.0a4}/plotnine/layer.py

@@ -257,6 +257,7 @@ class layer:
         """
         self.geom.params["zorder"] = self.zorder
         self.geom.params["raster"] = self.raster
+        self.geom.params["inherit_aes"] = self.inherit_aes
 
     def compute_aesthetics(self, plot: ggplot):
         """
@@ -330,6 +331,7 @@ class layer:
 
         self.geom.params.update(self.stat.params)
         self.geom.setup_params(data)
+        self.geom.setup_aes_params(data)
         data = self.geom.setup_data(data)
 
         check_required_aesthetics(

{plotnine-0.15.0a3 → plotnine-0.15.0a4}/plotnine/mapping/aes.py

@@ -8,7 +8,9 @@ from dataclasses import fields
 from functools import cached_property
 from typing import TYPE_CHECKING, Any, Dict
 
+import numpy as np
 import pandas as pd
+from mizani._colors.utils import is_color_tuple
 
 from ..iapi import labels_view
 from .evaluation import after_stat, stage
@@ -538,23 +540,23 @@ def make_labels(mapping: dict[str, Any] | aes) -> labels_view:
     )
 
 
-def is_valid_aesthetic(value: Any, ae: str) -> bool:
+class RepeatAesthetic:
     """
-    Return True if `value` looks valid.
+    Repeat an Aeshetic a given number of times
 
-    Parameters
-    ----------
-    value :
-        Value to check
-    ae :
-        Aesthetic name
+    The methods in this class know how to create sequences of aesthetics
+    whose values may not be scalar.
 
-    Notes
-    -----
-    There are no guarantees that he value is spot on
-    valid.
+    Some aesthetics may have valid values that are not scalar. e.g.
+    sequences. Inserting one of such a value in a dataframe as a column
+    would either lead to the wrong input or fail. The s
     """
-    if ae == "linetype":
+
+    @staticmethod
+    def linetype(value: Any, n: int) -> Sequence[Any]:
+        """
+        Repeat linetypes
+        """
         named = {
             "solid",
             "dashed",
@@ -569,47 +571,75 @@ def is_valid_aesthetic(value: Any, ae: str) -> bool:
             "",
         }
         if value in named:
-            return True
+            return [value] * n
 
         # tuple of the form (offset, (on, off, on, off, ...))
         # e.g (0, (1, 2))
-        conditions = [
-            isinstance(value, tuple),
-            isinstance(value[0], int),
-            isinstance(value[1], tuple),
-            len(value[1]) % 2 == 0,
-            all(isinstance(x, int) for x in value[1]),
-        ]
-        return all(conditions)
-
-    elif ae == "shape":
+        if (
+            isinstance(value, tuple)
+            and isinstance(value[0], int)
+            and isinstance(value[1], tuple)
+            and len(value[1]) % 2 == 0
+            and all(isinstance(x, int) for x in value[1])
+        ):
+            return [value] * n
+
+        raise ValueError(f"{value} is not a known linetype.")
+
+    @staticmethod
+    def color(value: Any, n: int) -> Sequence[Any]:
+        """
+        Repeat colors
+        """
         if isinstance(value, str):
-            return True
+            return [value] * n
+        if is_color_tuple(value):
+            return [tuple(value)] * n
+
+        raise ValueError(f"{value} is not a known color.")
+
+    fill = color
 
+    @staticmethod
+    def shape(value: Any, n: int) -> Any:
+        """
+        Repeat shapes
+        """
+        if isinstance(value, str):
+            return [value] * n
         # tuple of the form (numsides, style, angle)
         # where style is in the range [0, 3]
         # e.g (4, 1, 45)
-        conditions = [
-            isinstance(value, tuple),
-            all(isinstance(x, int) for x in value),
-            0 <= value[1] < 3,
-        ]
-        return all(conditions)
-
-    elif ae in {"color", "fill"}:
-        if isinstance(value, str):
-            return True
-        with suppress(TypeError):
-            if isinstance(value, (tuple, list)) and all(
-                0 <= x <= 1 for x in value
-            ):
-                return True
-        return False
+        if (
+            isinstance(value, tuple)
+            and all(isinstance(x, int) for x in value)
+            and 0 <= value[1] < 3
+        ):
+            return [value] * n
+
+        if is_shape_points(value):
+            return [tuple(value)] * n
+
+        raise ValueError(f"{value} is not a know shape.")
 
-    # For any other aesthetics we return False to allow
-    # for special cases to be discovered and then coded
-    # for appropriately.
-    return False
+
+def is_shape_points(obj: Any) -> bool:
+    """
+    Return True if obj is like Sequence[tuple[float, float]]
+    """
+
+    def is_numeric(obj) -> bool:
+        """
+        Return True if obj is a python or numpy float or integer
+        """
+        return isinstance(obj, (float, int, np.floating, np.integer))
+
+    if not iter(obj):
+        return False
+    try:
+        return all(is_numeric(a) and is_numeric(b) for a, b in obj)
+    except TypeError:
+        return False
 
 
 def has_groups(data: pd.DataFrame) -> bool:

{plotnine-0.15.0a3 → plotnine-0.15.0a4}/plotnine/scales/scale_continuous.py

@@ -396,7 +396,7 @@ class scale_continuous(
             scaled = [na_value if x == "nan" else x for x in scaled]
         else:
             scaled[pd.isna(scaled)] = na_value
-        return scaled  # pyright: ignore[reportReturnType]
+        return scaled
 
     def get_breaks(
         self, limits: Optional[tuple[float, float]] = None

{plotnine-0.15.0a3 → plotnine-0.15.0a4}/plotnine/scales/scale_discrete.py

@@ -206,7 +206,7 @@ class scale_discrete(
                 pal = np.asarray(pal, dtype=object)
             idx = np.asarray(match(x, limits))
             try:
-                pal_match = [pal[i] if i >= 0 else None for i in idx]  # pyright: ignore[reportCallIssue,reportArgumentType]
+                pal_match = [pal[i] if i >= 0 else None for i in idx]
             except IndexError:
                 # Deal with missing data
                 # - Insert NaN where there is no match

{plotnine-0.15.0a3 → plotnine-0.15.0a4}/plotnine/stats/stat_density_2d.py

@@ -155,7 +155,7 @@ def contour_lines(X, Y, Z, levels: int | FloatArrayLike):
     level_values = []
     start_pid = 1
     for level in levels:
-        vertices, *_ = cgen.create_contour(level)  # pyright: ignore[reportArgumentType]
+        vertices, *_ = cgen.create_contour(level)
         for pid, piece in enumerate(vertices, start=start_pid):
             n = len(piece)  # pyright: ignore
             segments.append(piece)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plotnine
-Version: 0.15.0a3
+Version: 0.15.0a4
 Summary: A Grammar of Graphics for Python
 Author-email: Hassan Kibirige <has2k1@gmail.com>
 License: The MIT License (MIT)
@@ -48,7 +48,7 @@ Requires-Dist: matplotlib>=3.8.0
 Requires-Dist: pandas>=2.2.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"

{plotnine-0.15.0a3 → plotnine-0.15.0a4}/plotnine.egg-info/SOURCES.txt

@@ -326,11 +326,13 @@ tests/test_theme.py
 tests/test_utils.py
 tests/test_watermark.py
 tests/baseline_images/test_aes/geom_crossbar.png
+tests/baseline_images/test_aes/irregular_shapes.png
 tests/baseline_images/test_aes/reorder.png
 tests/baseline_images/test_aes/reorder_index.png
 tests/baseline_images/test_aes/stat_bin_2d.png
 tests/baseline_images/test_aes/stat_ecdf.png
 tests/baseline_images/test_aes/test_stat_function.png
+tests/baseline_images/test_annotate/annotate_faceting.png
 tests/baseline_images/test_annotate/multiple_annotation_geoms.png
 tests/baseline_images/test_annotation_logticks/annotation_logticks.png
 tests/baseline_images/test_annotation_logticks/annotation_logticks_base_5.png

{plotnine-0.15.0a3 → plotnine-0.15.0a4}/plotnine.egg-info/requires.txt

@@ -2,7 +2,7 @@ matplotlib>=3.8.0
 pandas>=2.2.0
 mizani~=0.14.0
 numpy>=1.23.5
-scipy>=1.8.0
+scipy<1.16.0,>=1.8.0
 statsmodels>=0.14.0
 
 [all]

{plotnine-0.15.0a3 → plotnine-0.15.0a4}/pyproject.toml

@@ -27,7 +27,7 @@ dependencies = [
     "pandas>=2.2.0",
     "mizani~=0.14.0",
     "numpy>=1.23.5",
-    "scipy>=1.8.0",
+    "scipy>=1.8.0,<1.16.0",
     "statsmodels>=0.14.0",
 ]
 requires-python = ">=3.10"

{plotnine-0.15.0a3 → plotnine-0.15.0a4}/tests/test_aes.py

@@ -26,6 +26,14 @@ data = pd.DataFrame(
 )
 
 
+data = pd.DataFrame(
+    {
+        "x": pd.Categorical(["b", "d", "c", "a"], ordered=True),
+        "y": [1, 2, 3, 4],
+    }
+)
+
+
 def test_reorder():
     p = (
         ggplot(data, aes("reorder(x, y)", "y", fill="reorder(x, y)"))
@@ -53,6 +61,30 @@ def test_labels_lists():
     assert p.labels.y is None
 
 
+def test_irregular_shapes():
+    import matplotlib.path as mpath
+
+    five_point_astericks = (5, 2, 60)
+    house = ((-2, -4), (-2, -1), (0, 1), (2, -1), (2, -4), (-2, -4))
+
+    star = mpath.Path.unit_regular_star(6)
+    circle = mpath.Path.unit_circle()
+
+    cut_star = mpath.Path(
+        vertices=[*circle.vertices, *star.vertices[::-1]],  # pyright: ignore[reportGeneralTypeIssues,reportIndexIssue,reportArgumentType]
+        codes=[*circle.codes, *star.codes],  # pyright: ignore[reportOptionalIterable,reportGeneralTypeIssues]
+    )
+
+    p = (
+        ggplot(data, aes("x", "y"))
+        + geom_point(shape=five_point_astericks, size=10)
+        + geom_point(aes(y="y-.5"), shape=house, size=10)
+        + geom_point(aes(y="y-1"), shape=cut_star, size=10)
+    )
+
+    assert p == "irregular_shapes"
+
+
 class TestTransScale:
     df1 = pd.DataFrame({"var": np.arange(1, 11) / 10})