maidr 1.7.3__tar.gz → 1.8.0__tar.gz

{maidr-1.7.3 → maidr-1.8.0}/CHANGELOG.md

@@ -1,6 +1,24 @@
 # CHANGELOG
 
 
+## v1.8.0 (2025-09-17)
+
+### Features
+
+- Remove maidr.show params ([#244](https://github.com/xability/py-maidr/pull/244),
+  [`493cf57`](https://github.com/xability/py-maidr/commit/493cf5713068b1514b4836e46763c3619a51dd23))
+
+### Refactoring
+
+- **maidr.api**: Improve lazy figure detection, eliminate code duplication, and resolve merge
+  conflicts ([#241](https://github.com/xability/py-maidr/pull/241),
+  [`15a966e`](https://github.com/xability/py-maidr/commit/15a966ea2ca9170ddf8bc28634705fb6233a1d58))
+
+Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
+
+Co-authored-by: jooyoungseo <19754711+jooyoungseo@users.noreply.github.com>
+
+
 ## v1.7.3 (2025-09-15)
 
 ### Bug Fixes

{maidr-1.7.3 → maidr-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maidr
-Version: 1.7.3
+Version: 1.8.0
 Summary: Multimodal Access and Interactive Data Representations
 Project-URL: Homepage, https://xability.github.io/py-maidr
 Project-URL: Repository, https://github.com/xability/py-maidr

{maidr-1.7.3 → maidr-1.8.0}/maidr/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.7.3"
+__version__ = "1.8.0"
 
 from .api import close, render, save_html, show, stacked
 from .core import Maidr

maidr-1.8.0/maidr/api.py

@@ -0,0 +1,155 @@
+from __future__ import annotations
+
+from typing import Any, Literal
+
+from htmltools import Tag
+from matplotlib.axes import Axes
+from matplotlib.container import BarContainer
+
+from maidr.core import Maidr
+from maidr.core.enum import PlotType
+from maidr.core.figure_manager import FigureManager
+
+
+def _get_plot_or_current(plot: Any | None) -> Any:
+    """
+    Get the plot object or current matplotlib figure if plot is None.
+    
+    Parameters
+    ----------
+    plot : Any or None
+        The plot object. If None, returns the current matplotlib figure.
+        
+    Returns
+    -------
+    Any
+        The plot object or current matplotlib figure.
+    """
+    if plot is None:
+        # Lazy import matplotlib.pyplot when needed
+        import matplotlib.pyplot as plt
+        
+        return plt.gcf()
+    return plot
+
+
+def render(plot: Any | None = None) -> Tag:
+    """
+    Render a MAIDR plot to HTML.
+
+    Parameters
+    ----------
+    plot : Any or None, optional
+        The plot object to render. If None, uses the current matplotlib figure.
+
+    Returns
+    -------
+    htmltools.Tag
+        The rendered HTML representation of the plot.
+    """
+    plot = _get_plot_or_current(plot)
+    
+    ax = FigureManager.get_axes(plot)
+    if isinstance(ax, list):
+        for axes in ax:
+            maidr = FigureManager.get_maidr(axes.get_figure())
+        return maidr.render()
+    else:
+        maidr = FigureManager.get_maidr(ax.get_figure())
+        return maidr.render()
+
+
+def show(
+    plot: Any | None = None,
+    renderer: Literal["auto", "ipython", "browser"] = "auto",
+    clear_fig: bool = True,
+) -> object:
+    """
+    Display a MAIDR plot.
+
+    Parameters
+    ----------
+    plot : Any or None, optional
+        The plot object to display. If None, uses the current matplotlib figure.
+    renderer : {"auto", "ipython", "browser"}, default "auto"
+        The renderer to use for display.
+    clear_fig : bool, default True
+        Whether to clear the figure after displaying.
+
+    Returns
+    -------
+    object
+        The display result.
+    """
+    plot = _get_plot_or_current(plot)
+    
+    ax = FigureManager.get_axes(plot)
+    if isinstance(ax, list):
+        for axes in ax:
+            maidr = FigureManager.get_maidr(axes.get_figure())
+        return maidr.show(renderer)
+    else:
+        maidr = FigureManager.get_maidr(ax.get_figure())
+        return maidr.show(renderer, clear_fig=clear_fig)
+
+
+def save_html(
+    plot: Any | None = None,
+    *, 
+    file: str,
+    lib_dir: str | None = "lib", 
+    include_version: bool = True
+) -> str:
+    """
+    Save a MAIDR plot as HTML file.
+
+    Parameters
+    ----------
+    plot : Any or None, optional
+        The plot object to save. If None, uses the current matplotlib figure.
+    file : str
+        The file path where to save the HTML.
+    lib_dir : str or None, default "lib"
+        Directory name for libraries.
+    include_version : bool, default True
+        Whether to include version information.
+
+    Returns
+    -------
+    str
+        The path to the saved HTML file.
+    """
+    plot = _get_plot_or_current(plot)
+    
+    ax = FigureManager.get_axes(plot)
+    htmls = []
+    if isinstance(ax, list):
+        for axes in ax:
+            maidr = FigureManager.get_maidr(axes.get_figure())
+            htmls.append(maidr._create_html_doc(use_iframe=False))
+        return htmls[-1].save_html(
+            file, libdir=lib_dir, include_version=include_version
+        )
+    else:
+        maidr = FigureManager.get_maidr(ax.get_figure())
+        return maidr.save_html(file, lib_dir=lib_dir, include_version=include_version)
+
+
+def stacked(plot: Axes | BarContainer) -> Maidr:
+    ax = FigureManager.get_axes(plot)
+    return FigureManager.create_maidr(ax, PlotType.STACKED)
+
+
+def close(plot: Any | None = None) -> None:
+    """
+    Close a MAIDR plot and clean up resources.
+
+    Parameters
+    ----------
+    plot : Any or None, optional
+        The plot object to close. If None, uses the current matplotlib figure.
+    """
+    plot = _get_plot_or_current(plot)
+    
+    ax = FigureManager.get_axes(plot)
+    FigureManager.destroy(ax.get_figure())

{maidr-1.7.3 → maidr-1.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "maidr"
-version = "1.7.3"
+version = "1.8.0"
 description = "Multimodal Access and Interactive Data Representations"
 authors = [
     { name = "JooYoung Seo", email = "jseo1005@illinois.edu" },
@@ -82,7 +82,8 @@ dev = [
     "python-semantic-release==9.21.0",
     "pytest-mock>=3.12.0,<4",
     "tox>=4.13.0,<5",
-    "quartodoc>=0.8.0,<0.9"
+    "quartodoc>=0.8.0,<0.9",
+    "griffe>=0.48,<1.0"
 ]
 
 [tool.ruff]