plotnine 0.15.0a5__py3-none-any.whl → 0.15.0a7__py3-none-any.whl

plotnine/composition/_plot_spacer.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from copy import deepcopy
+
+from plotnine import element_rect, ggplot, theme, theme_void
+
+
+class plot_spacer(ggplot):
+    """
+    Blank area as wide or as tall as a plot
+
+    Parameters
+    ----------
+    fill :
+        Background color. The default is a transparent area, but it
+        can be changed through this parameter.
+
+        The color can also be modified by adding a [](`~plotnine.theme`)
+        and setting the [](`~plotnine.themes.themeable.plot_background`).
+
+    See Also
+    --------
+    plotnine.composition.Beside : To arrange plots side by side
+    plotnine.composition.Stack : To arrange plots vertically
+    plotnine.composition.Arrange : For more on arranging plots
+    """
+
+    def __init__(
+        self,
+        fill: (
+            str
+            | tuple[float, float, float]
+            | tuple[float, float, float, float]
+            | None
+        ) = None,
+    ):
+        super().__init__()
+        self.theme = theme_void()
+        if fill:
+            self.theme += theme(plot_background=element_rect(fill=fill))
+
+    def __add__(self, rhs) -> plot_spacer:
+        """
+        Add to spacer
+
+        All added objects are no ops except the `plot_background` in
+        in a theme.
+        """
+        self = deepcopy(self)
+        if isinstance(rhs, theme):
+            fill = rhs.getp(("plot_background", "facecolor"))
+            self.theme += theme(
+                plot_background=element_rect(fill=fill),
+            )
+        return self

plotnine/composition/_stack.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+from ._arrange import Arrange
+
+if TYPE_CHECKING:
+    from plotnine.ggplot import ggplot
+
+
+@dataclass
+class Stack(Arrange):
+    """
+    Place plots or compositions on top of each other
+
+    **Usage**
+
+        plot / plot
+        plot / composition
+        composition / plot
+        composition / composition
+
+    Typically, you will use this class through the `/` operator.
+
+    See Also
+    --------
+    plotnine.composition.Beside : To arrange plots side by side
+    plotnine.composition.plot_spacer : To add a blank space between plots
+    """
+
+    @property
+    def nrow(self) -> int:
+        return len(self)
+
+    @property
+    def ncol(self) -> int:
+        return 1
+
+    def __truediv__(self, rhs: ggplot | Arrange) -> Arrange:
+        """
+        Add rhs as a row
+        """
+        # This is an adjacent div i.e. (DIV | rhs) so we collapse the
+        # operands into a single operation
+        return Stack([*self, rhs])
+
+    def __or__(self, rhs: ggplot | Arrange) -> Arrange:
+        """
+        Add rhs as a column
+        """
+        from ._beside import Beside
+
+        return Beside([self, rhs])

plotnine/geoms/geom_area.py

@@ -14,12 +14,12 @@ class geom_area(geom_ribbon):
     """
     Area plot
 
+    {usage}
+
     An area plot is a special case of geom_ribbon,
     where the minimum of the range is fixed to 0,
     and the position adjustment defaults to 'stack'.
 
-    {usage}
-
     Parameters
     ----------
     {common_parameters}

plotnine/geoms/geom_bar.py

@@ -32,6 +32,7 @@ class geom_bar(geom_rect):
     See Also
     --------
     plotnine.geom_histogram
+    plotnine.stat_count : The default `stat` for this `geom`.
     """
 
     REQUIRED_AES = {"x", "y"}

plotnine/geoms/geom_bin_2d.py

@@ -7,16 +7,20 @@ class geom_bin_2d(geom_rect):
     """
     Heatmap of 2d bin counts
 
+    {usage}
+
     Divides the plane into rectangles, counts the number of
     cases in each rectangle, and then (by default) maps the number
     of cases to the rectangle's fill. This is a useful alternative
     to geom_point in the presence of overplotting.
 
-    {usage}
-
     Parameters
     ----------
     {common_parameters}
+
+    See Also
+    --------
+    plotnine.stat_bin_2d : The default stat for this `geom`.
     """
 
     DEFAULT_PARAMS = {"stat": "bin_2d", "position": "identity", "na_rm": False}

plotnine/geoms/geom_boxplot.py

@@ -70,6 +70,10 @@ class geom_boxplot(geom):
     fatten : float, default=2
         A multiplicative factor used to increase the size of the
         middle bar across the box.
+
+    See Also
+    --------
+    plotnine.stat_boxplot : The default `stat` for this `geom`.
     """
 
     DEFAULT_AES = {

plotnine/geoms/geom_col.py

@@ -7,13 +7,13 @@ class geom_col(geom_bar):
     """
     Bar plot with base on the x-axis
 
+    {usage}
+
     This is an alternate version of [](`~plotnine.geoms.geom_bar`) that maps
     the height of bars to an existing variable in your data. If
     you want the height of the bar to represent a count of cases,
     use [](`~plotnine.geoms.geom_bar`).
 
-    {usage}
-
     Parameters
     ----------
     {common_parameters}

plotnine/geoms/geom_count.py

@@ -7,15 +7,19 @@ class geom_count(geom_point):
     """
     Plot overlapping points
 
+    {usage}
+
     This is a variant [](`~plotnine.geoms.geom_point`) that counts the number
     of observations at each location, then maps the count to point
     area. It useful when you have discrete data and overplotting.
 
-    {usage}
-
     Parameters
     ----------
     {common_parameters}
+
+    See Also
+    --------
+    plotnine.stat_sum : The default `stat` for this `geom`.
     """
 
     DEFAULT_PARAMS = {"stat": "sum", "position": "identity", "na_rm": False}

plotnine/geoms/geom_density_2d.py

