MatplotLibAPI 3.2.21__py3-none-any.whl → 4.0.0__py3-none-any.whl

MatplotLibAPI/Wordcloud.py

@@ -1,373 +0,0 @@
-"""Word cloud plotting utilities."""
-
-from __future__ import annotations
-
-from typing import Any, Dict, Iterable, Optional, Sequence, Tuple, cast
-
-import numpy as np
-import pandas as pd
-import matplotlib.pyplot as plt
-from matplotlib import colormaps
-from matplotlib.axes import Axes
-from matplotlib.figure import Figure
-from wordcloud import WordCloud
-
-from .StyleTemplate import (
-    FIG_SIZE,
-    MAX_RESULTS,
-    StyleTemplate,
-    string_formatter,
-    validate_dataframe,
-)
-
-WORDCLOUD_STYLE_TEMPLATE = StyleTemplate(
-    background_color="black", font_color="white", palette="plasma"
-)
-
-
-def _filter_stopwords(
-    words: Iterable[str], stopwords: Optional[Iterable[str]]
-) -> np.ndarray:
-    """Remove stopwords from a sequence of words.
-
-    Parameters
-    ----------
-    words : Iterable[str]
-        Words to filter.
-    stopwords : Iterable[str], optional
-        Collection of stopwords to exclude. Defaults to ``None``.
-
-    Returns
-    -------
-    numpy.ndarray
-        Filtered words.
-    """
-    if stopwords is None:
-        return np.array(list(words))
-
-    stop_set = {word.lower() for word in stopwords}
-    return np.array([word for word in words if word.lower() not in stop_set])
-
-
-def _prepare_word_frequencies(
-    pd_df: pd.DataFrame,
-    text_column: str,
-    weight_column: Optional[str],
-    max_words: int,
-    stopwords: Optional[Iterable[str]],
-) -> Tuple[list[str], list[float]]:
-    """Aggregate and filter word frequencies.
-
-    Parameters
-    ----------
-    pd_df : pandas.DataFrame
-        Input DataFrame containing word data.
-    text_column : str
-        Column containing words or phrases.
-    weight_column : str, optional
-        Column containing numeric weights. Defaults to ``None``.
-    max_words : int
-        Maximum number of words to include.
-    stopwords : Iterable[str], optional
-        Words to exclude from the visualization. Defaults to ``None``.
-
-    Returns
-    -------
-    tuple of list
-        Lists of filtered words and their corresponding weights.
-
-    Raises
-    ------
-    AttributeError
-        If required columns are missing from the DataFrame.
-    """
-    validate_dataframe(pd_df, cols=[text_column], sort_by=weight_column)
-
-    if weight_column is None:
-        freq_series: pd.Series = pd_df[text_column].value_counts()
-    else:
-        weight_col = cast(str, weight_column)
-        freq_series = cast(pd.Series, pd_df.groupby(text_column)[weight_col].sum())
-        freq_series = freq_series.sort_values(ascending=False)
-
-    words = freq_series.index.to_numpy()
-    weights = freq_series.to_numpy(dtype=float)
-
-    words = _filter_stopwords(words, stopwords)
-    mask = np.isin(freq_series.index, words)
-    weights = weights[mask]
-
-    sorted_indices = np.argsort(weights)[::-1]
-    words = words[sorted_indices][:max_words].tolist()
-    weights = weights[sorted_indices][:max_words].tolist()
-
-    return words, weights
-
-
-def create_circular_mask(size: int = 300, radius: Optional[int] = None) -> np.ndarray:
-    """Construct a binary mask with a circular opening for a word cloud.
-
-    Parameters
-    ----------
-    size : int, optional
-        Width and height of the mask in pixels. Defaults to ``300``.
-    radius : int, optional
-        Radius of the circular opening in pixels. Defaults to ``size // 2``.
-
-    Returns
-    -------
-    numpy.ndarray
-        Two-dimensional array suitable for the ``mask`` argument of
-        ``wordcloud.WordCloud`` where ``0`` values define the drawable region.
-
-    Raises
-    ------
-    ValueError
-        If ``size`` or ``radius`` are non-positive.
-    """
-    if size <= 0:
-        raise ValueError("size must be a positive integer.")
-
-    resolved_radius = radius if radius is not None else size // 2
-    if resolved_radius <= 0:
-        raise ValueError("radius must be a positive integer.")
-
-    center = (size - 1) / 2
-    x, y = np.ogrid[:size, :size]
-    mask_region = (x - center) ** 2 + (y - center) ** 2 > resolved_radius**2
-    return 255 * mask_region.astype(np.uint8)
-
-
-def _plot_words(
-    ax: Axes,
-    words: Sequence[str],
-    weights: Sequence[float],
-    style: StyleTemplate,
-    title: Optional[str],
-    random_state: Optional[int],
-    mask: Optional[np.ndarray],
-) -> Axes:
-    """Render words on the provided axes with sizes proportional to weights.
-
-    Parameters
-    ----------
-    ax : matplotlib.axes.Axes
-        Axes on which to draw.
-    words : Sequence[str]
-        Words to render.
-    weights : Sequence[float]
-        Corresponding weights for sizing.
-    style : StyleTemplate
-        Style configuration for the plot.
-    title : str, optional
-        Title of the plot. Defaults to ``None``.
-    random_state : int, optional
-        Seed for reproducible placement. Defaults to ``None``.
-
-    Returns
-    -------
-    matplotlib.axes.Axes
-        Axes containing the rendered word cloud.
-    """
-    ax.set_facecolor(style.background_color)
-    ax.axis("off")
-
-    if not words:
-        if title:
-            ax.set_title(title, color=style.font_color, fontsize=style.font_size * 1.5)
-        return ax
-
-    fig_obj = ax.get_figure()
-    if not isinstance(fig_obj, Figure):
-        raise RuntimeError("Axes is not associated with a Figure.")
-
-    canvas = fig_obj.canvas
-    if canvas is None:
-        raise RuntimeError("Figure does not have an attached canvas.")
-
-    canvas.draw()
-    ax_bbox = ax.get_window_extent()
-
-    if mask is None:
-        mask_dimension = max(int(ax_bbox.width), int(ax_bbox.height), 1)
-        resolved_mask = create_circular_mask(size=mask_dimension)
-    else:
-        resolved_mask = np.asarray(mask)
-
-    if resolved_mask.ndim != 2:
-        raise ValueError("mask must be a 2D array.")
-
-    height, width = resolved_mask.shape
-
-    frequency_map = {
-        string_formatter(word): weight for word, weight in zip(words, weights)
-    }
-    min_font_size = style.font_mapping[min(style.font_mapping.keys())]
-    max_font_size = style.font_mapping[max(style.font_mapping.keys())]
-
-    wc = WordCloud(
-        width=width,
-        height=height,
-        background_color=style.background_color,
-        colormap=colormaps.get_cmap(style.palette),
-        min_font_size=min_font_size,
-        max_font_size=max_font_size,
-        random_state=random_state,
-        mask=resolved_mask,
-    ).generate_from_frequencies(frequency_map)
-
-    ax.imshow(wc.to_array(), interpolation="bilinear")
-
-    if title:
-        ax.set_title(title, color=style.font_color, fontsize=style.font_size * 1.5)
-    return ax
-
-
-def aplot_wordcloud(
-    pd_df: pd.DataFrame,
-    text_column: str,
-    weight_column: Optional[str] = None,
-    title: Optional[str] = None,
-    style: StyleTemplate = WORDCLOUD_STYLE_TEMPLATE,
-    max_words: int = MAX_RESULTS,
-    stopwords: Optional[Iterable[str]] = None,
-    random_state: Optional[int] = None,
-    ax: Optional[Axes | np.ndarray[Any, np.dtype[Any]]] = None,
-    mask: Optional[np.ndarray] = None,
-) -> Axes:
-    """Plot a word cloud on the provided axes.
-
-    Parameters
-    ----------
-    pd_df : pandas.DataFrame
-        DataFrame containing the words to visualize.
-    text_column : str
-        Column containing words or phrases.
-    weight_column : str, optional
-        Column containing numeric weights. Defaults to ``None`` for equal weights.
-    title : str, optional
-        Plot title. Defaults to ``None``.
-    style : StyleTemplate, optional
-        Styling options. Defaults to ``WORDCLOUD_STYLE_TEMPLATE``.
-    max_words : int, optional
-        Maximum number of words to display. Defaults to ``MAX_RESULTS``.
-    stopwords : Iterable[str], optional
-        Words to exclude from the visualization. Defaults to ``None``.
-    random_state : int, optional
-        Seed for word placement. Defaults to ``None``.
-    ax : matplotlib.axes.Axes or numpy.ndarray, optional
-        Axes to draw on. Defaults to ``None`` which uses the current axes.
-    mask : numpy.ndarray, optional
-        Two-dimensional mask array defining the drawable region of the word cloud.
-        Defaults to a circular mask generated by :func:`create_circular_mask`.
-
-    Returns
-    -------
-    matplotlib.axes.Axes
-        Axes containing the rendered word cloud.
-
-    Raises
-    ------
-    AttributeError
-        If required columns are missing from the DataFrame.
-    TypeError
-        If ``ax`` is not a ``matplotlib.axes.Axes`` instance.
-    """
-    if ax is None:
-        ax = cast(Axes, plt.gca())
-    elif isinstance(ax, np.ndarray):
-        raise TypeError("ax must be a single matplotlib Axes instance, not an array.")
-    elif not isinstance(ax, Axes):
-        raise TypeError("ax must be a matplotlib Axes instance.")
-
-    words, weights = _prepare_word_frequencies(
-        pd_df=pd_df,
-        text_column=text_column,
-        weight_column=weight_column,
-        max_words=max_words,
-        stopwords=stopwords,
-    )
-    return _plot_words(
-        ax,
-        words,
-        weights,
-        style=style,
-        title=title,
-        random_state=random_state,
-        mask=mask,
-    )
-
-
-def fplot_wordcloud(
-    pd_df: pd.DataFrame,
-    text_column: str,
-    weight_column: Optional[str] = None,
-    title: Optional[str] = None,
-    style: StyleTemplate = WORDCLOUD_STYLE_TEMPLATE,
-    max_words: int = MAX_RESULTS,
-    stopwords: Optional[Iterable[str]] = None,
-    random_state: Optional[int] = None,
-    figsize: Tuple[float, float] = FIG_SIZE,
-    save_path: Optional[str] = None,
-    savefig_kwargs: Optional[Dict[str, Any]] = None,
-    mask: Optional[np.ndarray] = None,
-) -> Figure:
-    """Create a new figure with a word cloud.
-
-    Parameters
-    ----------
-    pd_df : pandas.DataFrame
-        DataFrame containing the words to visualize.
-    text_column : str
-        Column containing words or phrases.
-    weight_column : str, optional
-        Column containing numeric weights. Defaults to ``None`` for equal weights.
-    title : str, optional
-        Plot title. Defaults to ``None``.
-    style : StyleTemplate, optional
-        Styling options. Defaults to ``WORDCLOUD_STYLE_TEMPLATE``.
-    max_words : int, optional
-        Maximum number of words to display. Defaults to ``MAX_RESULTS``.
-    stopwords : Iterable[str], optional
-        Words to exclude from the visualization. Defaults to ``None``.
-    random_state : int, optional
-        Seed for word placement. Defaults to ``None``.
-    figsize : tuple of float, optional
-        Figure size. Defaults to ``FIG_SIZE``.
-    mask : numpy.ndarray, optional
-        Two-dimensional mask array defining the drawable region of the word cloud.
-        Defaults to a circular mask generated by :func:`create_circular_mask`.
-
-    Returns
-    -------
-    matplotlib.figure.Figure
-        Figure containing the rendered word cloud.
-
-    Raises
-    ------
-    AttributeError
-        If required columns are missing from the DataFrame.
-    """
-    fig_raw, ax_raw = plt.subplots(figsize=figsize)
-    fig = cast(Figure, fig_raw)
-    ax = cast(Axes, ax_raw)
-
-    _plot_words(
-        ax,
-        *_prepare_word_frequencies(
-            pd_df=pd_df,
-            text_column=text_column,
-            weight_column=weight_column,
-            max_words=max_words,
-            stopwords=stopwords,
-        ),
-        style=style,
-        title=title,
-        random_state=random_state,
-        mask=mask,
-    )
-    fig.patch.set_facecolor(style.background_color)
-    fig.tight_layout()
-    if save_path:
-        fig.savefig(save_path, **(savefig_kwargs or {}))
-    return fig

MatplotLibAPI/_typing.py

@@ -1,17 +0,0 @@
-"""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-3.2.21.dist-info/RECORD

@@ -1,26 +0,0 @@
-MatplotLibAPI/Area.py,sha256=Y-tk6Di3Foj3yOGVbbOwDnPtL9rDh-VV2XTeaZcybgk,2095
-MatplotLibAPI/Bar.py,sha256=Y8mP_UWyU2h5T38L7j-Vnt0t9WSeCbV6Gw_-_48x3Bw,2243
-MatplotLibAPI/BoxViolin.py,sha256=8nnXGyDwrjiNJOiJHEYEcJMqD6JIF5JT8aZ0y4AXgLY,2008
-MatplotLibAPI/Bubble.py,sha256=y_1yM38u3k0yZ812oISZ8iUNwn93urWxdJKgcAFpIxs,12820
-MatplotLibAPI/Composite.py,sha256=JQo5ogTlcUlODCxojo3Wsx5ey1cqUIlBFylqysxx48I,9404
-MatplotLibAPI/Heatmap.py,sha256=SRT8pCKtEaJ1PivxxzCuXp-OBu4ljno2PGB_XXvFxzY,3369
-MatplotLibAPI/Histogram.py,sha256=znkQAVOa2-DMIKopCl_3-8JpDtymfGm4Bi4IyNXSVqs,1869
-MatplotLibAPI/Network.py,sha256=9jrkLCR4GQwOuDUqKFjQsytPl0nNInygHWoB-QTfw4Y,31699
-MatplotLibAPI/Pie.py,sha256=p0JuSP8h3TflEuvmGpPqNHO7hbAnse8hmMWBiZtzfsE,1882
-MatplotLibAPI/Pivot.py,sha256=6qH8e6U1TzUQcAIBmA_KMuHER2Uxp0-GFtwy9eJuS9A,3403
-MatplotLibAPI/Sankey.py,sha256=SpijCISghlsLqPuaWvnBP6vB-CV9k7FUGUi5LC6bKVc,1501
-MatplotLibAPI/StyleTemplate.py,sha256=Y3sBbUMbfAuxaONW8YixaI0UGgC7b1xnUo0MUMV4Z98,8176
-MatplotLibAPI/Sunburst.py,sha256=kqjEruXDDeuJpUKqbMw_VdT7fY0O4qzUNsIuwaTamdc,2584
-MatplotLibAPI/Table.py,sha256=6f8t4JUQ-owpd4fRL74Y0ovYFQO-SabStFXOqG48EoA,6450
-MatplotLibAPI/Timeserie.py,sha256=TGtshXXEwYEomxRCSb1MGzTTcgqk-M_GbQImVVP6RvE,10204
-MatplotLibAPI/Treemap.py,sha256=VBBk6MpNXoQtnxFzR1YPhIx6Lz9b7yJNHBMbQDhvefM,4848
-MatplotLibAPI/Waffle.py,sha256=uplRhUBDWUhSwPnI_GzU1O2D_RQXW_0OJ51m01PFKLg,2517
-MatplotLibAPI/Wordcloud.py,sha256=HqY-wA-VR3OGP1-OaI5Cqc0lS3WLnY9NkYD6QxePAXA,11447
-MatplotLibAPI/__init__.py,sha256=1-XM-PqzNwvkJvtpPV1x21zjEgjonVxaftXPMRrWxOo,2375
-MatplotLibAPI/_typing.py,sha256=Or3IPNceWKdyEk3CGXJb09FZR_fvT732oF0iWrx1ex8,598
-MatplotLibAPI/_visualization_utils.py,sha256=qIv7c0Mi3qK-saGxmKngw23uWxKFSAYjiH3uYTSr5Po,2215
-MatplotLibAPI/accessor.py,sha256=gYICR1qrm-R6scjuiJFMdXPd0164evQc8wGrjE7kOrk,52940
-matplotlibapi-3.2.21.dist-info/METADATA,sha256=TlfDACO70teDw4h-_md1EOo30dBKiU7V6tJ79pWqlJQ,5888
-matplotlibapi-3.2.21.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-matplotlibapi-3.2.21.dist-info/licenses/LICENSE,sha256=hMErKLb6YZR3lRR5zr-vxeFkvY69QAaafgSpZ5-P1dQ,1067
-matplotlibapi-3.2.21.dist-info/RECORD,,