maidr 1.8.1__tar.gz → 1.10.0__tar.gz

{maidr-1.8.1 → maidr-1.10.0}/CHANGELOG.md

@@ -1,6 +1,23 @@
 # CHANGELOG
 
 
+## v1.10.0 (2026-01-31)
+
+### Features
+
+- Remove candlestick formatting and add ylabel to dodged plots
+  ([#260](https://github.com/xability/py-maidr/pull/260),
+  [`70b2626`](https://github.com/xability/py-maidr/commit/70b2626bb31e109e8cdb29051f809fe03bfb6275))
+
+
+## v1.9.0 (2025-10-31)
+
+### Features
+
+- Add data_in_svg parameter for save_html ([#257](https://github.com/xability/py-maidr/pull/257),
+  [`17d65ee`](https://github.com/xability/py-maidr/commit/17d65eee06ac3209ef3a91ebd623a5a6d0b16e79))
+
+
 ## v1.8.1 (2025-10-16)
 
 ### Bug Fixes

{maidr-1.8.1 → maidr-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maidr
-Version: 1.8.1
+Version: 1.10.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.8.1 → maidr-1.10.0}/docs/examples.qmd

@@ -152,6 +152,7 @@ for offset, (category, counts) in zip(offsets, weight_counts.items()):
 ax.set_xticks(x)
 ax.set_xticklabels(species)
 ax.set_xlabel("Species")
+ax.set_ylabel("Weight")
 ax.set_title("Dodged Bar Plot: Penguin Weight Counts")
 ax.legend(loc="upper right")
 

{maidr-1.8.1 → maidr-1.10.0}/maidr/__init__.py

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

{maidr-1.8.1 → maidr-1.10.0}/maidr/api.py

@@ -14,12 +14,12 @@ 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
@@ -28,7 +28,7 @@ def _get_plot_or_current(plot: Any | None) -> Any:
     if plot is None:
         # Lazy import matplotlib.pyplot when needed
         import matplotlib.pyplot as plt
-        
+
         return plt.gcf()
     return plot
 
@@ -48,7 +48,7 @@ def render(plot: Any | None = None) -> 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:
@@ -82,7 +82,7 @@ def show(
         The display result.
     """
     plot = _get_plot_or_current(plot)
-    
+
     ax = FigureManager.get_axes(plot)
     if isinstance(ax, list):
         for axes in ax:
@@ -95,10 +95,11 @@ def show(
 
 def save_html(
     plot: Any | None = None,
-    *, 
+    *,
     file: str,
-    lib_dir: str | None = "lib", 
-    include_version: bool = True
+    lib_dir: str | None = "lib",
+    include_version: bool = True,
+    data_in_svg: bool = True,
 ) -> str:
     """
     Save a MAIDR plot as HTML file.
@@ -113,6 +114,8 @@ def save_html(
         Directory name for libraries.
     include_version : bool, default True
         Whether to include version information.
+    data_in_svg : bool, default True
+        Controls where the MAIDR JSON payload is placed in the HTML or SVG.
 
     Returns
     -------
@@ -120,19 +123,21 @@ def save_html(
         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))
+            htmls.append(maidr._create_html_doc(use_iframe=False, data_in_svg=data_in_svg))
         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)
+        return maidr.save_html(
+            file, lib_dir=lib_dir, include_version=include_version, data_in_svg=data_in_svg
+        )
 
 
 def stacked(plot: Axes | BarContainer) -> Maidr:
@@ -150,6 +155,6 @@ def close(plot: Any | None = None) -> None:
         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.8.1 → maidr-1.10.0}/maidr/core/maidr.py

@@ -72,7 +72,12 @@ class Maidr:
         return self._create_html_tag(use_iframe=True)
 
     def save_html(
-        self, file: str, *, lib_dir: str | None = "lib", include_version: bool = True
+        self,
+        file: str,
+        *,
+        lib_dir: str | None = "lib",
+        include_version: bool = True,
+        data_in_svg: bool = True,
     ) -> str:
         """
         Save the HTML representation of the figure with MAIDR to a file.
@@ -86,9 +91,11 @@ class Maidr:
             (relative to the file's directory).
         include_version : bool, default=True
             Whether to include the version number in the dependency folder name.
+        data_in_svg : bool, default=True
+            Controls where the MAIDR JSON payload is placed in the output HTML or SVG.
         """
         html = self._create_html_doc(
-            use_iframe=False
+            use_iframe=False, data_in_svg=data_in_svg
         )  # Always use direct HTML for saving
         return html.save_html(file, libdir=lib_dir, include_version=include_version)
 
@@ -180,8 +187,17 @@ class Maidr:
         else:
             webbrowser.open(f"file://{html_file_path}")
 
-    def _create_html_tag(self, use_iframe: bool = True) -> Tag:
-        """Create the MAIDR HTML using HTML tags."""
+    def _create_html_tag(self, use_iframe: bool = True, data_in_svg: bool = True) -> Tag:
+        """Create the MAIDR HTML using HTML tags.
+
+        Parameters
+        ----------
+        use_iframe : bool, default=True
+            Whether to render the plot inside an iframe (for notebooks and similar envs).
+        data_in_svg : bool, default=True
+            If True, the MAIDR JSON is embedded in the root <svg> under attribute 'maidr'.
+            If False, a <script>var maidr = {...}</script> tag is injected instead.
+        """
         tagged_elements: list[Any] = [
             element for plot in self._plots for element in plot.elements
         ]
@@ -191,16 +207,31 @@ class Maidr:
             for _ in plot.elements:
                 selector_ids.append(self.selector_ids[i])
 
+        # Build schema once so id stays consistent across SVG and global var
+        schema = self._flatten_maidr()
+
         with HighlightContextManager.set_maidr_elements(tagged_elements, selector_ids):
-            svg = self._get_svg()
-        maidr = f"\nlet maidr = {json.dumps(self._flatten_maidr(), indent=2)}\n"
+            svg = self._get_svg(embed_data=data_in_svg, schema=schema)
+
+        # Generate external payload if data is not embedded in SVG
+        maidr = None
+        if not data_in_svg:
+            maidr = f"\nvar maidr = {json.dumps(schema, indent=2)}\n"
 
         # Inject plot's svg and MAIDR structure into html tag.
         return Maidr._inject_plot(svg, maidr, self.maidr_id, use_iframe)
 
-    def _create_html_doc(self, use_iframe: bool = True) -> HTMLDocument:
-        """Create an HTML document from Tag objects."""
-        return HTMLDocument(self._create_html_tag(use_iframe), lang="en")
+    def _create_html_doc(self, use_iframe: bool = True, data_in_svg: bool = True) -> HTMLDocument:
+        """Create an HTML document from Tag objects.
+
+        Parameters
+        ----------
+        use_iframe : bool, default=True
+            Whether to render the plot inside an iframe (for notebooks and similar envs).
+        data_in_svg : bool, default=True
+            See _create_html_tag for details on payload placement strategy.
+        """
+        return HTMLDocument(self._create_html_tag(use_iframe, data_in_svg), lang="en")
 
     def _merge_plots_by_subplot_position(self) -> list[MaidrPlot]:
         """
@@ -312,10 +343,23 @@ class Maidr:
                 for cell in subplot_grid[i]
             ]
 
-        return {"id": Maidr._unique_id(), "subplots": subplot_grid}
+        return {
+            "id": Maidr._unique_id(),
+            "subplots": subplot_grid,
+        }
 
-    def _get_svg(self) -> HTML:
-        """Extract the chart SVG from ``matplotlib.figure.Figure``."""
+    def _get_svg(self, embed_data: bool = True, schema: dict | None = None) -> HTML:
+        """Extract the chart SVG from ``matplotlib.figure.Figure``.
+
+        Parameters
+        ----------
+        embed_data : bool, default=True
+            If True, embed the MAIDR JSON schema as an attribute named 'maidr' on
+            the root <svg> element. If False, do not embed JSON in the SVG.
+        schema : dict | None, default=None
+            If provided, this schema will be used (ensuring a consistent id across
+            the page). If None, a new schema will be generated.
+        """
         svg_buffer = io.StringIO()
         self._fig.savefig(svg_buffer, format="svg")
         str_svg = svg_buffer.getvalue()
@@ -323,12 +367,14 @@ class Maidr:
         etree.register_namespace("svg", "http://www.w3.org/2000/svg")
         tree_svg = etree.fromstring(str_svg.encode(), parser=None)
         root_svg = None
-        # Find the `svg` tag and set unique id if not present else use it.
+        # Find the `svg` tag and optionally embed MAIDR data.
         for element in tree_svg.iter(tag="{http://www.w3.org/2000/svg}svg"):
-            if "maidr-data" not in element.attrib:
-                element.attrib["maidr-data"] = json.dumps(
-                    self._flatten_maidr(), indent=2
-                )
+            current_schema = schema if schema is not None else self._flatten_maidr()
+            # Ensure SVG id matches schema id in both modes
+            if isinstance(current_schema, dict) and "id" in current_schema:
+                element.attrib["id"] = str(current_schema["id"])  # ensure match
+            if embed_data:
+                element.attrib["maidr"] = json.dumps(current_schema, indent=2)
             root_svg = element
             break
 
@@ -355,36 +401,41 @@ class Maidr:
         return str(uuid.uuid4())
 
     @staticmethod
-    def _inject_plot(plot: HTML, maidr: str, maidr_id, use_iframe: bool = True) -> Tag:
+    def _inject_plot(plot: HTML, maidr: str | None, maidr_id, use_iframe: bool = True) -> Tag:
         """Embed the plot and associated MAIDR scripts into the HTML structure."""
         # Get the latest version from npm registry
         MAIDR_TS_CDN_URL = "https://cdn.jsdelivr.net/npm/maidr@latest/dist/maidr.js"
 
         script = f"""
-            if (!document.querySelector('script[src="{MAIDR_TS_CDN_URL}"]'))
-            {{
-                var script = document.createElement('script');
-                script.type = 'module';
-                script.src = '{MAIDR_TS_CDN_URL}';
-                script.addEventListener('load', function() {{
-                    window.main();
-                }});
-                document.head.appendChild(script);
-            }} else {{
-                document.addEventListener('DOMContentLoaded', function (e) {{
-                    window.main();
-                }});
-            }}
+            (function() {{
+                var existing = document.querySelector('script[src="{MAIDR_TS_CDN_URL}"]');
+                if (!existing) {{
+                    var s = document.createElement('script');
+                    s.src = '{MAIDR_TS_CDN_URL}';
+                    s.onload = function() {{ if (window.main) window.main(); }};
+                    document.head.appendChild(s);
+                }} else {{
+                    if (document.readyState === 'loading') {{
+                        document.addEventListener('DOMContentLoaded', function() {{ if (window.main) window.main(); }});
+                    }} else {{
+                        if (window.main) window.main();
+                    }}
+                }}
+            }})();
         """
 
-        base_html = tags.div(
+        children = [
             tags.link(
                 rel="stylesheet",
                 href="https://cdn.jsdelivr.net/npm/maidr@latest/dist/maidr_style.css",
-            ),
-            tags.script(script, type="text/javascript"),
-            tags.div(plot),
-        )
+            )
+        ]
+        if maidr is not None:
+            children.append(tags.script(maidr, type="text/javascript"))
+        children.append(tags.script(script, type="text/javascript"))
+        children.append(tags.div(plot))
+
+        base_html = tags.div(*children)
 
         # is_quarto = os.getenv("IS_QUARTO") == "True"
 

{maidr-1.8.1 → maidr-1.10.0}/maidr/core/plot/candlestick.py

@@ -1,24 +1,21 @@
 from __future__ import annotations
 
-import uuid
 from typing import Union, Dict
 from matplotlib.axes import Axes
-from matplotlib.patches import Rectangle
-import numpy as np
+import pandas as pd
 
 from maidr.core.enum import PlotType
 from maidr.core.plot import MaidrPlot
 from maidr.core.enum.maidr_key import MaidrKey
 from maidr.exception import ExtractionError
-from maidr.util.mplfinance_utils import MplfinanceDataExtractor
 
 
 class CandlestickPlot(MaidrPlot):
     """
     Specialized candlestick plot class for mplfinance OHLC data.
 
-    This class handles the extraction and processing of candlestick data from mplfinance
-    plots, including proper date conversion and data validation.
+    This class extracts candlestick data directly from the original DataFrame
+    without any formatting or transformation.
     """
 
     def __init__(self, axes: list[Axes], **kwargs) -> None:
@@ -34,23 +31,17 @@ class CandlestickPlot(MaidrPlot):
             Additional keyword arguments.
         """
         self.axes = axes
-        # Ensure there's at least one axis for the superclass init
         if not axes:
             raise ValueError("Axes list cannot be empty.")
         super().__init__(axes[0], PlotType.CANDLESTICK)
 
-        # Store custom collections passed from mplfinance patch
+        # Store collections passed from mplfinance patch
         self._maidr_wick_collection = kwargs.get("_maidr_wick_collection", None)
         self._maidr_body_collection = kwargs.get("_maidr_body_collection", None)
-        self._maidr_date_nums = kwargs.get("_maidr_date_nums", None)
-        self._maidr_original_data = kwargs.get(
-            "_maidr_original_data", None
-        )  # Store original data
-        self._maidr_datetime_converter = kwargs.get("_maidr_datetime_converter", None)
+        self._maidr_original_data = kwargs.get("_maidr_original_data", None)
 
-        # Store the GID for proper selector generation (legacy/shared)
+        # Store the GID for selector generation
         self._maidr_gid = None
-        # Modern-path separate gids for body and wick
         self._maidr_body_gid = None
         self._maidr_wick_gid = None
         if self._maidr_body_collection:
@@ -62,105 +53,83 @@ class CandlestickPlot(MaidrPlot):
 
     def _extract_plot_data(self) -> list[dict]:
         """
-        Extract candlestick data from the plot.
-
-        This method processes candlestick plots from both modern (mplfinance.plot) and
-        legacy (original_flavor) pipelines, extracting OHLC data and setting up
-        highlighting elements and GIDs.
+        Extract candlestick data directly from the original DataFrame.
 
         Returns
         -------
         list[dict]
             List of dictionaries containing candlestick data with keys:
-            - 'value': Date string
+            - 'value': Date string (raw from DataFrame index)
             - 'open': Opening price (float)
             - 'high': High price (float)
             - 'low': Low price (float)
             - 'close': Closing price (float)
-            - 'volume': Volume (float, typically 0 for candlestick-only plots)
+            - 'volume': Volume (float)
         """
-
-        # Get the custom collections from kwargs
         body_collection = self._maidr_body_collection
         wick_collection = self._maidr_wick_collection
 
         if body_collection and wick_collection:
-            # Store the GIDs from the collections (modern path)
+            # Store the GIDs from the collections
             self._maidr_body_gid = body_collection.get_gid()
             self._maidr_wick_gid = wick_collection.get_gid()
-            # Keep legacy gid filled for backward compatibility
             self._maidr_gid = self._maidr_body_gid or self._maidr_wick_gid
 
             # Use the original collections for highlighting
             self._elements = [body_collection, wick_collection]
 
-            # Use datetime converter for enhanced data extraction
-            if self._maidr_datetime_converter is not None:
-                data = self._maidr_datetime_converter.extract_candlestick_data(
-                    self.axes[0], wick_collection, body_collection
-                )
-                return data
-
-            # Fallback to original detection method
-            if not self.axes:
-                return []
-
-            ax_ohlc = self.axes[0]
-
-            # Look for Rectangle patches (original_flavor candlestick)
-            body_rectangles = []
-            for patch in ax_ohlc.patches:
-                if isinstance(patch, Rectangle):
-                    body_rectangles.append(patch)
-
-            if body_rectangles:
-                # Set elements for highlighting
-                self._elements = body_rectangles
-
-                # Generate a GID for highlighting if none exists
-                if not self._maidr_gid:
-                    self._maidr_gid = f"maidr-{uuid.uuid4()}"
-                    # Set GID on all rectangles
-                    for rect in body_rectangles:
-                        rect.set_gid(self._maidr_gid)
-                # Keep a dedicated body gid for legacy dict selectors
-                self._maidr_body_gid = (
-                    getattr(self, "_maidr_body_gid", None) or self._maidr_gid
-                )
-
-                # Assign a shared gid to wick Line2D (vertical 2-point lines) on the same axis
-                wick_lines = []
-                for line in ax_ohlc.get_lines():
-                    try:
-                        xydata = line.get_xydata()
-                        if xydata is None:
-                            continue
-                        xy_arr = np.asarray(xydata)
-                        if (
-                            xy_arr.ndim == 2
-                            and xy_arr.shape[0] == 2
-                            and xy_arr.shape[1] >= 2
-                        ):
-                            x0 = float(xy_arr[0, 0])
-                            x1 = float(xy_arr[1, 0])
-                            if abs(x0 - x1) < 1e-10:
-                                wick_lines.append(line)
-                    except Exception:
-                        continue
-                if wick_lines:
-                    if not getattr(self, "_maidr_wick_gid", None):
-                        self._maidr_wick_gid = f"maidr-{uuid.uuid4()}"
-                    for line in wick_lines:
-                        line.set_gid(self._maidr_wick_gid)
-
-                # Use the utility class to extract data
-                data = MplfinanceDataExtractor.extract_rectangle_candlestick_data(
-                    body_rectangles, self._maidr_date_nums, self._maidr_original_data
-                )
-                return data
+            # Extract data directly from DataFrame
+            if self._maidr_original_data is not None and isinstance(
+                self._maidr_original_data, pd.DataFrame
+            ):
+                return self._extract_from_dataframe(self._maidr_original_data)
 
         return []
 
+    def _extract_from_dataframe(self, df: pd.DataFrame) -> list[dict]:
+        """
+        Extract candlestick data directly from DataFrame without any formatting.
+
+        Parameters
+        ----------
+        df : pd.DataFrame
+            DataFrame with OHLC data and DatetimeIndex.
+
+        Returns
+        -------
+        list[dict]
+            List of candlestick data dictionaries with raw values.
+        """
+        candles = []
+
+        for i in range(len(df)):
+            try:
+                # Get date directly from index - raw representation
+                date_value = str(df.index[i])
+
+                # Get OHLC values directly from DataFrame columns
+                open_price = float(df.iloc[i]["Open"])
+                high_price = float(df.iloc[i]["High"])
+                low_price = float(df.iloc[i]["Low"])
+                close_price = float(df.iloc[i]["Close"])
+
+                # Get volume if available, otherwise 0
+                volume = float(df.iloc[i].get("Volume", 0.0))
+
+                candle_data = {
+                    "value": date_value,
+                    "open": open_price,
+                    "high": high_price,
+                    "low": low_price,
+                    "close": close_price,
+                    "volume": volume,
+                }
+                candles.append(candle_data)
+            except (KeyError, IndexError, ValueError, TypeError):
+                continue
+
+        return candles
+
     def _extract_axes_data(self) -> dict:
         """
         Extract the plot's axes data including labels.

{maidr-1.8.1 → maidr-1.10.0}/maidr/util/datetime_conversion.py

@@ -6,18 +6,16 @@ from datetime import datetime
 
 class DatetimeConverter:
     """
-    Enhanced datetime converter that automatically detects time periods
-    and provides intelligent date/time formatting for mplfinance plots.
+    Datetime converter for mplfinance plots.
 
-    This utility automatically detects the time period of financial data and formats
-    datetime values consistently for screen reader accessibility and visual clarity.
+    This utility provides datetime value conversion for financial data visualization.
 
     Parameters
     ----------
     data : pd.DataFrame
         DataFrame with DatetimeIndex containing financial data.
     datetime_format : str, optional
-        Custom datetime format string. If None, automatic format detection is used.
+        Custom datetime format string (currently unused, kept for compatibility).
 
     Attributes
     ----------
@@ -49,14 +47,14 @@ class DatetimeConverter:
     >>>
     >>> # Get formatted datetime
     >>> formatted = converter.get_formatted_datetime(0)
-    >>> print(formatted)  # Output: "Jan 15 2024"
+    >>> print(formatted)  # Output: "2024-01-15 00:00:00"
     >>>
     >>> # For time-based data
     >>> hourly_dates = pd.date_range('2024-01-15 09:00:00', periods=3, freq='H')
     >>> df_hourly = pd.DataFrame({'Open': [3050, 3078, 3080]}, index=hourly_dates)
     >>> converter_hourly = create_datetime_converter(df_hourly)
     >>> formatted_hourly = converter_hourly.get_formatted_datetime(0)
-    >>> print(formatted_hourly)  # Output: "Jan 15 2024 09:00"
+    >>> print(formatted_hourly)  # Output: "2024-01-15 09:00:00"
     """
 
     def __init__(
@@ -164,9 +162,7 @@ class DatetimeConverter:
 
     def get_formatted_datetime(self, index: int) -> Optional[str]:
         """
-        Get formatted datetime string for given index using consistent formatting.
-
-        Always includes year for screen reader accessibility.
+        Get datetime string for given index.
 
         Parameters
         ----------
@@ -176,13 +172,13 @@ class DatetimeConverter:
         Returns
         -------
         str or None
-            Formatted datetime string or None if index is invalid.
+            Datetime string or None if index is invalid.
 
         Examples
         --------
         >>> converter = create_datetime_converter(df)
         >>> formatted = converter.get_formatted_datetime(0)
-        >>> print(formatted)  # "Jan 15 2024" for daily data
+        >>> print(formatted)  # "2024-01-15 00:00:00"
         """
         if index not in self.date_mapping:
             return None
@@ -192,7 +188,7 @@ class DatetimeConverter:
 
     def _format_datetime_custom(self, dt: datetime) -> str:
         """
-        Consistent datetime formatting with year always included.
+        Format datetime as-is using ISO format.
 
         Parameters
         ----------
@@ -202,24 +198,15 @@ class DatetimeConverter:
         Returns
         -------
         str
-            Formatted datetime string with consistent pattern.
+            Formatted datetime string in ISO format.
 
         Notes
         -----
-        Formatting rules:
-        - Daily data: "Jan 15 2024"
-        - Time-based data: "Jan 15 2024 09:00" or "Jan 15 2024 09:00:30"
-        - Seconds are only shown when they are non-zero for cleaner display.
+        Returns the datetime as a string without smart formatting.
+        Output format is "YYYY-MM-DD HH:MM:SS" (e.g., "2024-01-15 00:00:00").
         """
-        if self.time_period in ["minute", "intraday", "hour"]:
-            # Time-based data: include time with optional seconds
-            if dt.second == 0:
-                return dt.strftime("%b %d %Y %H:%M")
-            else:
-                return dt.strftime("%b %d %Y %H:%M:%S")
-        else:
-            # Daily/weekly/monthly data: just date
-            return dt.strftime("%b %d %Y")
+        # Return string representation of datetime
+        return str(dt)
 
     @property
     def date_nums(self) -> List[float]: