plotnine 0.15.0a1__py3-none-any.whl → 0.15.0a2__py3-none-any.whl

plotnine/_utils/__init__.py

@@ -35,8 +35,10 @@ if TYPE_CHECKING:
         DataLike,
         FloatArray,
         FloatArrayLike,
+        HorizontalJustification,
         IntArray,
         Side,
+        VerticalJustification,
     )
 
     T = TypeVar("T")
@@ -1264,3 +1266,27 @@ def ensure_xy_location(
         if isinstance(h, (int, float)) and isinstance(v, (int, float)):
             return (h, v)
     raise ValueError(f"Cannot make a location from '{loc}'")
+
+
+def ha_as_float(ha: HorizontalJustification | float) -> float:
+    """
+    Return horizontal alignment as a float
+    """
+    lookup = {"left": 0.0, "center": 0.5, "right": 1.0}
+    return lookup[ha] if isinstance(ha, str) else ha
+
+
+def va_as_float(va: VerticalJustification | float) -> float:
+    """
+    Return vertical alignment as a float
+    """
+    lookup = {
+        "top": 1.0,
+        "center": 0.5,
+        "bottom": 0.0,
+        # baseline and center_baseline are valid for texts but we do
+        # not handle them accurately
+        "baseline": 0.5,
+        "center_baseline": 0.5,
+    }
+    return lookup[va] if isinstance(va, str) else va

plotnine/doctools.py

@@ -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/strips.py

@@ -67,56 +67,45 @@ class strip:
         if position == "top":
             # The x & y values are just starting locations
             # The final location is determined by the layout manager.
-            y = 1
+            bg_y = 1
             ha = theme.getp(("strip_text_x", "ha"), "center")
-            va = theme.getp(("strip_text_x", "va"), "bottom")
+            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 = (
-                theme.getp(("strip_text_x", "margin")).to("lines").b
-            )
+            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 = theme.getp(("strip_text_y", "ha"), "left")
+            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 = (
-                theme.getp(("strip_text_y", "margin")).to("lines").r
-            )
+            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/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,
         )
 

plotnine/helpers.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+from copy import deepcopy
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from typing import Sequence
+
+    from plotnine import ggplot
+
+__all__ = ("get_aesthetic_limits",)
+
+
+def get_aesthetic_limits(
+    plot: ggplot,
+    ae: str,
+) -> (
+    tuple[float, float]
+    | Sequence[str]
+    | list[tuple[float]]
+    | list[Sequence[str]]
+):
+    """
+    Get the limits of an aesthetic
+
+    These are the limits before they are expanded.
+
+    Parameters
+    ----------
+    plot :
+        ggplot object
+
+    ae :
+        Name of aesthetic
+
+    Returns
+    -------
+    out :
+        The limits of the aesthetic. If the plot is facetted, (has many
+        panels), it is a sequence of limits, one for each panel.
+    """
+    plot = deepcopy(plot)
+    plot._build()
+    limits = [
+        getattr(panel, ae).limits
+        for panel in plot._build_objs.layout.panel_params
+    ]
+
+    return limits[0] if len(limits) == 1 else limits

plotnine/iapi.py

@@ -10,6 +10,7 @@ from __future__ import annotations
 import itertools
 from copy import copy
 from dataclasses import dataclass, field, fields
+from functools import cached_property
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -19,6 +20,7 @@ if TYPE_CHECKING:
     from matplotlib.figure import Figure
 
     from plotnine.scales.scale import scale
+    from plotnine.themes.elements.margin import margin
     from plotnine.typing import (
         CoordRange,
         FloatArrayLike,
@@ -231,13 +233,27 @@ class strip_draw_info:
     Information required to draw strips
     """
 
-    x: float
-    y: float
+    bg_x: float
+    """Left of the strip background in transAxes"""
+
+    bg_y: float
+    """Bottom of the strip background in transAxes"""
+
     ha: HorizontalJustification | float
+    """Horizontal justification of strip text within the background"""
+
     va: VerticalJustification | float
-    box_width: float
-    box_height: float
-    strip_text_margin: float
+    """Vertical justification of strip text within the background"""
+
+    bg_width: float
+    """Width of the strip background in transAxes"""
+
+    bg_height: float
+    """Height of the strip background in transAxes"""
+
+    margin: margin
+    """Strip text margin with the units in lines"""
+
     strip_align: float
     position: StripPosition
     label: str
@@ -245,6 +261,13 @@ class strip_draw_info:
     rotation: float
     layout: layout_details
 
+    @cached_property
+    def is_oneline(self) -> bool:
+        """
+        Whether the strip text is a single line
+        """
+        return len(self.label.split("\n")) == 1
+
 
 @dataclass
 class strip_label_details:

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,7 @@ class scale_size_identity(
 
     _aesthetics = ["size"]
     _: KW_ONLY
-    guide: Literal["legend"] | None = "legend"
+    guide: Literal["legend"] | None = None
 
 
 # American to British spelling

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/stat_bindot.py

@@ -281,9 +281,7 @@ def densitybin(
     if all(pd.isna(x)):
         return pd.DataFrame()
 
-    if weight is None:
-        weight = np.ones(len(x))
-    weight = np.asarray(weight)
+    weight = np.ones(len(x)) if weight is None else np.array(list(weight))
     weight[np.isnan(weight)] = 0
 
     if rangee is None:

plotnine/stats/stat_density.py

@@ -102,9 +102,9 @@ class stat_density(stat):
                 # useful for stacked density plots
 
     'scaled'    # density estimate, scaled to maximum of 1
+    'n'         # Number of observations at a position
     ```
 
-        'n'         # Number of observations at a position
 
     """
     REQUIRED_AES = {"x"}

plotnine/themes/elements/__init__.py

@@ -2,7 +2,7 @@ from .element_blank import element_blank
 from .element_line import element_line
 from .element_rect import element_rect
 from .element_text import element_text
-from .margin import margin
+from .margin import margin, margin_auto
 
 __all__ = (
     "element_blank",
@@ -10,4 +10,5 @@ __all__ = (
     "element_rect",
     "element_text",
     "margin",
+    "margin_auto",
 )

plotnine/themes/elements/margin.py

@@ -1,5 +1,5 @@
 """
-Theme elements used to decorate the graph.
+Margin
 """
 
 from __future__ import annotations
@@ -17,17 +17,55 @@ if TYPE_CHECKING:
 
 @dataclass
 class margin:
+    """
+    Margin
+    """
+
     t: float = 0
+    """
+    Top margin
+    """
+
     r: float = 0
+    """
+    Right margin
+    """
+
     b: float = 0
+    """
+    Bottom margin
+    """
+
     l: float = 0
+    """
+    Left Margin
+    """
+
     unit: Literal["pt", "in", "lines", "fig"] = "pt"
+    """
+    The units (coordinate space) of the values
+    """
 
     # These are set by the themeable when it is applied
     fontsize: float = field(init=False, default=0)
+    """
+    Font size of text that this margin applies to
+    """
+
     figure_size: tuple[float, float] = field(init=False, default=(0, 0))
+    """
+    Size of the figure in inches
+    """
 
     def setup(self, theme: theme, themeable_name: str):
+        """
+        Setup the margin to be used in the layout
+
+        For the margin's values to be useful, we need to be able to
+        convert them to different units as is required. Here we get
+        all the parameters that we shall need to do the conversions.
+        """
+        self.themeable_name = themeable_name
         self.fontsize = theme.getp((themeable_name, "size"), 11)
         self.figure_size = theme.getp("figure_size")
 
@@ -35,6 +73,8 @@ class margin:
     def pt(self) -> margin:
         """
         Return margin in points
+
+        These are the units of the display coordinate system
         """
         return self.to("pt")
 
@@ -42,6 +82,8 @@ class margin:
     def inch(self) -> margin:
         """
         Return margin in inches
+
+        These are the units of the figure-inches coordinate system
         """
         return self.to("in")
 
@@ -56,6 +98,8 @@ class margin:
     def fig(self) -> margin:
         """
         Return margin in figure units
+
+        These are the units of the figure coordinate system
         """
         return self.to("fig")
 
@@ -102,3 +146,22 @@ class margin:
         }
 
         return functions[conversion](value)
+
+
+def margin_auto(
+    t: float = 0.0,
+    r: float | None = None,
+    b: float | None = None,
+    l: float | None = None,
+    unit: Literal["pt", "in", "lines", "fig"] = "pt",
+) -> margin:
+    """
+    Create margin with minimal arguments
+    """
+    if r is None:
+        r = t
+    if b is None:
+        b = t
+    if l is None:
+        l = r
+    return margin(t, r, b, l, unit)

plotnine/themes/theme_gray.py

@@ -6,6 +6,7 @@ from .elements import (
     element_rect,
     element_text,
     margin,
+    margin_auto,
 )
 from .theme import theme
 
@@ -27,6 +28,7 @@ class theme_gray(theme):
 
     def __init__(self, base_size=11, base_family=None):
         base_family = base_family or get_option("base_family")
+        half_line = base_size / 2
         quarter_line = base_size / 4
         fifth_line = base_size / 5
         eighth_line = base_size / 8
@@ -88,7 +90,7 @@ class theme_gray(theme):
             legend_spacing=10,  # points
             legend_text=element_text(
                 size=base_size * 0.8,
-                margin=margin(m / 1.5, m / 1.5, m / 1.5, m / 1.5, "fig"),
+                margin=margin_auto(m / 1.5, unit="fig"),
             ),
             legend_ticks=element_line(color="#CCCCCC", size=1),
             legend_title=element_text(
@@ -135,8 +137,8 @@ class theme_gray(theme):
             strip_text=element_text(
                 color="#1A1A1A",
                 size=base_size * 0.8,
-                linespacing=1.0,
-                margin=margin(1 / 3, 1 / 3, 1 / 3, 1 / 3, "lines"),
+                linespacing=1.5,
+                margin=margin_auto(half_line * 0.8),
             ),
             strip_text_y=element_text(rotation=-90),
             complete=True,

plotnine/themes/theme_matplotlib.py

@@ -5,6 +5,7 @@ from .elements import (
     element_rect,
     element_text,
     margin,
+    margin_auto,
 )
 from .theme import theme
 
@@ -33,6 +34,7 @@ class theme_matplotlib(theme):
         m = get_option("base_margin")
         base_size = mpl.rcParams.get("font.size", 11)
         linewidth = mpl.rcParams.get("grid.linewidth", 0.8)
+        half_line = base_size / 2
 
         super().__init__(
             line=element_line(size=linewidth),
@@ -68,9 +70,7 @@ class theme_matplotlib(theme):
             legend_margin=0,
             legend_position="right",
             legend_spacing=10,
-            legend_text=element_text(
-                margin=margin(m / 2, m / 2, m / 2, m / 2, "fig")
-            ),
+            legend_text=element_text(margin=margin_auto(m / 2, unit="fig")),
             legend_ticks=element_line(color="black"),
             legend_title=element_text(
                 ha="left",
@@ -111,7 +111,8 @@ class theme_matplotlib(theme):
                 fill="#D9D9D9", color="black", size=linewidth
             ),
             strip_text=element_text(
-                margin=margin(1 / 3, 1 / 3, 1 / 3, 1 / 3, "lines"),
+                linespacing=1.5,
+                margin=margin_auto(half_line * 0.8),
             ),
             strip_text_y=element_text(rotation=-90),
             complete=True,

plotnine/themes/theme_seaborn.py

@@ -5,6 +5,7 @@ from .elements import (
     element_rect,
     element_text,
     margin,
+    margin_auto,
 )
 from .theme import theme
 
@@ -20,7 +21,7 @@ class theme_seaborn(theme):
 
     Parameters
     ----------
-    style: "whitegrid", "darkgrid", "nogrid", "ticks"
+    style: "white", "dark", "whitegrid", "darkgrid",  "ticks"
         Style of axis background.
     context: "notebook", "talk", "paper", "poster"]``
         Intended context for resulting figures.
@@ -83,13 +84,15 @@ class theme_seaborn(theme):
             legend_position="right",
             legend_spacing=10,  # points
             legend_text=element_text(
-                margin=margin(m / 1.5, m / 1.5, m / 1.5, m / 1.5, "fig")
+                size=base_size * 0.8,
+                margin=margin_auto(m / 1.5, unit="fig"),
             ),
             legend_ticks=element_line(color="#CCCCCC", size=1),
             legend_title=element_text(
                 margin=margin(t=m, l=m * 2, b=m / 2, r=m * 2, unit="fig")
             ),
             panel_spacing=m,
+            panel_background=element_rect(fill=rcparams["axes.facecolor"]),
             plot_caption=element_text(
                 size=base_size * 0.8,
                 ha="right",
@@ -123,8 +126,8 @@ class theme_seaborn(theme):
             strip_background=element_rect(color="none", fill="#D1CDDF"),
             strip_text=element_text(
                 size=base_size * 0.8,
-                linespacing=1.0,
-                margin=margin(1 / 3, 1 / 3, 1 / 3, 1 / 3, "lines"),
+                linespacing=1.5,
+                margin=margin_auto(half_line * 0.8),
             ),
             strip_text_y=element_text(rotation=-90),
             complete=True,

plotnine/themes/theme_void.py

@@ -1,5 +1,11 @@
 from ..options import get_option
-from .elements import element_blank, element_line, element_text, margin
+from .elements import (
+    element_blank,
+    element_line,
+    element_text,
+    margin,
+    margin_auto,
+)
 from .theme import theme
 
 
@@ -19,6 +25,7 @@ class theme_void(theme):
 
     def __init__(self, base_size=11, base_family=None):
         base_family = base_family or get_option("base_family")
+        half_line = base_size / 2
         m = get_option("base_margin")
         # Use only inherited elements and make everything blank
         theme.__init__(
@@ -54,7 +61,7 @@ class theme_void(theme):
             legend_spacing=10,
             legend_text=element_text(
                 size=base_size * 0.8,
-                margin=margin(m / 1.5, m / 1.5, m / 1.5, m / 1.5, "fig"),
+                margin=margin_auto(m / 1.5, unit="fig"),
             ),
             legend_ticks=element_line(color="#CCCCCC", size=1),
             legend_title=element_text(
@@ -94,8 +101,8 @@ class theme_void(theme):
             strip_text=element_text(
                 color="#1A1A1A",
                 size=base_size * 0.8,
-                linespacing=1.0,
-                margin=margin(1 / 3, 1 / 3, 1 / 3, 1 / 3, "lines"),
+                linespacing=1.5,
+                margin=margin_auto(half_line * 0.8),
             ),
             complete=True,
         )

plotnine/themes/themeable.py

@@ -852,7 +852,7 @@ class strip_text_x(MixinSequenceOfValues):
     theme_element : element_text
     """
 
-    _omit = ["margin", "ha"]
+    _omit = ["margin", "ha", "va"]
 
     def apply_figure(self, figure: Figure, targets: ThemeTargets):
         super().apply_figure(figure, targets)
@@ -875,7 +875,7 @@ class strip_text_y(MixinSequenceOfValues):
     theme_element : element_text
     """
 
-    _omit = ["margin", "va"]
+    _omit = ["margin", "ha", "va"]
 
     def apply_figure(self, figure: Figure, targets: ThemeTargets):
         super().apply_figure(figure, targets)

plotnine/typing.py

@@ -80,7 +80,7 @@ FacetSpaceRatios: TypeAlias = dict[Literal["x", "y"], Sequence[float]]
 
 StripPosition: TypeAlias = Literal["top", "right"]
 
-## Scales
+# Scales
 
 # Name names of scaled aesthetics
 ScaledAestheticsName: TypeAlias = Literal[
@@ -110,7 +110,7 @@ ScaledAestheticsName: TypeAlias = Literal[
     "upper",
 ]
 
-## Coords
+# Coords
 CoordRange: TypeAlias = tuple[float, float]
 
 # Guide