@@ -7,13 +7,17 @@ class geom_density_2d(geom_path):
     """
     2D density estimate
 
-    This is a 2d version of [](`~plotnine.geoms.geom_density`).
-
     {usage}
 
+    This is a 2d version of [](`~plotnine.geoms.geom_density`).
+
     Parameters
     ----------
     {common_parameters}
+
+    See Also
+    --------
+    plotnine.stat_density_2d : The default `stat` for this `geom`.
     """
 
     DEFAULT_PARAMS = {

plotnine/geoms/geom_dotplot.py

@@ -46,7 +46,7 @@ class geom_dotplot(geom):
 
     See Also
     --------
-    plotnine.stat_bindot
+    plotnine.stat_bindot : The default `stat` for this `geom`.
     """
 
     DEFAULT_AES = {"alpha": 1, "color": "black", "fill": "black"}

plotnine/geoms/geom_histogram.py

@@ -15,7 +15,7 @@ class geom_histogram(geom_bar):
 
     See Also
     --------
-    plotnine.geom_bar
+    plotnine.geom_bar : The default `stat` for this `geom`.
     """
 
     DEFAULT_PARAMS = {"stat": "bin", "position": "stack", "na_rm": False}

plotnine/geoms/geom_map.py

@@ -33,10 +33,10 @@ class geom_map(geom):
     """
     Draw map feature
 
-    The map feature are drawn without any special projections.
-
     {usage}
 
+    The map feature are drawn without any special projections.
+
     Parameters
     ----------
     {common_parameters}

plotnine/geoms/geom_pointdensity.py

@@ -12,6 +12,10 @@ class geom_pointdensity(geom_point):
     Parameters
     ----------
     {common_parameters}
+
+    See Also
+    --------
+    plotnine.stat_pointdensity : The default `stat` for this `geom`.
     """
 
     DEFAULT_PARAMS = {

plotnine/geoms/geom_qq.py

@@ -12,6 +12,10 @@ class geom_qq(geom_point):
     Parameters
     ----------
     {common_parameters}
+
+    See Also
+    --------
+    plotnine.stat_qq : The default `stat` for this `geom`.
     """
 
     DEFAULT_PARAMS = {"stat": "qq", "position": "identity", "na_rm": False}

plotnine/geoms/geom_qq_line.py

@@ -12,6 +12,10 @@ class geom_qq_line(geom_path):
     Parameters
     ----------
     {common_parameters}
+
+    See Also
+    --------
+    plotnine.stat_qq_line : The default `stat` for this `geom`.
     """
 
     DEFAULT_PARAMS = {

plotnine/geoms/geom_quantile.py

@@ -16,6 +16,10 @@ class geom_quantile(geom_path):
         Line end style. This option is applied for solid linetypes.
     linejoin : Literal["round", "miter", "bevel"], default="round"
         Line join style. This option is applied for solid linetypes.
+
+    See Also
+    --------
+    plotnine.stat_quantile : The default `stat` for this `geom`.
     """
 
     DEFAULT_AES = {

plotnine/geoms/geom_sina.py

@@ -7,20 +7,20 @@ class geom_sina(geom_point):
     """
     Draw a sina plot
 
+    {usage}
+
     A sina plot is a data visualization chart suitable for plotting
     any single variable in a multiclass dataset. It is an enhanced
     jitter strip chart, where the width of the jitter is controlled
     by the density distribution of the data within each class.
 
-    {usage}
-
     Parameters
     ----------
     {common_parameters}
 
     See Also
     --------
-    plotnine.stat_sina
+    plotnine.stat_sina : The default `stat` for this `geom`.
 
     References
     ----------

plotnine/geoms/geom_smooth.py

@@ -34,6 +34,10 @@ class geom_smooth(geom):
         How much (vertically) of the legend box should be filled by
         the color that indicates the confidence intervals. Should be
         in the range [0, 1].
+
+    See Also
+    --------
+    plotnine.stat_smooth : The default `stat` for this `geom`.
     """
 
     DEFAULT_AES = {

plotnine/geoms/geom_violin.py

@@ -45,6 +45,10 @@ class geom_violin(geom):
         'left-right'  # Alternate (left first) half violins by the group
         'right-left'  # Alternate (right first) half violins by the group
         ```
+
+    See Also
+    --------
+    plotnine.stat_ydensity : The default `stat` for this `geom`.
     """
 
     DEFAULT_AES = {

plotnine/ggplot.py

@@ -13,7 +13,6 @@ from typing import (
     Iterable,
     Optional,
     cast,
-    overload,
 )
 from warnings import warn
 
@@ -53,10 +52,10 @@ if TYPE_CHECKING:
 
     from plotnine import watermark
     from plotnine._mpl.gridspec import p9GridSpec
+    from plotnine.composition import Arrange
     from plotnine.coords.coord import coord
     from plotnine.facets.facet import facet
     from plotnine.layer import layer
-    from plotnine.plot_composition import Compose
     from plotnine.typing import DataLike
 
     class PlotAddable(Protocol):
@@ -230,18 +229,10 @@ class ggplot:
             other.__radd__(self)
         return self
 
-    @overload
-    def __add__(
-        self, rhs: PlotAddable | list[PlotAddable] | None
-    ) -> ggplot: ...
-
-    @overload
-    def __add__(self, rhs: ggplot | Compose) -> Compose: ...
-
     def __add__(
         self,
-        rhs: PlotAddable | list[PlotAddable] | None | ggplot | Compose,
-    ) -> ggplot | Compose:
+        rhs: PlotAddable | list[PlotAddable] | None,
+    ) -> ggplot:
         """
         Add to ggplot
 
@@ -251,37 +242,32 @@ class ggplot:
             Either an object that knows how to "radd"
             itself to a ggplot, or a list of such objects.
         """
-        from .plot_composition import ADD, Compose
-
-        if isinstance(rhs, (ggplot, Compose)):
-            return ADD([self, rhs])
-
         self = deepcopy(self)
         return self.__iadd__(rhs)
 
-    def __or__(self, rhs: ggplot | Compose) -> Compose:
+    def __or__(self, rhs: ggplot | Arrange) -> Arrange:
         """
         Compose 2 plots columnwise
         """
-        from .plot_composition import OR
+        from .composition import Beside
 
-        return OR([self, rhs])
+        return Beside([self, rhs])
 
-    def __truediv__(self, rhs: ggplot | Compose) -> Compose:
+    def __truediv__(self, rhs: ggplot | Arrange) -> Arrange:
         """
         Compose 2 plots rowwise
         """
-        from .plot_composition import DIV
+        from .composition import Stack
 
-        return DIV([self, rhs])
+        return Stack([self, rhs])
 
-    def __sub__(self, rhs: ggplot | Compose) -> Compose:
+    def __sub__(self, rhs: ggplot | Arrange) -> Arrange:
         """
         Compose 2 plots columnwise
         """
-        from .plot_composition import OR
+        from .composition import Beside
 
-        return OR([self, rhs])
+        return Beside([self, rhs])
 
     def __rrshift__(self, other: DataLike) -> ggplot:
         """

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
@@ -29,6 +30,7 @@ class _scale_manual(scale_discrete):
             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))
 

plotnine/stats/stat_bin.py

@@ -53,6 +53,10 @@ class stat_bin(stat):
     pad : bool, default=False
         If `True`{.py}, adds empty bins at either side of x.
         This ensures that frequency polygons touch 0.
+
+    See Also
+    --------
+    plotnine.histogram : The default `geom` for this `stat`.
     """
 
     _aesthetics_doc = """

plotnine/stats/stat_bin_2d.py

@@ -35,6 +35,10 @@ class stat_bin_2d(stat):
         the stories in your data.
     drop : bool, default=False
         If `True`{.py}, removes all cells with zero counts.
+
+    See Also
+    --------
+    plotnine.geom_rect : The default `geom` for this `stat`.
     """
 
     _aesthetics_doc = """

plotnine/stats/stat_bindot.py

@@ -68,6 +68,7 @@ class stat_bindot(stat):
 
     See Also
     --------
+    plotnine.geom_dotplot : The default `geom` for this `stat`.
     plotnine.stat_bin
     """
 

plotnine/stats/stat_boxplot.py

@@ -22,7 +22,7 @@ class stat_boxplot(stat):
 
     See Also
     --------
-    plotnine.geom_boxplot
+    plotnine.geom_boxplot: The default `geom` for this `stat`.
     """
 
     _aesthetics_doc = """

plotnine/stats/stat_count.py

@@ -23,6 +23,7 @@ class stat_count(stat):
 
     See Also
     --------
+    plotnine.geom_histogram : The default `geom` for this `stat`.
     plotnine.stat_bin
     """
 

plotnine/stats/stat_density.py

@@ -85,7 +85,7 @@ class stat_density(stat):
 
     See Also
     --------
-    plotnine.geom_density
+    plotnine.geom_density : The default `geom` for this `stat`.
     statsmodels.nonparametric.kde.KDEUnivariate
     statsmodels.nonparametric.kde.KDEUnivariate.fit
     """

plotnine/stats/stat_density_2d.py

@@ -37,6 +37,7 @@ class stat_density_2d(stat):
 
     See Also
     --------
+    plotnine.geom_density_2d : The default `geom` for this `stat`.
     statsmodels.nonparametric.kernel_density.KDEMultivariate
     scipy.stats.gaussian_kde
     sklearn.neighbors.KernelDensity

plotnine/stats/stat_ecdf.py

@@ -25,7 +25,7 @@ class stat_ecdf(stat):
 
     See Also
     --------
-    plotnine.geom_step
+    plotnine.geom_step : The default `geom` for this `stat`.
     """
 
     _aesthetics_doc = """

plotnine/stats/stat_ellipse.py

@@ -37,6 +37,10 @@ class stat_ellipse(stat):
         The confidence level at which to draw the ellipse.
     segments : int, default=51
         Number of segments to be used in drawing the ellipse.
+
+    See Also
+    --------
+    plotnine.geom_path : The default `geom` for this `stat`.
     """
 
     REQUIRED_AES = {"x", "y"}

plotnine/stats/stat_function.py

@@ -37,6 +37,10 @@ class stat_function(stat):
         then the `xlim` must be provided.
     args : Optional[tuple[Any] | dict[str, Any]], default=None
         Arguments to pass to `fun`.
+
+    See Also
+    --------
+    plotnine.geom_path : The default `geom` for this `stat`.
     """
 
     _aesthetics_doc = """

plotnine/stats/stat_hull.py

@@ -26,6 +26,10 @@ class stat_hull(stat):
         Raised when Qhull encounters an error condition,
         such as geometrical degeneracy when options to resolve are
         not enabled.
+
+    See Also
+    --------
+    plotnine.geom_path : The default `geom` for this `stat`.
     """
 
     _aesthetics_doc = """

plotnine/stats/stat_identity.py

@@ -12,6 +12,10 @@ class stat_identity(stat):
     Parameters
     ----------
     {common_parameters}
+
+    See Also
+    --------
+    plotnine.geom_point : The default `geom` for this `stat`.
     """
 
     DEFAULT_PARAMS = {"geom": "point", "position": "identity", "na_rm": False}

plotnine/stats/stat_pointdensity.py

@@ -24,6 +24,7 @@ class stat_pointdensity(stat):
 
     See Also
     --------
+    plotnine.geom_density_2d : The default `geom` for this `stat`.
     statsmodels.nonparametric.kde.KDEMultivariate
     scipy.stats.gaussian_kde
     sklearn.neighbors.KernelDensity

plotnine/stats/stat_qq.py

@@ -47,6 +47,7 @@ class stat_qq(stat):
 
     See Also
     --------
+    plotnine.geom_qq : The default `geom` for this `stat`.
     scipy.stats.mstats.plotting_positions : Uses `alpha_beta`
         to calculate the quantiles.
     """

plotnine/stats/stat_qq_line.py

@@ -41,6 +41,7 @@ class stat_qq_line(stat):
 
     See Also
     --------
+    plotnine.geom_qq_line : The default `geom` for this `stat`.
     scipy.stats.mstats.plotting_positions : Uses `alpha_beta`
         to calculate the quantiles.
     """

plotnine/stats/stat_quantile.py

@@ -29,8 +29,8 @@ class stat_quantile(stat):
 
     See Also
     --------
+    plotnine.geom_quantile : The default `geom` for this `stat`.
     statsmodels.regression.quantile_regression.QuantReg
-    plotnine.geom_quantile
     """
 
     _aesthetics_doc = """

plotnine/stats/stat_sina.py

@@ -69,7 +69,7 @@ class stat_sina(stat):
 
     See Also
     --------
-    plotnine.geom_sina
+    plotnine.geom_sina : The default `geom` for this `stat`.
     """
 
     _aesthetics_doc = """

plotnine/stats/stat_smooth.py

@@ -106,6 +106,7 @@ class stat_smooth(stat):
 
     See Also
     --------
+    plotnine.geom_smooth : The default `geom` for this `stat`.
     statsmodels.regression.linear_model.OLS
     statsmodels.regression.linear_model.WLS
     statsmodels.robust.robust_linear_model.RLM

plotnine/stats/stat_sum.py

@@ -17,6 +17,10 @@ class stat_sum(stat):
     Parameters
     ----------
     {common_parameters}
+
+    See Also
+    --------
+    plotnine.geom_point : The default `geom` for this `stat`.
     """
 
     _aesthetics_doc = """