maidr 1.3.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

maidr/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.3.0"
+__version__ = "1.4.1"
 
 from .api import close, render, save_html, show, stacked
 from .core import Maidr
@@ -15,6 +15,7 @@ from .patch import (
     scatterplot,
     regplot,
     kdeplot,
+    mplfinance,
 )
 
 __all__ = [

maidr/core/maidr.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
 from datetime import datetime
+import urllib.request
+import urllib.error
+import json
 
 import io
 import json
@@ -22,6 +25,11 @@ from maidr.core.plot import MaidrPlot
 from maidr.util.environment import Environment
 from maidr.util.dedup_utils import deduplicate_smooth_and_line
 
+# Module-level cache for version to avoid repeated API calls
+_MAIDR_VERSION_CACHE: str | None = None
+_MAIDR_VERSION_CACHE_TIME: float = 0.0
+_MAIDR_CACHE_DURATION = 3600  # Cache for 1 hour
+
 
 class Maidr:
     """
@@ -34,6 +42,8 @@ class Maidr:
         The matplotlib figure associated with this instance.
     _plots : list[MaidrPlot]
         A list of MaidrPlot objects which hold additional plot-specific configurations.
+    _cached_version : str | None
+        Cached version of maidr from npm registry to avoid repeated API calls.
 
     Methods
     -------
@@ -271,20 +281,77 @@ class Maidr:
         """Generate a unique identifier string using UUID4."""
         return str(uuid.uuid4())
 
+    @staticmethod
+    def _get_latest_maidr_version() -> str:
+        """
+        Query the npm registry API to get the latest version of maidr with caching.
+
+        Returns
+        -------
+        str
+            The latest version of maidr from npm registry, or 'latest' as fallback.
+        """
+        import time
+
+        global _MAIDR_VERSION_CACHE, _MAIDR_VERSION_CACHE_TIME
+
+        # Check if version fetching is disabled via environment variable
+        if os.getenv("MAIDR_DISABLE_VERSION_FETCH", "").lower() in ("true", "1", "yes"):
+            return "latest"
+
+        current_time = time.time()
+
+        # Check if we have a valid cached version
+        if (
+            _MAIDR_VERSION_CACHE is not None
+            and current_time - _MAIDR_VERSION_CACHE_TIME < _MAIDR_CACHE_DURATION
+        ):
+            return _MAIDR_VERSION_CACHE
+
+        try:
+            # Query npm registry API for maidr package
+            with urllib.request.urlopen(
+                "https://registry.npmjs.org/maidr/latest", timeout=5  # 5 second timeout
+            ) as response:
+                if response.status == 200:
+                    data = json.loads(response.read().decode("utf-8"))
+                    version = data.get("version", "latest")
+
+                    # Cache the successful result
+                    _MAIDR_VERSION_CACHE = version
+                    _MAIDR_VERSION_CACHE_TIME = current_time
+
+                    return version
+
+        except Exception:
+            # Any error - just use latest
+            pass
+
+        # Fallback to 'latest' if API call fails
+        return "latest"
+
+    @staticmethod
+    def clear_version_cache() -> None:
+        """Clear the cached version to force a fresh API call on next request."""
+        global _MAIDR_VERSION_CACHE, _MAIDR_VERSION_CACHE_TIME
+        _MAIDR_VERSION_CACHE = None
+        _MAIDR_VERSION_CACHE_TIME = 0.0
+
     @staticmethod
     def _inject_plot(plot: HTML, maidr: str, maidr_id, use_iframe: bool = True) -> Tag:
         """Embed the plot and associated MAIDR scripts into the HTML structure."""
-        # MAIDR_TS_CDN_URL = "http://localhost:8888/tree/maidr/core/maidr.js"  # DEMO URL
-        MAIDR_TS_CDN_URL = "https://cdn.jsdelivr.net/npm/maidr@latest/dist/maidr.js"
-        # Append a query parameter (using TIMESTAMP) to bust the cache (so that the latest (non-cached) version is always loaded).
-        TIMESTAMP = datetime.now().strftime("%Y%m%d%H%M%S")
+        # Get the latest version from npm registry
+        latest_version = Maidr._get_latest_maidr_version()
+        MAIDR_TS_CDN_URL = (
+            f"https://cdn.jsdelivr.net/npm/maidr@{latest_version}/dist/maidr.js"
+        )
 
         script = f"""
-            if (!document.querySelector('script[src="{MAIDR_TS_CDN_URL}?v={TIMESTAMP}"]'))
+            if (!document.querySelector('script[src="{MAIDR_TS_CDN_URL}"]'))
             {{
                 var script = document.createElement('script');
                 script.type = 'module';
-                script.src = '{MAIDR_TS_CDN_URL}?v={TIMESTAMP}';
+                script.src = '{MAIDR_TS_CDN_URL}';
                 script.addEventListener('load', function() {{
                     window.main();
                 }});
@@ -299,7 +366,7 @@ class Maidr:
         base_html = tags.div(
             tags.link(
                 rel="stylesheet",
-                href="https://cdn.jsdelivr.net/npm/maidr/dist/maidr_style.css",
+                href=f"https://cdn.jsdelivr.net/npm/maidr@{latest_version}/dist/maidr_style.css",
             ),
             tags.script(script, type="text/javascript"),
             tags.div(plot),

maidr/core/plot/candlestick.py

@@ -1,14 +1,24 @@
+from __future__ import annotations
+
 import matplotlib.dates as mdates
 import numpy as np
 from matplotlib.axes import Axes
-from matplotlib.collections import LineCollection, PatchCollection
 from matplotlib.patches import Rectangle
 
-from maidr.core.enum.plot_type import PlotType
-from maidr.core.plot.maidr_plot import MaidrPlot
+from maidr.core.enum import PlotType
+from maidr.core.plot import MaidrPlot
+from maidr.core.enum.maidr_key import MaidrKey
+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.
+    """
+
     def __init__(self, axes: list[Axes], **kwargs) -> None:
         """
         Initialize the CandlestickPlot.
@@ -27,213 +37,111 @@ class CandlestickPlot(MaidrPlot):
             raise ValueError("Axes list cannot be empty.")
         super().__init__(axes[0], PlotType.CANDLESTICK)
 
+        # Store custom 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)
+
+        # Store the GID for proper selector generation
+        self._maidr_gid = None
+        if self._maidr_body_collection:
+            self._maidr_gid = self._maidr_body_collection.get_gid()
+        elif self._maidr_wick_collection:
+            self._maidr_gid = self._maidr_wick_collection.get_gid()
+
     def _extract_plot_data(self) -> list[dict]:
-        """
-        Extracts candlestick (OHLC) and volume data from the plot axes.
+        """Extract candlestick data from the plot."""
 
-        This method assumes that the candlestick chart is structured with
-        LineCollection for wicks and PatchCollection of Rectangles for bodies
-        on the first axis (self.axes[0]). Volume data is expected as a
-        PatchCollection of Rectangles on the second axis (self.axes[1]), if present.
-        Open and close prices are inferred from the body rectangle's color.
+        # Get the custom collections from kwargs
+        body_collection = self._maidr_body_collection
+        wick_collection = self._maidr_wick_collection
 
-        Returns
-        -------
-        list[dict]
-            A list of dictionaries, where each dictionary represents a data point
-            with 'value' (date string YYYY-MM-DD), 'open', 'high', 'low',
-            'close', and 'volume'. Fields that cannot be extracted will be None.
-
-        Examples
-        --------
-        Assuming a plot has been generated and `plot_instance.axes` is populated:
-        >>> data = plot_instance._extract_plot_data()
-        >>> print(data[0])
-        {
-            'value': '2021-01-01',
-            'open': 100.0,
-            'high': 100.9,
-            'low': 99.27,
-            'close': 100.75,
-            'volume': 171914,
-        }
-        """
+        if body_collection and wick_collection:
+            # Store the GID from the body collection for highlighting
+            self._maidr_gid = body_collection.get_gid()
+
+            # Use the original collections for highlighting
+            self._elements = [body_collection, wick_collection]
+
+            # Use the utility class to extract data
+            return MplfinanceDataExtractor.extract_candlestick_data(
+                body_collection, wick_collection, self._maidr_date_nums
+            )
+
+        # Fallback to original detection method
         if not self.axes:
             return []
 
-        plot_data: list[dict] = []
-        ax_ohlc: Axes = self.axes[0]
-
-        body_rectangles: list[Rectangle] = []
-        wick_collection: LineCollection | None = None
-
-        # Find candlestick body Rectangles from the OHLC axis
-        # Prefer PatchCollection containing Rectangles, fallback to individual Rectangles in ax.patches
-        for collection in ax_ohlc.collections:
-            if isinstance(collection, PatchCollection):
-                # Check if the collection's patches are Rectangles
-                try:
-                    # Iterating a PatchCollection yields its constituent Patch objects
-                    patches_are_rects = all(
-                        isinstance(p, Rectangle) for p in collection
-                    )
-                    if (
-                        patches_are_rects and len(collection.get_paths()) > 0
-                    ):  # Ensure it has paths and they are Rectangles
-                        for (
-                            patch
-                        ) in collection:  # Iterate to get actual Rectangle objects
-                            if isinstance(patch, Rectangle):
-                                body_rectangles.append(patch)
-                        if (
-                            body_rectangles
-                        ):  # If we found rectangles this way, assume this is the primary body collection
-                            break
-                except Exception:
-                    # Could fail if collection is not iterable in the expected way or patches are not Rectangles
-                    pass
-
-        if not body_rectangles:
-            for patch in ax_ohlc.patches:
-                if isinstance(patch, Rectangle):
-                    body_rectangles.append(patch)
-
-        if not body_rectangles:
-            pass
-
-        ax_for_wicks: Axes | None = None
-        if len(self.axes) > 1:
-            ax_for_wicks = self.axes[1]
-
-        if ax_for_wicks:
-            # Attempt 1: Find wicks in ax_for_wicks.collections (as a LineCollection)
-            for collection in ax_for_wicks.collections:
-                if isinstance(collection, LineCollection):
-                    segments = collection.get_segments()
-                    # Check if the collection contains segments and the first segment looks like a vertical line
-                    if segments is not None and len(segments) > 0:
-                        first_segment = segments[0]
-                        if (
-                            len(first_segment) == 2  # Segment consists of two points
-                            and len(first_segment[0]) == 2  # First point has (x, y)
-                            and len(first_segment[1]) == 2  # Second point has (x, y)
-                            and np.isclose(
-                                first_segment[0][0], first_segment[1][0]
-                            )  # X-coordinates are close (vertical)
-                        ):
-                            wick_collection = collection
-                            break  # Found a suitable LineCollection
-
-            # Attempt 2: If no LineCollection found, try to find wicks from individual Line2D objects in ax_for_wicks.get_lines()
-            if not wick_collection and hasattr(ax_for_wicks, "get_lines"):
-                potential_wick_segments = []
-                for line in ax_for_wicks.get_lines():  # Iterate over Line2D objects
-                    x_data, y_data = line.get_data()
-                    # A wick is typically a vertical line defined by two points.
-                    if len(x_data) == 2 and len(y_data) == 2:
-                        if np.isclose(x_data[0], x_data[1]):  # Check for verticality
-                            # Create a segment in the format [[x1, y1], [x2, y2]]
-                            segment = [
-                                [x_data[0], y_data[0]],
-                                [x_data[1], y_data[1]],
-                            ]
-                            potential_wick_segments.append(segment)
-
-                if potential_wick_segments:
-                    # If wick segments were found from individual lines,
-                    # create a new LineCollection to hold them.
-                    # This allows the downstream processing logic
-                    # for wicks to remain consistent.
-                    # Basic properties are set; color/linestyle
-                    # are defaults and may not match
-                    # the original plot's styling if that
-                    # were relevant for segment extraction.
-                    wick_collection = LineCollection(
-                        potential_wick_segments,
-                        colors="k",  # Default color for the temporary collection
-                        linestyles="solid",  # Default linestyle
-                    )
-
-        # Process wicks into a map: x_coordinate -> (low_price, high_price)
-        wick_segments_map: dict[float, tuple[float, float]] = {}
-        if wick_collection:
-            for seg in wick_collection.get_segments():
-                if len(seg) == 2 and len(seg[0]) == 2 and len(seg[1]) == 2:
-                    # Ensure x-coordinates are (nearly) identical for a vertical wick line
-                    if np.isclose(seg[0][0], seg[1][0]):
-                        x_coord = seg[0][0]  # Matplotlib date number
-                        low_price = min(seg[0][1], seg[1][1])
-                        high_price = max(seg[0][1], seg[1][1])
-                        wick_segments_map[x_coord] = (low_price, high_price)
-
-        body_rectangles.sort(key=lambda r: r.get_x())
-
-        for rect in body_rectangles:
-            x_left = rect.get_x()
-            width = rect.get_width()
-            x_center_num = x_left + width / 2.0
-
-            try:
-                date_dt = mdates.num2date(x_center_num)
-                date_str = date_dt.strftime("%Y-%m-%d")
-            except ValueError:
-                date_str = f"raw_date_{x_center_num:.2f}"
-
-            y_bottom = rect.get_y()
-            height = rect.get_height()
-            face_color = rect.get_facecolor()  # RGBA tuple
-
-            # Infer open and close prices
-            # Heuristic: Green component > Red component for an "up" candle (close > open)
-            # This assumes standard green for up, red for down.
-            # A more robust method would involve knowing the exact up/down colors used.
-            is_up_candle = (
-                face_color[1] > face_color[0]
-            )  # Compare Green and Red components
-
-            if is_up_candle:  # Typically green: price went up
-                open_price = y_bottom
-                close_price = y_bottom + height
-            else:  # Typically red: price went down (or other color)
-                close_price = y_bottom
-                open_price = y_bottom + height
-
-            matched_wick_data = None
-            closest_wick_x = None
-            min_diff = float("inf")
-
-            for wick_x, prices in wick_segments_map.items():
-                diff = abs(wick_x - x_center_num)
-                if diff < min_diff:
-                    min_diff = diff
-                    closest_wick_x = wick_x
-
-            # Tolerance for matching wick x-coordinate (e.g., 10% of candle width)
-            if closest_wick_x is not None and min_diff < (width * 0.1):
-                matched_wick_data = wick_segments_map[closest_wick_x]
-
-            if matched_wick_data:
-                low_price, high_price = matched_wick_data
-                # Ensure high >= max(open,close) and low <= min(open,close)
-                high_price = max(high_price, open_price, close_price)
-                low_price = min(low_price, open_price, close_price)
-            else:
-                # Fallback if no wick found: high is max(open,close), low is min(open,close)
-                high_price = max(open_price, close_price)
-                low_price = min(open_price, close_price)
-
-            plot_data.append(
-                {
-                    "value": date_str,
-                    "open": open_price,
-                    "high": high_price,
-                    "low": low_price,
-                    "close": close_price,
-                    "volume": 0,
-                }
+        ax_ohlc = self.axes[0]
+        candles = []
+
+        # 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:
+                import uuid
+
+                self._maidr_gid = f"maidr-{uuid.uuid4()}"
+                # Set GID on all rectangles
+                for rect in body_rectangles:
+                    rect.set_gid(self._maidr_gid)
+
+            # Use the utility class to extract data
+            return MplfinanceDataExtractor.extract_rectangle_candlestick_data(
+                body_rectangles, self._maidr_date_nums
             )
-        self._elements.extend(body_rectangles)
-        return plot_data
+
+        return []
 
     def _extract_axes_data(self) -> dict:
-        return {}
+        """
+        Extract the plot's axes data including labels.
+
+        Returns
+        -------
+        dict
+            Dictionary containing x and y axis labels.
+        """
+        x_labels = self.ax.get_xlabel()
+        if not x_labels:
+            x_labels = self.extract_shared_xlabel(self.ax)
+        if not x_labels:
+            x_labels = "X"
+        return {MaidrKey.X: x_labels, MaidrKey.Y: self.ax.get_ylabel()}
+
+    def _get_selector(self) -> str:
+        """Return the CSS selector for highlighting candlestick elements in the SVG output."""
+        # Use the stored GID if available, otherwise fall back to generic selector
+        if self._maidr_gid:
+            # Use the full GID as the id attribute (since that's what's in the SVG)
+            selector = (
+                f"g[id='{self._maidr_gid}'] > path, g[id='{self._maidr_gid}'] > rect"
+            )
+        else:
+            selector = "g[maidr='true'] > path, g[maidr='true'] > rect"
+        return selector
+
+    def render(self) -> dict:
+        """Initialize the MAIDR schema dictionary with basic plot information."""
+        title = "Candlestick Chart"
+
+        maidr_schema = {
+            MaidrKey.TYPE: self.type,
+            MaidrKey.TITLE: title,
+            MaidrKey.AXES: self._extract_axes_data(),
+            MaidrKey.DATA: self._extract_plot_data(),
+        }
+
+        # Include selector only if the plot supports highlighting.
+        if self._support_highlighting:
+            maidr_schema[MaidrKey.SELECTOR] = self._get_selector()
+
+        return maidr_schema

maidr/core/plot/maidr_plot.py

@@ -42,8 +42,13 @@ class MaidrPlot(ABC):
         self._support_highlighting = True
         self._elements = []
         ss = self.ax.get_subplotspec()
-        self.row_index = ss.rowspan.start
-        self.col_index = ss.colspan.start
+        # Handle cases where subplotspec is None (dynamically created axes)
+        if ss is not None:
+            self.row_index = ss.rowspan.start
+            self.col_index = ss.colspan.start
+        else:
+            self.row_index = 0
+            self.col_index = 0
 
         # MAIDR data
         self.type = plot_type

maidr/core/plot/maidr_plot_factory.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from matplotlib.axes import Axes
-
 from maidr.core.enum import PlotType
 from maidr.core.plot.barplot import BarPlot
 from maidr.core.plot.boxplot import BoxPlot
@@ -13,6 +12,9 @@ from maidr.core.plot.lineplot import MultiLinePlot
 from maidr.core.plot.maidr_plot import MaidrPlot
 from maidr.core.plot.scatterplot import ScatterPlot
 from maidr.core.plot.regplot import SmoothPlot
+from maidr.core.plot.mplfinance_barplot import MplfinanceBarPlot
+from maidr.core.plot.mplfinance_lineplot import MplfinanceLinePlot
+from maidr.util.plot_detection import PlotDetectionUtils
 
 
 class MaidrPlotFactory:
@@ -38,17 +40,13 @@ class MaidrPlotFactory:
             single_ax = ax
 
         if plot_type == PlotType.CANDLESTICK:
-            if isinstance(ax, list):
-                # If ax is a list of lists, flatten it
-                if ax and isinstance(ax[0], list):
-                    axes = ax[0]  # Take the first inner list
-                else:
-                    axes = ax  # Use the list as-is
-            else:
-                axes = [ax]  # Wrap single axes in list
+            axes = PlotDetectionUtils.get_candlestick_axes(ax)
             return CandlestickPlot(axes, **kwargs)
         elif PlotType.BAR == plot_type or PlotType.COUNT == plot_type:
-            return BarPlot(single_ax)
+            if PlotDetectionUtils.is_mplfinance_bar_plot(**kwargs):
+                return MplfinanceBarPlot(single_ax, **kwargs)
+            else:
+                return BarPlot(single_ax)
         elif PlotType.BOX == plot_type:
             return BoxPlot(single_ax, **kwargs)
         elif PlotType.HEAT == plot_type:
@@ -56,7 +54,10 @@ class MaidrPlotFactory:
         elif PlotType.HIST == plot_type:
             return HistPlot(single_ax)
         elif PlotType.LINE == plot_type:
-            return MultiLinePlot(single_ax)
+            if PlotDetectionUtils.is_mplfinance_line_plot(single_ax, **kwargs):
+                return MplfinanceLinePlot(single_ax, **kwargs)
+            else:
+                return MultiLinePlot(single_ax, **kwargs)
         elif PlotType.SCATTER == plot_type:
             return ScatterPlot(single_ax)
         elif PlotType.DODGED == plot_type or PlotType.STACKED == plot_type: