MatplotLibAPI 3.2.14__py3-none-any.whl → 3.2.16__py3-none-any.whl

MatplotLibAPI/_typing.py

@@ -0,0 +1,17 @@
+"""Internal type aliases used across MatplotLibAPI."""
+
+from typing import Any, Callable, Literal, Union
+
+from typing_extensions import TypeAlias
+
+import numpy.typing as npt
+
+
+# ``DataFrame.corr`` supports the three built-in correlation methods or a callable
+# that operates on two array-like inputs and returns a float. Using a local alias
+# avoids depending on the private ``pandas._typing`` module, which is not
+# considered stable across releases.
+CorrelationMethod: TypeAlias = Union[
+    Literal["pearson", "kendall", "spearman"],
+    Callable[[npt.NDArray[Any], npt.NDArray[Any]], float],
+]

MatplotLibAPI/_visualization_utils.py

@@ -0,0 +1,38 @@
+"""Shared utilities for matplotlib-based plotting helpers."""
+
+from typing import Any, Callable, Dict, Optional, Tuple, cast
+
+import matplotlib.pyplot as plt
+from numpy import ndarray
+from matplotlib.axes import Axes
+from matplotlib.figure import Figure
+from typing_extensions import Protocol
+
+
+class _AplotFunc(Protocol):
+    def __call__(self, *, pd_df: Any, ax: Axes, **kwargs: Any) -> Axes: ...
+
+
+def _get_axis(ax: Optional[Axes] = None) -> Axes:
+    """Return a Matplotlib axes, defaulting to the current one."""
+    return ax if ax is not None else plt.gca()
+
+
+def _wrap_aplot(
+    plot_func: _AplotFunc,
+    pd_df: Any,
+    figsize: Tuple[float, float],
+    ax_args: Optional[Dict[str, Any]] = None,
+    **kwargs: Any,
+) -> Figure:
+    """Create a new figure and delegate plotting to an axis-level function."""
+    ax_args = ax_args or {}
+    fig, axes_obj = plt.subplots(figsize=figsize, **ax_args)
+    ax: Axes
+    if isinstance(axes_obj, Axes):
+        ax = axes_obj
+    else:
+        ax = cast(Axes, axes_obj.flat[0] if isinstance(axes_obj, ndarray) else axes_obj)
+    plot_func(pd_df=pd_df, ax=ax, **kwargs)
+    fig_obj: Figure = cast(Figure, fig)
+    return fig_obj