maidr 1.7.3__py3-none-any.whl → 1.8.0__py3-none-any.whl

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/api.py

@@ -11,7 +11,44 @@ from maidr.core.enum import PlotType
 from maidr.core.figure_manager import FigureManager
 
 
-def render(plot: Any) -> Tag:
+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:
@@ -23,10 +60,29 @@ def render(plot: Any) -> Tag:
 
 
 def show(
-    plot: Any,
+    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:
@@ -38,8 +94,33 @@ def show(
 
 
 def save_html(
-    plot: Any, file: str, *, lib_dir: str | None = "lib", include_version: bool = True
+    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):
@@ -59,6 +140,16 @@ def stacked(plot: Axes | BarContainer) -> Maidr:
     return FigureManager.create_maidr(ax, PlotType.STACKED)
 
 
-def close(plot: Any) -> None:
+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.dist-info → maidr-1.8.0.dist-info}/METADATA

@@ -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.dist-info → maidr-1.8.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-maidr/__init__.py,sha256=yWh6GLg3euB1LRZdmADmvGibtFcvZtr48m0w2uFEykU,415
-maidr/api.py,sha256=gRNLXqUWpFGdD-I7Nu6J0_LeEni9KRAr0TBHwHaDAsc,1928
+maidr/__init__.py,sha256=WHwg8BcJQIcf4dsUFOdKS_frxDfuHewDEGnBBg9j3WE,415
+maidr/api.py,sha256=od539V0CKcs15FEXQo0hX_hK_A0U3noHE54obdHcTqY,4138
 maidr/core/__init__.py,sha256=WgxLpSEYMc4k3OyEOf1shOxfEq0ASzppEIZYmE91ThQ,25
 maidr/core/context_manager.py,sha256=6cT7ZGOApSpC-SLD2XZWWU_H08i-nfv-JUlzXOtvWYw,3374
 maidr/core/figure_manager.py,sha256=t-lhe4jj2gsF5-8VUBUZOPlDutKjm_AZ8xXWJU2pFRc,5555
@@ -52,7 +52,7 @@ maidr/util/mixin/extractor_mixin.py,sha256=j2Rv2vh_gqqcxLV1ka3xsPaPAfWsX94CtKIW2
 maidr/util/mixin/merger_mixin.py,sha256=V0qLw_6DUB7X6CQ3BCMpsCQX_ZuwAhoSTm_E4xAJFKM,712
 maidr/widget/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maidr/widget/shiny.py,sha256=wrrw2KAIpE_A6CNQGBtNHauR1DjenA_n47qlFXX9_rk,745
-maidr-1.7.3.dist-info/METADATA,sha256=uOTyppfpjH4RVQSO0x9S4owUWLM9X2Ta9-sCjr3xQD0,3154
-maidr-1.7.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-maidr-1.7.3.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-maidr-1.7.3.dist-info/RECORD,,
+maidr-1.8.0.dist-info/METADATA,sha256=JSCtmOqsD8Mka8aDihHcqHs4wJ9Yc4eBYV3by-pQSl0,3154
+maidr-1.8.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+maidr-1.8.0.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+maidr-1.8.0.dist-info/RECORD,,