plotnine 0.15.0.dev2__py3-none-any.whl → 0.15.1__py3-none-any.whl

plotnine/stats/stat_unique.py

@@ -12,10 +12,13 @@ class stat_unique(stat):
     Parameters
     ----------
     {common_parameters}
+
+    See Also
+    --------
+    plotnine.geom_point : The default `geom` for this `stat`.
     """
 
     DEFAULT_PARAMS = {"geom": "point", "position": "identity", "na_rm": False}
 
-    @classmethod
-    def compute_panel(cls, data, scales, **params):
+    def compute_panel(self, data, scales):
         return data.drop_duplicates()

plotnine/stats/stat_ydensity.py

@@ -69,7 +69,7 @@ class stat_ydensity(stat):
 
     See Also
     --------
-    plotnine.geom_violin
+    plotnine.geom_violin : The default `geom` for this `stat`.
     statsmodels.nonparametric.kde.KDEUnivariate
     statsmodels.nonparametric.kde.KDEUnivariate.fit
     """
@@ -109,7 +109,7 @@ class stat_ydensity(stat):
         return data
 
     def setup_params(self, data):
-        params = self.params.copy()
+        params = self.params
 
         valid_scale = ("area", "count", "width")
         if params["scale"] not in valid_scale:
@@ -141,11 +141,9 @@ class stat_ydensity(stat):
         for key in missing_params:
             params[key] = stat_density.DEFAULT_PARAMS[key]
 
-        return params
-
-    @classmethod
-    def compute_panel(cls, data, scales, **params):
-        data = super(cls, cls).compute_panel(data, scales, **params)
+    def compute_panel(self, data, scales):
+        params = self.params
+        data = super().compute_panel(data, scales)
 
         if not len(data):
             return data
@@ -167,20 +165,19 @@ class stat_ydensity(stat):
 
         return data
 
-    @classmethod
-    def compute_group(cls, data, scales, **params):
+    def compute_group(self, data, scales):
         n = len(data)
         if n == 0:
             return pd.DataFrame()
 
         weight = data.get("weight")
 
-        if params["trim"]:
+        if self.params["trim"]:
             range_y = data["y"].min(), data["y"].max()
         else:
             range_y = scales.y.dimension()
 
-        dens = compute_density(data["y"], weight, range_y, **params)
+        dens = compute_density(data["y"], weight, range_y, self.params)
 
         if not len(dens):
             return dens

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

@@ -5,7 +5,7 @@ from typing import TYPE_CHECKING
 from .element_base import element_base
 
 if TYPE_CHECKING:
-    from typing import Any, Literal, Optional, Sequence
+    from typing import Any, Literal, Sequence
 
 
 class element_line(element_base):
@@ -26,6 +26,8 @@ class element_line(element_base):
         using tuples, see [](`~matplotlib.lines.line2D.set_linestyle`).
     size : float
         line thickness
+    alpha : float
+        Opacity value
     kwargs : dict
         Parameters recognised by [](`~matplotlib.lines.line2d`).
     """
@@ -33,31 +35,37 @@ class element_line(element_base):
     def __init__(
         self,
         *,
-        color: Optional[
+        color: (
             str
             | tuple[float, float, float]
             | tuple[float, float, float, float]
-        ] = None,
-        size: Optional[float] = None,
-        linetype: Optional[str | Sequence[int]] = None,
-        lineend: Optional[Literal["butt", "projecting", "round"]] = None,
-        colour: Optional[
+            | None
+        ) = None,
+        size: float | None = None,
+        linetype: str | Sequence[int] | None = None,
+        lineend: Literal["butt", "projecting", "round"] | None = None,
+        colour: (
             str
             | tuple[float, float, float]
             | tuple[float, float, float, float]
-        ] = None,
+            | None
+        ) = None,
+        alpha: float | None = None,
         **kwargs: Any,
     ):
         super().__init__()
         self.properties.update(**kwargs)
 
-        color = color if color else colour
+        color = color if color is not None else colour
+
         if color:
             self.properties["color"] = color
         if size:
             self.properties["linewidth"] = size
         if linetype:
             self.properties["linestyle"] = linetype
+        if alpha is not None:
+            self.properties["alpha"] = alpha
 
         if linetype in ("solid", "-") and lineend:
             self.properties["solid_capstyle"] = lineend

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

@@ -72,7 +72,7 @@ class theme:
         ```
 
         will only modify the x-axis text.
-    kwargs: dict
+    kwargs: Any
         kwargs are `themeables`. The themeables are elements that are
         subclasses of `themeable`. Many themeables are defined using
         theme elements i.e
@@ -276,6 +276,14 @@ class theme:
         """
         return self.themeables.getp((name, "margin"))
 
+    @cached_property
+    def get_ha(self):
+        return self.themeables.get_ha
+
+    @cached_property
+    def get_va(self):
+        return self.themeables.get_va
+
     def apply(self):
         """
         Apply this theme, then apply additional modifications in order.

plotnine/themes/theme_538.py

@@ -23,7 +23,6 @@ class theme_538(theme_gray):
             axis_ticks=element_blank(),
             title=element_text(color="#3C3C3C"),
             legend_background=element_rect(fill="none"),
-            legend_key=element_rect(fill="#E0E0E0"),
             panel_background=element_rect(fill=bgcolor),
             panel_border=element_blank(),
             panel_grid_major=element_line(color="#D5D5D5"),

plotnine/themes/theme_bw.py

@@ -20,7 +20,6 @@ class theme_bw(theme_gray):
         super().__init__(base_size, base_family)
         self += theme(
             axis_text=element_text(size=0.8 * base_size),
-            legend_key=element_rect(fill="none", color="#CCCCCC"),
             panel_background=element_rect(fill="white"),
             panel_border=element_rect(fill="none", color="#7f7f7f"),
             panel_grid_major=element_line(color="#E5E5E5"),

plotnine/themes/theme_dark.py

@@ -24,7 +24,6 @@ class theme_dark(theme_gray):
         self += theme(
             axis_ticks=element_line(color="#666666", size=0.5),
             axis_ticks_minor=element_blank(),
-            legend_key=element_rect(fill="#7F7F7F", color="#666666", size=0.5),
             panel_background=element_rect(fill="#7F7F7F", color="none"),
             panel_grid_major=element_line(color="#666666", size=0.5),
             panel_grid_minor=element_line(color="#737373", size=0.25),

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
@@ -81,7 +83,6 @@ class theme_gray(theme):
             legend_frame=element_blank(),
             legend_key_spacing_x=6,
             legend_key_spacing_y=2,
-            legend_key=element_rect(fill="#F2F2F2", colour="none"),
             legend_key_size=base_size * 0.8 * 1.8,
             legend_ticks_length=0.2,
             legend_margin=0,  # points
@@ -89,13 +90,13 @@ 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(
                 margin=margin(t=m, l=m * 2, b=m / 2, r=m * 2, unit="fig")
             ),
-            panel_background=element_rect(fill="#EBEBEB"),
+            panel_background=element_rect(fill="#EBEBEB", color="none"),
             panel_border=element_blank(),
             panel_grid_major=element_line(color="white", size=1),
             panel_grid_minor=element_line(color="white", size=0.5),
@@ -136,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_light.py

@@ -24,7 +24,7 @@ class theme_light(theme_gray):
         self += theme(
             axis_ticks=element_line(color="#B3B3B3", size=0.5),
             axis_ticks_minor=element_blank(),
-            legend_key=element_rect(fill="white", color="#7F7F7F", size=0.72),
+            legend_key=element_rect(color="#7F7F7F", size=0.72),
             panel_background=element_rect(fill="white"),
             panel_border=element_rect(fill="none", color="#B3B3B3", size=1),
             panel_grid_major=element_line(color="#D9D9D9", size=0.5),

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),
@@ -63,15 +65,12 @@ class theme_matplotlib(theme):
             legend_key_spacing_x=6,
             legend_key_spacing_y=2,
             legend_frame=element_rect(color="black"),
-            legend_key=element_blank(),
             legend_key_size=16,
             legend_ticks_length=0.2,
             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",
@@ -112,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
 
 
@@ -54,7 +60,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(
@@ -91,11 +97,6 @@ class theme_void(theme):
             plot_tag_location="margin",
             plot_tag_position="topleft",
             strip_align=0,
-            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"),
-            ),
+            strip_text=element_text(size=base_size * 0.8),
             complete=True,
         )

plotnine/themes/theme_xkcd.py

@@ -50,7 +50,6 @@ class theme_xkcd(theme_gray):
             legend_background=element_rect(color="black"),
             legend_box_margin=2,
             legend_margin=5,
-            legend_key=element_rect(fill="none"),
             panel_border=element_rect(color="black", size=1),
             panel_grid=element_blank(),
             panel_background=element_rect(fill="white"),