MatplotLibAPI 4.0.0__tar.gz → 4.0.1__tar.gz

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MatplotLibAPI
-Version: 4.0.0
+Version: 4.0.1
 License-File: LICENSE
 Requires-Python: >=3.8
 Requires-Dist: kaleido

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 [project]
 name = "MatplotLibAPI"
-version = "4.0.0"
+version = "4.0.1"
 readme = "README.md"
 requires-python = ">=3.8"
 dependencies = [

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/accessor.py

@@ -428,16 +428,8 @@ class DataFrameAccessor:
             max_values=max_values,
             center_to_mean=center_to_mean,
         ).fplot(
-            label=label,
-            x=x,
-            y=y,
-            z=z,
             title=title,
             style=style or bubble_style_template,
-            max_values=max_values,
-            center_to_mean=center_to_mean,
-            sort_by=sort_by,
-            ascending=ascending,
             hline=hline,
             vline=vline,
             figsize=figsize,
@@ -897,6 +889,7 @@ class DataFrameAccessor:
         title: Optional[str] = None,
         style: StyleTemplate = AREA_STYLE_TEMPLATE,
         ax: Optional[Axes] = None,
+        **kwargs: Any,
     ) -> Axes:
         """Plot an area chart on existing axes.
 
@@ -916,6 +909,8 @@ class DataFrameAccessor:
             Styling template. The default is ``AREA_STYLE_TEMPLATE``.
         ax : Axes, optional
             Matplotlib axes to plot on. If None, uses the current axes.
+        **kwargs : Any
+            Additional keyword arguments forwarded to the underlying area plot call.
 
         Returns
         -------
@@ -923,14 +918,15 @@ class DataFrameAccessor:
             The Matplotlib axes object with the area chart.
         """
         return aplot_area(
-            pd_df=self._obj,
-            x=x,
-            y=y,
+            self._obj,
+            x,
+            y,
             label=label,
             stacked=stacked,
             title=title,
             style=style,
             ax=ax,
+            **kwargs,
         )
 
     def fplot_area(
@@ -942,6 +938,7 @@ class DataFrameAccessor:
         title: Optional[str] = None,
         style: StyleTemplate = AREA_STYLE_TEMPLATE,
         figsize: Tuple[float, float] = FIG_SIZE,
+        **kwargs: Any,
     ) -> Figure:
         """Plot an area chart on a new figure.
 
@@ -961,6 +958,8 @@ class DataFrameAccessor:
             Styling template. The default is ``AREA_STYLE_TEMPLATE``.
         figsize : tuple[float, float], optional
             Figure size. The default is FIG_SIZE.
+        **kwargs : Any
+            Additional keyword arguments forwarded to the underlying area plot call.
 
         Returns
         -------
@@ -968,14 +967,15 @@ class DataFrameAccessor:
             The new Matplotlib figure with the area chart.
         """
         return fplot_area(
-            pd_df=self._obj,
-            x=x,
-            y=y,
+            self._obj,
+            x,
+            y,
             label=label,
             stacked=stacked,
             title=title,
             style=style,
             figsize=figsize,
+            **kwargs,
         )
 
     def aplot_pie_donut(

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/area.py

@@ -1,9 +1,8 @@
-"""Area chart helpers."""
+"""Area chart helpers for Matplotlib-based area visualizations."""
 
 from typing import Any, Optional, Tuple
 
 import pandas as pd
-import matplotlib.pyplot as plt
 from matplotlib.axes import Axes
 from matplotlib.figure import Figure
 
@@ -15,7 +14,7 @@ from .style_template import (
     string_formatter,
     validate_dataframe,
 )
-from .utils import _get_axis
+from .utils import _get_axis, _merge_kwargs
 
 __all__ = ["AREA_STYLE_TEMPLATE", "aplot_area", "fplot_area"]
 
@@ -39,6 +38,21 @@ class AreaChart(BasePlot):
         label: Optional[str] = None,
         stacked: bool = True,
     ):
