plotnine 0.15.0.dev3__py3-none-any.whl → 0.15.2__py3-none-any.whl

plotnine/scales/scale_color.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from dataclasses import KW_ONLY, InitVar, dataclass
+from dataclasses import KW_ONLY, InitVar, dataclass, field
 from typing import Literal, Sequence
 from warnings import warn
 
@@ -48,36 +48,72 @@ class _scale_color_continuous(
 class scale_color_hue(_scale_color_discrete):
     """
     Qualitative color scale with evenly spaced hues
+
+    See Also
+    --------
+    mizani.palettes.hue_pal : The palette class that generates colours
+        in HCL space.
     """
 
-    h: InitVar[float] = 0.01
+    h: InitVar[float | tuple[float, float]] = 15
     """
-    Hue. Must be in the range [0, 1]
+    Hue. If a float, it is the first hue value, in the range `[0, 360]`.
+    The range of the palette will be `[first, first + 360)`.
+
+    If a tuple, it is the range `[first, last)` of the hues.
     """
 
-    l: InitVar[float] = 0.6
+    c: InitVar[float] = 100
     """
-    Lightness. Must be in the range [0, 1]
+    Chroma. Must be in the range `[0, 100]`
     """
 
-    s: InitVar[float] = 0.65
+    l: InitVar[float] = 65
     """
-    Saturation. Must be in the range [0, 1]
+    Lightness. Must be in the range [0, 100]
     """
 
-    color_space: InitVar[Literal["hls", "hsluv"]] = "hls"
+    direction: InitVar[Literal[1, -1]] = 1
     """
-    Color space to use. Should be one of
-    [hls](https://en.wikipedia.org/wiki/HSL_and_HSV)
-    or [hsluv](https://www.hsluv.org/).
-    https://www.hsluv.org/
+    The order of colours in the scale. If -1 the order
+    of colours is reversed. The default is 1.
     """
 
-    def __post_init__(self, h, l, s, color_space):
+    _: KW_ONLY
+
+    s: None = field(default=None, repr=False)
+    """
+    Not being used and will be removed in a future version
+    """
+    color_space: None = field(default=None, repr=False)
+    """
+    Not being used and will be removed in a future version
+    """
+
+    def __post_init__(self, h, c, l, direction):
         from mizani.palettes import hue_pal
 
+        if (s := self.s) is not None:
+            warn(
+                f"You used {s=} for the saturation which has been ignored. "
+                f"{self.__class__.__name__} now works in HCL colorspace. "
+                f"Using `s` in future versions will throw an exception.",
+                FutureWarning,
+            )
+            del self.s
+
+        if (color_space := self.color_space) is not None:
+            warn(
+                f"You used {color_space=} to select a color_space and it "
+                f"has been ignored. {self.__class__.__name__} now only works "
+                f"in HCL colorspace. Using `color_space` in future versions "
+                "will throw an exception.",
+                FutureWarning,
+            )
+            del self.color_space
+
         super().__post_init__()
-        self.palette = hue_pal(h, l, s, color_space=color_space)
+        self.palette = hue_pal(h, c, l, direction)
 
 
 @dataclass
@@ -95,6 +131,11 @@ class scale_color_brewer(_scale_color_discrete):
     Sequential, diverging and qualitative discrete color scales
 
     See `colorbrewer.org <http://colorbrewer2.org/>`_
+
+    See Also
+    --------
+    mizani.palette.brewer_pal : The palette class that generates colours
+        that generates the brewer colors.
     """
 
     type: InitVar[
@@ -146,6 +187,11 @@ class scale_fill_brewer(scale_color_brewer):
 class scale_color_grey(_scale_color_discrete):
     """
     Sequential grey color scale.
+
+    See Also
+    --------
+    mizani.palettes.grey_pal : The palette class that generates colours
+        gray scale color.
     """
 
     start: InitVar[float] = 0.2
@@ -188,6 +234,8 @@ class scale_color_gradient(_scale_color_continuous):
     --------
     plotnine.scale_color_gradient2
     plotnine.scale_color_gradientn
+    mizani.palettes.gradient_n_pal : The palette class that generates
+        the colour gradient.
     """
 
     low: InitVar[str] = "#132B43"
@@ -220,6 +268,11 @@ class scale_fill_gradient(scale_color_gradient):
 class scale_color_desaturate(_scale_color_continuous):
     """
     Create a desaturated color gradient
+
+    See Also
+    --------
+    mizani.palettes.desaturate_pal : The palette class that generates
+        the desaturated colours.
     """
 
     color: InitVar[str] = "red"
@@ -263,6 +316,8 @@ class scale_color_gradient2(_scale_color_continuous):
     --------
     plotnine.scale_color_gradient
     plotnine.scale_color_gradientn
+    mizani.palettes.gradient_n_pal : The palette class that generates
+        the colour gradient.
     """
 
     low: InitVar[str] = "#832424"
@@ -316,9 +371,11 @@ class scale_color_gradientn(_scale_color_continuous):
     --------
     plotnine.scale_color_gradient
     plotnine.scale_color_gradientn
+    mizani.palettes.gradient_n_pal : The palette class that generates
+        the colour gradient.
     """
 
-    colors: InitVar[Sequence[str]] = "#832424"
+    colors: InitVar[Sequence[str]]
     """
     List of colors
     """
@@ -332,8 +389,8 @@ class scale_color_gradientn(_scale_color_continuous):
     def __post_init__(self, colors, values):
         from mizani.palettes import gradient_n_pal
 
-        self.palette = gradient_n_pal(colors, values)
         super().__post_init__()
+        self.palette = gradient_n_pal(colors, values)
 
 
 @dataclass
@@ -430,6 +487,8 @@ class scale_color_cmap(_scale_color_continuous):
     --------
     [](`matplotlib.cm`)
     [](`matplotlib.colors`)
+    mizani.palettes.cmap_pal : The palette class that generates
+        the colour gradients of this scale.
     """
 
     cmap_name: InitVar[str] = "viridis"
@@ -457,7 +516,7 @@ class scale_fill_cmap(scale_color_cmap):
 
 
 @dataclass
-class scale_color_cmap_d(scale_discrete):
+class scale_color_cmap_d(_scale_color_discrete):
     """
     A discrete color scales using Matplotlib colormaps
 
@@ -465,6 +524,8 @@ class scale_color_cmap_d(scale_discrete):
     --------
     [](`matplotlib.cm`)
     [](`matplotlib.colors`)
+    mizani.palettes.cmap_pal : The palette class that generates
+        the colours of this scale.
     """
 
     cmap_name: InitVar[str] = "viridis"
@@ -474,7 +535,6 @@ class scale_color_cmap_d(scale_discrete):
     `matplotlib.cm.cmap_d.keys()` or see the
     `documentation <http://matplotlib.org/users/colormaps.html>`_.
     """
-    _aesthetics = ["color"]
 
     def __post_init__(self, cmap_name):
         from mizani.palettes import cmap_d_pal
@@ -496,6 +556,10 @@ class scale_fill_cmap_d(scale_color_cmap_d):
 class scale_color_datetime(scale_datetime, scale_color_cmap):  # pyright: ignore[reportIncompatibleVariableOverride]
     """
     Datetime color scale
+
+    See Also
+    --------
+    plotnine.scale_color_cmap : The parent class.
     """
 
     _: KW_ONLY

plotnine/scales/scale_continuous.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from contextlib import suppress
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Sequence
+from typing import TYPE_CHECKING, Sequence, cast
 from warnings import warn
 
 import numpy as np
@@ -387,14 +387,15 @@ class scale_continuous(
             limits = self.final_limits
 
         x = self.oob(self.rescaler(x, _from=limits))
+        na_value = cast("float", self.na_value)
 
         uniq = np.unique(x)
         pal = np.asarray(self.palette(uniq))
         scaled = pal[match(x, uniq)]
         if scaled.dtype.kind == "U":
-            scaled = [self.na_value if x == "nan" else x for x in scaled]
+            scaled = [na_value if x == "nan" else x for x in scaled]
         else:
-            scaled[pd.isna(scaled)] = self.na_value
+            scaled[pd.isna(scaled)] = na_value
         return scaled
 
     def get_breaks(
@@ -520,11 +521,12 @@ class scale_continuous(
             # When user sets breaks and labels of equal size,
             # but the limits exclude some of the breaks.
             # We remove the corresponding labels
-            from collections.abc import Sized
+            from collections.abc import Iterable, Sized
 
             labels = self.labels
             if (
                 len(labels) != len(breaks)
+                and isinstance(self.breaks, Iterable)
                 and isinstance(self.breaks, Sized)
                 and len(labels) == len(self.breaks)
             ):

plotnine/scales/scale_datetime.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from dataclasses import KW_ONLY, InitVar, dataclass
 from typing import TYPE_CHECKING
+from warnings import warn
 
 from ._runtime_typing import TransUser  # noqa: TCH001
 from .scale_continuous import scale_continuous
@@ -20,24 +21,21 @@ class scale_datetime(scale_continuous):
     """
     A string giving the distance between major breaks.
     For example `'2 weeks'`, `'5 years'`. If specified,
-    `date_breaks` takes precedence over
-    `breaks`.
+    `date_breaks` takes precedence over `breaks`.
     """
 
     date_labels: InitVar[str | None] = None
     """
     Format string for the labels.
     See [strftime](:ref:`strftime-strptime-behavior`).
-    If specified, `date_labels` takes precedence over
-    `labels`.
+    If specified, `date_labels` takes precedence over `labels`.
     """
 
     date_minor_breaks: InitVar[str | None] = None
     """
     A string giving the distance between minor breaks.
     For example `'2 weeks'`, `'5 years'`. If specified,
-    `date_minor_breaks` takes precedence over
-    `minor_breaks`.
+    `date_minor_breaks` takes precedence over `minor_breaks`.
     """
 
     _: KW_ONLY
@@ -80,22 +78,38 @@ class scale_datetime(scale_continuous):
         date_labels: str | None,
         date_minor_breaks: str | None,
     ):
-        from mizani.breaks import breaks_date as breaks_func
-        from mizani.labels import label_date as labels_func
+        from mizani.breaks import breaks_date_width
+        from mizani.labels import label_date
 
         if date_breaks is not None:
-            self.breaks = breaks_func(date_breaks)  # pyright: ignore
+            self.breaks = breaks_date_width(date_breaks)  # pyright: ignore[reportAttributeAccessIssue]
         elif isinstance(self.breaks, str):
-            self.breaks = breaks_func(width=self.breaks)  # pyright: ignore
+            warn(
+                "Passing a string to `breaks` will not work in "
+                f"future versions. Use `date_breaks={self.breaks!r}`",
+                FutureWarning,
+            )
+            self.breaks = breaks_date_width(width=self.breaks)  # pyright: ignore[reportAttributeAccessIssue]
 
         if date_labels is not None:
-            self.labels = labels_func(date_labels)  # pyright: ignore
+            self.labels = label_date(fmt=date_labels)  # pyright: ignore[reportAttributeAccessIssue]
         elif isinstance(self.labels, str):
-            self.labels = labels_func(width=self.labels)  # pyright: ignore
+            warn(
+                "Passing a string to `labels` will not work in "
+                f"future versions. Use `date_labels={self.labels!r}`",
+                FutureWarning,
+            )
+            self.labels = label_date(fmt=self.labels)  # pyright: ignore[reportAttributeAccessIssue]
 
         if date_minor_breaks is not None:
-            self.minor_breaks = breaks_func(date_minor_breaks)  # pyright: ignore
+            self.minor_breaks = breaks_date_width(date_minor_breaks)  # pyright: ignore[reportAttributeAccessIssue]
         elif isinstance(self.minor_breaks, str):
-            self.minor_breaks = breaks_func(width=self.minor_breaks)  # pyright: ignore
+            warn(
+                "Passing a string to `minor_breaks` will not work in "
+                "future versions. "
+                f"Use `date_minor_breaks={self.minor_breaks!r}`",
+                FutureWarning,
+            )
+            self.minor_breaks = breaks_date_width(width=self.minor_breaks)  # pyright: ignore[reportAttributeAccessIssue]
 
         scale_continuous.__post_init__(self)

plotnine/scales/scale_discrete.py

@@ -156,7 +156,7 @@ class scale_discrete(
             range = self.dimension(limits=limits)
 
         breaks_d = self.get_breaks(limits)
-        breaks = self.map(pd.Categorical(breaks_d))
+        breaks = self.map(pd.Categorical(breaks_d))  # pyright: ignore[reportArgumentType]
         minor_breaks = []
         labels = self.get_labels(breaks_d)
 

plotnine/scales/scale_identity.py

@@ -43,6 +43,8 @@ class scale_color_identity(MapTrainMixin, scale_discrete):
     """
 
     _aesthetics = ["color"]
+    _: KW_ONLY
+    guide: Literal["legend"] | None = None
 
 
 @dataclass
@@ -52,6 +54,8 @@ class scale_fill_identity(scale_color_identity):
     """
 
     _aesthetics = ["fill"]
+    _: KW_ONLY
+    guide: Literal["legend"] | None = None
 
 
 @dataclass
@@ -61,6 +65,8 @@ class scale_shape_identity(MapTrainMixin, scale_discrete):
     """
 
     _aesthetics = ["shape"]
+    _: KW_ONLY
+    guide: Literal["legend"] | None = None
 
 
 @dataclass
@@ -70,6 +76,8 @@ class scale_linetype_identity(MapTrainMixin, scale_discrete):
     """
 
     _aesthetics = ["linetype"]
+    _: KW_ONLY
+    guide: Literal["legend"] | None = None
 
 
 @dataclass
@@ -82,7 +90,7 @@ class scale_alpha_identity(
 
     _aesthetics = ["alpha"]
     _: KW_ONLY
-    guide: Literal["legend"] | None = "legend"
+    guide: Literal["legend"] | None = None
 
 
 @dataclass
@@ -95,7 +103,18 @@ class scale_size_identity(
 
     _aesthetics = ["size"]
     _: KW_ONLY
-    guide: Literal["legend"] | None = "legend"
+    guide: Literal["legend"] | None = None
+
+
+@dataclass
+class scale_stroke_identity(MapTrainMixin, scale_discrete):
+    """
+    No stroke scaling
+    """
+
+    _aesthetics = ["stroke"]
+    _: KW_ONLY
+    guide: Literal["legend"] | None = None
 
 
 # American to British spelling

plotnine/scales/scale_manual.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from collections.abc import Mapping
 from dataclasses import KW_ONLY, InitVar, dataclass
 from typing import Any, Sequence
 from warnings import warn
@@ -21,11 +22,16 @@ class _scale_manual(scale_discrete):
     """
 
     def __post_init__(self, values):
-        from collections.abc import Sized
+        from collections.abc import Iterable, Sized
 
         super().__post_init__()
 
-        if isinstance(self.breaks, Sized) and len(self.breaks) == len(values):
+        if (
+            isinstance(self.breaks, Iterable)
+            and isinstance(self.breaks, Sized)
+            and len(self.breaks) == len(values)
+            and not isinstance(values, Mapping)
+        ):
             values = dict(zip(self.breaks, values))
 
         def palette(n):

plotnine/scales/scale_xy.py

@@ -213,7 +213,7 @@ class scale_x_discrete(scale_position_discrete):
     Discrete x position
     """
 
-    _aesthetics = ["x", "xmin", "xmax", "xend"]
+    _aesthetics = ["x", "xmin", "xmax", "xend", "xintercept"]
 
 
 @dataclass(kw_only=True)
@@ -222,7 +222,7 @@ class scale_y_discrete(scale_position_discrete):
     Discrete y position
     """
 
-    _aesthetics = ["y", "ymin", "ymax", "yend"]
+    _aesthetics = ["y", "ymin", "ymax", "yend", "yintercept"]
 
 
 # Not part of the user API

plotnine/stats/binning.py

@@ -165,7 +165,10 @@ def assign_bins(
     if weight is None:
         weight = np.ones(len(x))
     else:
-        weight = np.asarray(weight)
+        # If weight is a dtype that isn't writeable
+        # and does not own it's memory. Using a list
+        # as an intermediate easily solves this.
+        weight = np.array(list(weight))
         weight[np.isnan(weight)] = 0
 
     bin_idx = pd.cut(

plotnine/stats/smoothers.py

@@ -12,12 +12,9 @@ from ..exceptions import PlotnineError, PlotnineWarning
 
 if TYPE_CHECKING:
     import statsmodels.api as sm
-    from patsy.eval import EvalEnvironment
 
-    from plotnine.mapping import Environment
 
-
-def predictdf(data, xseq, **params) -> pd.DataFrame:
+def predictdf(data, xseq, params) -> pd.DataFrame:
     """
     Make prediction on the data
 
@@ -49,21 +46,21 @@ def predictdf(data, xseq, **params) -> pd.DataFrame:
     if not callable(method):
         msg = (
             "'method' should either be a string or a function"
-            "with the signature `func(data, xseq, **params)`"
+            "with the signature `func(data, xseq, params)`"
         )
         raise PlotnineError(msg)
 
-    return method(data, xseq, **params)
+    return method(data, xseq, params)
 
 
-def lm(data, xseq, **params) -> pd.DataFrame:
+def lm(data, xseq, params) -> pd.DataFrame:
     """
     Fit OLS / WLS if data has weight
     """
     import statsmodels.api as sm
 
     if params["formula"]:
-        return lm_formula(data, xseq, **params)
+        return lm_formula(data, xseq, params)
 
     X = sm.add_constant(data["x"])
     Xseq = sm.add_constant(xseq)
@@ -96,14 +93,14 @@ def lm(data, xseq, **params) -> pd.DataFrame:
     return data
 
 
-def lm_formula(data, xseq, **params) -> pd.DataFrame:
+def lm_formula(data, xseq, params) -> pd.DataFrame:
     """
     Fit OLS / WLS using a formula
     """
     import statsmodels.api as sm
     import statsmodels.formula.api as smf
 
-    eval_env = _to_patsy_env(params["environment"])
+    eval_env = params["environment"].to_patsy_env()
     formula = params["formula"]
     weights = data.get("weight", None)
 
@@ -140,14 +137,14 @@ def lm_formula(data, xseq, **params) -> pd.DataFrame:
     return data
 
 
-def rlm(data, xseq, **params) -> pd.DataFrame:
+def rlm(data, xseq, params) -> pd.DataFrame:
     """
     Fit RLM
     """
     import statsmodels.api as sm
 
     if params["formula"]:
-        return rlm_formula(data, xseq, **params)
+        return rlm_formula(data, xseq, params)
 
     X = sm.add_constant(data["x"])
     Xseq = sm.add_constant(xseq)
@@ -170,14 +167,14 @@ def rlm(data, xseq, **params) -> pd.DataFrame:
     return data
 
 
-def rlm_formula(data, xseq, **params) -> pd.DataFrame:
+def rlm_formula(data, xseq, params) -> pd.DataFrame:
     """
     Fit RLM using a formula
     """
     import statsmodels.api as sm
     import statsmodels.formula.api as smf
 
-    eval_env = _to_patsy_env(params["environment"])
+    eval_env = params["environment"].to_patsy_env()
     formula = params["formula"]
     init_kwargs, fit_kwargs = separate_method_kwargs(
         params["method_args"], sm.RLM, sm.RLM.fit
@@ -196,14 +193,14 @@ def rlm_formula(data, xseq, **params) -> pd.DataFrame:
     return data
 
 
-def gls(data, xseq, **params) -> pd.DataFrame:
+def gls(data, xseq, params) -> pd.DataFrame:
     """
     Fit GLS
     """
     import statsmodels.api as sm
 
     if params["formula"]:
-        return gls_formula(data, xseq, **params)
+        return gls_formula(data, xseq, params)
 
     X = sm.add_constant(data["x"])
     Xseq = sm.add_constant(xseq)
@@ -227,14 +224,14 @@ def gls(data, xseq, **params) -> pd.DataFrame:
     return data
 
 
-def gls_formula(data, xseq, **params):
+def gls_formula(data, xseq, params):
     """
     Fit GLL using a formula
     """
     import statsmodels.api as sm
     import statsmodels.formula.api as smf
 
-    eval_env = _to_patsy_env(params["environment"])
+    eval_env = params["environment"].to_patsy_env()
     formula = params["formula"]
     init_kwargs, fit_kwargs = separate_method_kwargs(
         params["method_args"], sm.GLS, sm.GLS.fit
@@ -258,14 +255,14 @@ def gls_formula(data, xseq, **params):
     return data
 
 
-def glm(data, xseq, **params) -> pd.DataFrame:
+def glm(data, xseq, params) -> pd.DataFrame:
     """
     Fit GLM
     """
     import statsmodels.api as sm
 
     if params["formula"]:
-        return glm_formula(data, xseq, **params)
+        return glm_formula(data, xseq, params)
 
     X = sm.add_constant(data["x"])
     Xseq = sm.add_constant(xseq)
@@ -292,14 +289,14 @@ def glm(data, xseq, **params) -> pd.DataFrame:
     return data
 
 
-def glm_formula(data, xseq, **params):
+def glm_formula(data, xseq, params):
     """
     Fit with GLM formula
     """
     import statsmodels.api as sm
     import statsmodels.formula.api as smf
 
-    eval_env = _to_patsy_env(params["environment"])
+    eval_env = params["environment"].to_patsy_env()
     init_kwargs, fit_kwargs = separate_method_kwargs(
         params["method_args"], sm.GLM, sm.GLM.fit
     )
@@ -321,7 +318,7 @@ def glm_formula(data, xseq, **params):
     return data
 
 
-def lowess(data, xseq, **params) -> pd.DataFrame:
+def lowess(data, xseq, params) -> pd.DataFrame:
     """
     Lowess fitting
     """
@@ -351,7 +348,7 @@ def lowess(data, xseq, **params) -> pd.DataFrame:
     return data
 
 
-def loess(data, xseq, **params) -> pd.DataFrame:
+def loess(data, xseq, params) -> pd.DataFrame:
     """
     Loess smoothing
     """
@@ -402,7 +399,7 @@ def loess(data, xseq, **params) -> pd.DataFrame:
     return data
 
 
-def mavg(data, xseq, **params) -> pd.DataFrame:
+def mavg(data, xseq, params) -> pd.DataFrame:
     """
     Fit moving average
     """
@@ -426,7 +423,7 @@ def mavg(data, xseq, **params) -> pd.DataFrame:
     return data
 
 
-def gpr(data, xseq, **params):
+def gpr(data, xseq, params):
     """
     Fit gaussian process
     """
@@ -593,16 +590,6 @@ def separate_method_kwargs(method_args, init_method, fit_method):
     return init_kwargs, fit_kwargs
 
 
-def _to_patsy_env(environment: Environment) -> EvalEnvironment:
-    """
-    Convert a plotnine environment to a patsy environment
-    """
-    from patsy.eval import EvalEnvironment
-
-    eval_env = EvalEnvironment(environment.namespaces)
-    return eval_env
-
-
 def _glm_family(family: str) -> sm.families.Family:
     """
     Get glm-family instance