+        """Initialize an area chart plotter.
+
+        Parameters
+        ----------
+        pd_df : pd.DataFrame
+            DataFrame containing the data to visualize.
+        x : str
+            Column name used for the x-axis.
+        y : str
+            Column name used for the y-axis values.
+        label : str, optional
+            Column used to split the area into groups. The default is None.
+        stacked : bool, optional
+            Whether grouped areas are stacked. The default is True.
+        """
         super().__init__(pd_df=pd_df)
         self.x = x
         self.y = y
@@ -50,6 +64,52 @@ class AreaChart(BasePlot):
             cols.append(self.label)
         validate_dataframe(self._obj, cols=cols)
 
+    def _plot_grouped_area(
+        self,
+        plot_ax: Axes,
+        **kwargs: Any,
+    ) -> None:
+        """Plot grouped area data using a pivoted dataframe."""
+        pivot_df = self._obj.pivot_table(
+            index=self.x,
+            columns=self.label,
+            values=self.y,
+            aggfunc="sum",
+        ).sort_index()
+
+        plot_kwargs: dict[str, Any] = {
+            "kind": "area",
+            "stacked": self.stacked,
+            "alpha": 0.7,
+            "ax": plot_ax,
+        }
+        pivot_df.plot(**_merge_kwargs(plot_kwargs, kwargs))
+
+        legend = plot_ax.get_legend()
+        if legend is not None:
+            legend.set_title(string_formatter(self.label or ""))
+
+    def _plot_single_area(
+        self,
+        plot_ax: Axes,
+        style: StyleTemplate,
+        **kwargs: Any,
+    ) -> None:
+        """Plot a single-series area chart."""
+        sorted_df = self._obj.sort_values(by=self.x)
+        fill_between_kwargs: dict[str, Any] = {
+            "color": style.font_color,
+            "alpha": 0.4,
+        }
+        merged_fill_between_kwargs = _merge_kwargs(fill_between_kwargs, kwargs)
+
+        plot_ax.fill_between(
+            sorted_df[self.x],
+            sorted_df[self.y],
+            **merged_fill_between_kwargs,
+        )
+        plot_ax.plot(sorted_df[self.x], sorted_df[self.y], color=style.font_color)
+
     def aplot(
         self,
         title: Optional[str] = None,
@@ -68,7 +128,7 @@ class AreaChart(BasePlot):
         ax : Axes, optional
             Matplotlib axes to plot on. If None, use the current axes.
         **kwargs : Any
-            Additional keyword arguments reserved for compatibility.
+            Additional keyword arguments forwarded to the area plotting call.
 
         Returns
         -------
@@ -76,21 +136,16 @@ class AreaChart(BasePlot):
             The Matplotlib axes containing the area chart.
         """
         plot_ax = _get_axis(ax)
+        plot_ax.set_facecolor(style.background_color)
 
         if self.label:
-            pivot_df = self._obj.pivot_table(
-                index=self.x, columns=self.label, values=self.y, aggfunc="sum"
-            ).sort_index()
-            pivot_df.plot(kind="area", stacked=self.stacked, alpha=0.7, ax=plot_ax)
+            self._plot_grouped_area(plot_ax=plot_ax, **kwargs)
         else:
-            sorted_df = self._obj.sort_values(by=self.x)
-            plot_ax.fill_between(
-                sorted_df[self.x], sorted_df[self.y], color=style.font_color, alpha=0.4
-            )
-            plot_ax.plot(sorted_df[self.x], sorted_df[self.y], color=style.font_color)
+            self._plot_single_area(plot_ax=plot_ax, style=style, **kwargs)
 
         plot_ax.set_xlabel(string_formatter(self.x))
         plot_ax.set_ylabel(string_formatter(self.y))
+        plot_ax.tick_params(axis="x", labelrotation=45)
         if title:
             plot_ax.set_title(title)
         return plot_ax
@@ -100,6 +155,7 @@ class AreaChart(BasePlot):
         title: Optional[str] = None,
         style: StyleTemplate = AREA_STYLE_TEMPLATE,
         figsize: Tuple[float, float] = (10, 6),
+        **kwargs: Any,
     ) -> Figure:
         """Plot an area chart on a new figure.
 
@@ -112,18 +168,18 @@ class AreaChart(BasePlot):
         figsize : tuple[float, float], optional
             Figure size. The default is (10, 6).
 
+        **kwargs : Any
+            Additional keyword arguments forwarded to ``aplot``.
+
         Returns
         -------
         Figure
             The Matplotlib figure containing the area chart.
         """
-        fig = Figure(
-            figsize=figsize,
-            facecolor=style.background_color,
-            edgecolor=style.background_color,
-        )
-        ax = Axes(fig=fig, facecolor=style.background_color)
-        self.aplot(title=title, style=style, ax=ax)
+        fig = Figure(figsize=figsize)
+        fig.set_facecolor(style.background_color)
+        ax = fig.add_subplot(111)
+        self.aplot(title=title, style=style, ax=ax, **kwargs)
         return fig
 
 
@@ -162,6 +218,7 @@ def fplot_area(
     title: Optional[str] = None,
     style: StyleTemplate = AREA_STYLE_TEMPLATE,
     figsize: Tuple[float, float] = (10, 6),
+    **kwargs: Any,
 ) -> Figure:
     """Plot area charts on a new figure."""
     return AreaChart(
@@ -174,4 +231,5 @@ def fplot_area(
         title=title,
         style=style,
         figsize=figsize,
+        **kwargs,
     )

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/bar.py

@@ -16,7 +16,7 @@ from .style_template import (
     string_formatter,
     validate_dataframe,
 )
-from .utils import _get_axis
+from .utils import _get_axis, _merge_kwargs
 
 __all__ = ["DISTRIBUTION_STYLE_TEMPLATE", "aplot_bar", "fplot_bar"]
 
@@ -84,15 +84,22 @@ class BarChart(BasePlot):
                 values=self.value,
                 aggfunc="sum",
             )
-            pivot_df.plot(kind="bar", stacked=self.stacked, ax=plot_ax, alpha=0.85)
+            plot_kwargs: dict[str, Any] = {
+                "kind": "bar",
+                "stacked": self.stacked,
+                "ax": plot_ax,
+                "alpha": 0.85,
+            }
+            pivot_df.plot(**_merge_kwargs(plot_kwargs, kwargs))
         else:
-            sns.barplot(
-                data=self._obj,
-                x=self.category,
-                y=self.value,
-                palette=style.palette,
-                ax=plot_ax,
-            )
+            barplot_kwargs: dict[str, Any] = {
+                "data": self._obj,
+                "x": self.category,
+                "y": self.value,
+                "palette": style.palette,
+                "ax": plot_ax,
+            }
+            sns.barplot(**_merge_kwargs(barplot_kwargs, kwargs))
 
         plot_ax.set_facecolor(style.background_color)
         plot_ax.set_xlabel(string_formatter(self.category))
@@ -129,7 +136,8 @@ class BarChart(BasePlot):
             facecolor=style.background_color,
             edgecolor=style.background_color,
         )
-        ax = Axes(fig=fig, facecolor=style.background_color)
+        ax = fig.add_subplot(111)
+        ax.set_facecolor(style.background_color)
         fig.set_facecolor(style.background_color)
         self.aplot(title=title, style=style, ax=ax)
         return fig

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/box_violin.py

@@ -16,7 +16,7 @@ from .style_template import (
     string_formatter,
     validate_dataframe,
 )
-from .utils import _get_axis
+from .utils import _get_axis, _merge_kwargs
 
 __all__ = ["DISTRIBUTION_STYLE_TEMPLATE", "aplot_box_violin", "fplot_box_violin"]
 
@@ -82,10 +82,18 @@ class BoxViolinPlot(BasePlot):
             "palette": style.palette,
         }
 
+        plot_kwargs: dict[str, Any] = {
+            **common_kwargs,
+            "hue": self.by,
+            "legend": False,
+            "ax": plot_ax,
+        }
+        merged_plot_kwargs = _merge_kwargs(plot_kwargs, kwargs)
+
         if self.violin:
-            sns.violinplot(**common_kwargs, hue=self.by, legend=False, ax=plot_ax)
+            sns.violinplot(**merged_plot_kwargs)
         else:
-            sns.boxplot(**common_kwargs, hue=self.by, legend=False, ax=plot_ax)
+            sns.boxplot(**merged_plot_kwargs)
 
         plot_ax.set_facecolor(style.background_color)
         plot_ax.set_ylabel(string_formatter(self.column))
@@ -122,11 +130,9 @@ class BoxViolinPlot(BasePlot):
             facecolor=style.background_color,
             edgecolor=style.background_color,
         )
-        ax = Axes(fig=fig, facecolor=style.background_color)
+        ax = fig.add_subplot(111)
+        ax.set_facecolor(style.background_color)
         self.aplot(
-            column=self.column,
-            by=self.by,
-            violin=self.violin,
             title=title,
             style=style,
             ax=ax,

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/bubble.py

@@ -492,7 +492,8 @@ class Bubble(BasePlot):
             facecolor=style.background_color,
             edgecolor=style.background_color,
         )
-        ax = Axes(fig=fig, facecolor=style.background_color)
+        ax = fig.add_subplot(111)
+        ax.set_facecolor(style.background_color)
 
         self.aplot(
             title=title,

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/heatmap.py

@@ -1,24 +1,22 @@
 """Heatmap and correlation matrix helpers."""
 
-from typing import Any, Optional, Sequence, Tuple
+from typing import Any, Optional, Sequence, Tuple, cast
 
 import pandas as pd
-from pandas.api.extensions import register_dataframe_accessor
-import matplotlib.pyplot as plt
 import seaborn as sns
 from matplotlib.axes import Axes
 from matplotlib.figure import Figure
+from pandas.api.extensions import register_dataframe_accessor
 
 from .base_plot import BasePlot
-
 from .style_template import (
     HEATMAP_STYLE_TEMPLATE,
     StyleTemplate,
     string_formatter,
     validate_dataframe,
 )
-from .utils import _get_axis
 from .typing import CorrelationMethod
+from .utils import _get_axis, _merge_kwargs
 
 __all__ = [
     "HEATMAP_STYLE_TEMPLATE",
@@ -57,8 +55,14 @@ class Heatmap(BasePlot):
         ax: Optional[Axes] = None,
         **kwargs: Any,
     ) -> Axes:
+        """Plot a heatmap on an existing Matplotlib axes."""
         plot_ax = _get_axis(ax)
-        sns.heatmap(self._obj, cmap=style.palette, ax=plot_ax)
+        heatmap_kwargs: dict[str, Any] = {
+            "data": self._obj,
+            "cmap": style.palette,
+            "ax": plot_ax,
+        }
+        sns.heatmap(**_merge_kwargs(heatmap_kwargs, kwargs))
 
         plot_ax.set_xlabel(string_formatter(self.x))
         plot_ax.set_ylabel(string_formatter(self.y))
@@ -72,12 +76,14 @@ class Heatmap(BasePlot):
         style: StyleTemplate = HEATMAP_STYLE_TEMPLATE,
         figsize: Tuple[float, float] = (10, 6),
     ) -> Figure:
+        """Plot a heatmap on a new Matplotlib figure."""
         fig = Figure(
             figsize=figsize,
             facecolor=style.background_color,
             edgecolor=style.background_color,
         )
-        ax = Axes(fig=fig, facecolor=style.background_color)
+        ax = fig.add_subplot(111)
+        ax.set_facecolor(style.background_color)
         self.aplot(title=title, style=style, ax=ax)
         return fig
 
@@ -88,14 +94,16 @@ class Heatmap(BasePlot):
         ax: Optional[Axes] = None,
         **kwargs: Any,
     ) -> Axes:
+        """Plot a correlation matrix heatmap on existing axes."""
         plot_ax = _get_axis(ax)
-        sns.heatmap(
-            self.correlation_matrix,
-            cmap=style.palette,
-            annot=True,
-            fmt=".2f",
-            ax=plot_ax,
-        )
+        heatmap_kwargs: dict[str, Any] = {
+            "data": self.correlation_matrix,
+            "cmap": style.palette,
+            "annot": True,
+            "fmt": ".2f",
+            "ax": plot_ax,
+        }
+        sns.heatmap(**_merge_kwargs(heatmap_kwargs, kwargs))
         if title:
             plot_ax.set_title(title)
         return plot_ax
@@ -106,13 +114,15 @@ class Heatmap(BasePlot):
         style: StyleTemplate = HEATMAP_STYLE_TEMPLATE,
         figsize: Tuple[float, float] = (10, 6),
     ) -> Figure:
+        """Plot a correlation matrix heatmap on a new figure."""
         fig = Figure(
             figsize=figsize,
             facecolor=style.background_color,
             edgecolor=style.background_color,
         )
-        ax = Axes(fig=fig, facecolor=style.background_color)
-        self.aplot(
+        ax = fig.add_subplot(111)
+        ax.set_facecolor(style.background_color)
+        self.aplot_correlation_matrix(
             title=title,
             style=style,
             ax=ax,
@@ -126,7 +136,7 @@ def _prepare_data(
     y: str,
     value: str,
 ) -> pd.DataFrame:
-    """Prepare data for treemap plotting."""
+    """Prepare data for heatmap plotting."""
     validate_dataframe(pd_df, cols=[x, y, value])
     plot_df = pd_df[[x, y, value]].pivot_table(
         index=y, columns=x, values=value, aggfunc="mean"
@@ -134,6 +144,19 @@ def _prepare_data(
     return plot_df
 
 
+def _compute_correlation_matrix(
+    pd_df: pd.DataFrame,
+    columns: Optional[Sequence[str]],
+    method: CorrelationMethod,
+) -> pd.DataFrame:
+    """Compute a correlation matrix from numeric dataframe columns."""
+    source_df = pd_df[list(columns)] if columns else pd_df
+    numeric_df = source_df.select_dtypes(include="number")
+    if numeric_df.empty:
+        raise ValueError("No numeric columns available to compute correlation matrix.")
+    return numeric_df.corr(method=cast(Any, method))
+
+
 def aplot_heatmap(
     pd_df: pd.DataFrame,
     x: str,
@@ -168,19 +191,19 @@ def aplot_correlation_matrix(
     **kwargs: Any,
 ) -> Axes:
     """Plot a correlation matrix heatmap for numeric columns."""
-    return Heatmap(
-        pd_df=pd_df,
-        x="",  # Placeholder since correlation matrix is square
-        y="",  # Placeholder since correlation matrix is square
-        value="",  # Placeholder since correlation matrix is computed internally
-    ).aplot_correlation_matrix(
-        method=method,
-        title=title,
-        style=style,
-        ax=ax,
-        columns=columns,
-        **kwargs,
-    )
+    corr_df = _compute_correlation_matrix(pd_df=pd_df, columns=columns, method=method)
+    plot_ax = _get_axis(ax)
+    heatmap_kwargs: dict[str, Any] = {
+        "data": corr_df,
+        "cmap": style.palette,
+        "annot": True,
+        "fmt": ".2f",
+        "ax": plot_ax,
+    }
+    sns.heatmap(**_merge_kwargs(heatmap_kwargs, kwargs))
+    if title:
+        plot_ax.set_title(title)
+    return plot_ax
 
 
 def fplot_heatmap(
@@ -217,7 +240,7 @@ def fplot_correlation_matrix(
     """Plot a correlation matrix heatmap on a new figure."""
     return Heatmap(
         pd_df=pd_df,
-        x=x,  # Placeholder since correlation matrix is square
-        y=y,  # Placeholder since correlation matrix is square
-        value=value,  # Placeholder since correlation matrix is computed internally
+        x=x,
+        y=y,
+        value=value,
     ).fplot_correlation_matrix(title=title, style=style, figsize=figsize)

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/histogram.py

@@ -19,7 +19,7 @@ from .style_template import (
     string_formatter,
     validate_dataframe,
 )
-from .utils import _get_axis
+from .utils import _get_axis, _merge_kwargs
 
 __all__ = ["DISTRIBUTION_STYLE_TEMPLATE", "aplot_histogram", "fplot_histogram"]
 
@@ -50,15 +50,16 @@ class Histogram(BasePlot):
 
         validate_dataframe(self._obj, cols=[self.column])
         plot_ax = _get_axis(ax)
-        sns.histplot(
-            data=self._obj,
-            x=self.column,
-            bins=self.bins,
-            kde=self.kde,
-            color=style.font_color,
-            edgecolor=style.background_color,
-            ax=plot_ax,
-        )
+        histplot_kwargs: dict[str, Any] = {
+            "data": self._obj,
+            "x": self.column,
+            "bins": self.bins,
+            "kde": self.kde,
+            "color": style.font_color,
+            "edgecolor": style.background_color,
+            "ax": plot_ax,
+        }
+        sns.histplot(**_merge_kwargs(histplot_kwargs, kwargs))
         plot_ax.set_facecolor(style.background_color)
         plot_ax.set_xlabel(string_formatter(self.column))
         plot_ax.set_ylabel("Frequency")
@@ -77,7 +78,8 @@ class Histogram(BasePlot):
             facecolor=style.background_color,
             edgecolor=style.background_color,
         )
-        ax = Axes(fig=fig, facecolor=style.background_color)
+        ax = fig.add_subplot(111)
+        ax.set_facecolor(style.background_color)
         self.aplot(
             title=title,
             style=style,

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/network/core.py

@@ -821,7 +821,8 @@ class NetworkGraph(BasePlot):
             facecolor=style.background_color,
             edgecolor=style.background_color,
         )
-        ax = Axes(fig=fig, facecolor=style.background_color)
+        ax = fig.add_subplot(111)
+        ax.set_facecolor(style.background_color)
         self.aplot(
             title=title,
             style=style,

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/network/plot.py

@@ -480,7 +480,7 @@ def fplot_network_node(
     """
     fig = cast(Figure, plt.figure(figsize=figsize))
     fig.set_facecolor(style.background_color)
-    ax = fig.add_subplot()
+    ax = fig.add_subplot(111)
     ax = aplot_network_node(
         pd_df,
         node=node,

{matplotlibapi-4.0.0 → matplotlibapi-4.0.1}/src/MatplotLibAPI/pie.py

@@ -11,7 +11,7 @@ from matplotlib.figure import Figure
 from .base_plot import BasePlot
 
 from .style_template import PIE_STYLE_TEMPLATE, StyleTemplate, validate_dataframe
-from .utils import _get_axis
+from .utils import _get_axis, _merge_kwargs
 
 __all__ = ["PIE_STYLE_TEMPLATE", "aplot_pie", "fplot_pie"]
 
@@ -67,14 +67,14 @@ class PieChart(BasePlot):
         wedgeprops: Optional[Dict[str, Any]] = None
         if donut:
             wedgeprops = {"width": 0.3}
-        plot_ax.pie(
-            sizes,
-            labels=labels,
-            autopct="%1.1f%%",
-            colors=sns.color_palette(style.palette),
-            wedgeprops=wedgeprops,
-            textprops={"color": style.font_color, "fontsize": style.font_size},
-        )
+        pie_kwargs: Dict[str, Any] = {
+            "labels": labels,
+            "autopct": "%1.1f%%",
+            "colors": sns.color_palette(style.palette),
+            "wedgeprops": wedgeprops,
+            "textprops": {"color": style.font_color, "fontsize": style.font_size},
+        }
+        plot_ax.pie(sizes, **_merge_kwargs(pie_kwargs, kwargs))
         plot_ax.axis("equal")
         if title:
             plot_ax.set_title(title)
@@ -110,7 +110,8 @@ class PieChart(BasePlot):
             facecolor=style.background_color,
             edgecolor=style.background_color,
         )
-        ax = Axes(fig=fig, facecolor=style.background_color)
+        ax = fig.add_subplot(111)
+        ax.set_facecolor(style.background_color)
         fig.set_facecolor(style.background_color)
         self.aplot(donut=donut, title=title, style=style, ax=ax)
         return fig