maidr 1.9.0__py3-none-any.whl → 1.11.0__py3-none-any.whl

maidr/util/mixin/format_extractor_mixin.py

@@ -0,0 +1,83 @@
+"""
+Mixin for extracting format configuration from matplotlib axes.
+
+This module provides a mixin class that can be used by plot classes
+to extract axis formatting information for the MAIDR schema.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from matplotlib.axes import Axes
+
+from maidr.util.format_config import extract_axis_format
+
+
+class FormatExtractorMixin:
+    """
+    Mixin class for extracting format configuration from axes.
+
+    This mixin provides methods to detect and extract formatting
+    configurations from matplotlib axis formatters, which can then
+    be included in the MAIDR schema.
+
+    Examples
+    --------
+    >>> class MyPlot(MaidrPlot, FormatExtractorMixin):
+    ...     def render(self):
+    ...         schema = super().render()
+    ...         format_config = self.extract_format(self.ax)
+    ...         if format_config:
+    ...             schema["format"] = format_config
+    ...         return schema
+    """
+
+    @staticmethod
+    def extract_format(ax: Axes) -> Optional[Dict[str, Dict[str, Any]]]:
+        """
+        Extract format configuration from an axes object.
+
+        This method detects matplotlib formatters applied to the x and y axes
+        and converts them to MAIDR-compatible format configurations.
+
+        Parameters
+        ----------
+        ax : Axes
+            The matplotlib Axes object to extract formats from.
+
+        Returns
+        -------
+        Dict[str, Dict[str, Any]] or None
+            Dictionary with 'x' and/or 'y' keys containing format configurations,
+            or None if no formats could be detected.
+
+        Notes
+        -----
+        Supported formatter types:
+        - StrMethodFormatter: Detected by parsing format string
+        - PercentFormatter: Detected as percent type
+        - ScalarFormatter: Detected for scientific notation
+        - FormatStrFormatter: Detected by parsing old-style format string
+
+        Format detection examples:
+        - "${x:,.2f}" -> {"type": "currency", "currency": "USD", "decimals": 2}
+        - "{x:.1%}" -> {"type": "percent", "decimals": 1}
+        - "{x:.2e}" -> {"type": "scientific", "decimals": 2}
+
+        Examples
+        --------
+        >>> from matplotlib import pyplot as plt
+        >>> fig, ax = plt.subplots()
+        >>> ax.yaxis.set_major_formatter('${x:,.2f}')
+        >>> format_config = FormatExtractorMixin.extract_format(ax)
+        >>> format_config
+        {'y': {'type': 'currency', 'decimals': 2, 'currency': 'USD'}}
+        """
+        if ax is None:
+            return None
+
+        format_config = extract_axis_format(ax)
+
+        # Return None if no formats were detected
+        return format_config if format_config else None

maidr/util/mplfinance_utils.py

@@ -2,11 +2,10 @@
 Utility functions for handling mplfinance-specific data extraction and processing.
 """
 
+import re
 import matplotlib.dates as mdates
-import numpy as np
 from matplotlib.patches import Rectangle
-from typing import List, Optional, Tuple, Any, Union
-import pandas as pd
+from typing import List, Optional
 
 
 class MplfinanceDataExtractor:
@@ -58,229 +57,6 @@ class MplfinanceDataExtractor:
 
         return formatted_data
 
-    @staticmethod
-    def extract_candlestick_data(
-        body_collection: Any,
-        wick_collection: Any,
-        date_nums: Optional[List[float]] = None,
-        original_data: Optional[Union[pd.DataFrame, pd.Series, dict]] = None,
-    ) -> List[dict]:
-        """
-        Extract candlestick data from mplfinance collections.
-
-        Parameters
-        ----------
-        body_collection : Any
-            PolyCollection containing candlestick bodies
-        wick_collection : Any
-            LineCollection containing candlestick wicks
-        date_nums : Optional[List[float]], default=None
-            List of matplotlib date numbers corresponding to the candles
-        original_data : Optional[Union[pd.DataFrame, pd.Series, dict]], default=None
-            Original DataFrame/Series/dict with OHLC data for accurate bull/bear classification
-
-        Returns
-        -------
-        List[dict]
-            List of dictionaries with OHLC data
-        """
-        if not body_collection or not hasattr(body_collection, "get_paths"):
-            return []
-
-        candles = []
-        paths = body_collection.get_paths()
-
-        for i, path in enumerate(paths):
-            if len(path.vertices) >= 4:
-                # Extract rectangle coordinates from the path
-                vertices = path.vertices
-                x_coords = vertices[:, 0]
-                y_coords = vertices[:, 1]
-
-                x_min, x_max = x_coords.min(), x_coords.max()
-                y_min, y_max = y_coords.min(), y_coords.max()
-
-                # Use date mapping if available
-                if date_nums is not None and i < len(date_nums):
-                    date_num = date_nums[i]
-                    date_str = MplfinanceDataExtractor._convert_date_num_to_string(
-                        date_num
-                    )
-                else:
-                    x_center = (x_min + x_max) / 2
-                    date_str = MplfinanceDataExtractor._convert_date_num_to_string(
-                        x_center
-                    )
-
-                # Determine if this is an up or down candle using original data
-                is_up = MplfinanceDataExtractor._determine_bull_bear_from_data(
-                    original_data, i, date_str
-                )
-
-                # Extract OHLC values
-                (
-                    open_val,
-                    close_val,
-                ) = MplfinanceDataExtractor._extract_ohlc_from_rectangle(
-                    y_min, y_max, is_up
-                )
-
-                # Estimate high and low (these would normally come from wick data)
-                high_val = y_max + (y_max - y_min) * 0.1
-                low_val = y_min - (y_max - y_min) * 0.1
-
-                candle_data = {
-                    "value": date_str,
-                    "open": round(open_val, 2),
-                    "high": round(high_val, 2),
-                    "low": round(low_val, 2),
-                    "close": round(close_val, 2),
-                    "volume": 0,  # Volume is handled separately
-                }
-
-                candles.append(candle_data)
-
-        return candles
-
-    @staticmethod
-    def extract_rectangle_candlestick_data(
-        body_rectangles: List[Rectangle],
-        date_nums: Optional[List[float]] = None,
-        original_data: Optional[Union[pd.DataFrame, pd.Series, dict]] = None,
-    ) -> List[dict]:
-        """
-        Extract candlestick data from Rectangle patches (original_flavor).
-
-        Parameters
-        ----------
-        body_rectangles : List[Rectangle]
-            List of Rectangle patches representing candlestick bodies
-        date_nums : Optional[List[float]], default=None
-            List of matplotlib date numbers corresponding to the candles
-        original_data : Optional[Union[pd.DataFrame, pd.Series, dict]], default=None
-            Original DataFrame/Series/dict with OHLC data for accurate bull/bear classification
-
-        Returns
-        -------
-        List[dict]
-            List of dictionaries with OHLC data
-        """
-        if not body_rectangles:
-            return []
-
-        candles = []
-
-        # Sort rectangles by x-coordinate
-        body_rectangles.sort(key=lambda r: r.get_x())
-
-        for i, rect in enumerate(body_rectangles):
-            x_left = rect.get_x()
-            width = rect.get_width()
-            x_center_num = x_left + width / 2.0
-
-            # Convert x coordinate to date
-            if date_nums is not None and i < len(date_nums):
-                date_str = MplfinanceDataExtractor._convert_date_num_to_string(
-                    date_nums[i]
-                )
-            else:
-                date_str = MplfinanceDataExtractor._convert_date_num_to_string(
-                    x_center_num
-                )
-
-            y_bottom = rect.get_y()
-            height = rect.get_height()
-
-            # Determine if this is an up or down candle using original data
-            is_up_candle = MplfinanceDataExtractor._determine_bull_bear_from_data(
-                original_data, i, date_str
-            )
-
-            # Extract OHLC values from rectangle
-            (
-                open_price,
-                close_price,
-            ) = MplfinanceDataExtractor._extract_ohlc_from_rectangle(
-                y_bottom, y_bottom + height, is_up_candle
-            )
-
-            # Estimate high and low
-            high_price = max(open_price, close_price) + height * 0.1
-            low_price = min(open_price, close_price) - height * 0.1
-
-            # Ensure all values are valid numbers
-            open_price = float(open_price) if not np.isnan(open_price) else 0.0
-            high_price = float(high_price) if not np.isnan(high_price) else 0.0
-            low_price = float(low_price) if not np.isnan(low_price) else 0.0
-            close_price = float(close_price) if not np.isnan(close_price) else 0.0
-
-            candle_data = {
-                "value": date_str,
-                "open": round(open_price, 2),
-                "high": round(high_price, 2),
-                "low": round(low_price, 2),
-                "close": round(close_price, 2),
-                "volume": 0,
-            }
-
-            candles.append(candle_data)
-
-        return candles
-
-    @staticmethod
-    def _determine_bull_bear_from_data(
-        original_data: Optional[Union[pd.DataFrame, pd.Series, dict]],
-        index: int,
-        date_str: str,
-    ) -> bool:
-        """
-        Determine if a candle is bullish (up) or bearish (down) using original OHLC data.
-
-        This is the most robust method as it uses the actual data rather than colors.
-
-        Parameters
-        ----------
-        original_data : Optional[Union[pd.DataFrame, pd.Series, dict]]
-            Original DataFrame/Series/dict with OHLC data
-        index : int
-            Index of the candle
-        date_str : str
-            Date string for the candle
-
-        Returns
-        -------
-        bool
-            True if bullish (close > open), False if bearish (close < open)
-        """
-        # Default to bullish if no data available
-        if original_data is None:
-            return True
-
-        try:
-            # Try to access the original data
-            if hasattr(original_data, "iloc"):
-                # It's a pandas DataFrame/Series
-                if index < len(original_data):
-                    row = original_data.iloc[index]
-                    if "Close" in row and "Open" in row:
-                        is_bullish = row["Close"] > row["Open"]
-                        return is_bullish
-
-            elif hasattr(original_data, "__getitem__"):
-                # It's a dictionary or similar
-                if "Close" in original_data and "Open" in original_data:
-                    closes = original_data["Close"]
-                    opens = original_data["Open"]
-                    if index < len(closes) and index < len(opens):
-                        is_bullish = closes[index] > opens[index]
-                        return is_bullish
-
-        except (KeyError, IndexError, AttributeError):
-            pass
-
-        # Fallback to bullish if data access fails
-        return True  # Default to bullish
-
     @staticmethod
     def clean_axis_label(label: str) -> str:
         """
@@ -299,8 +75,6 @@ class MplfinanceDataExtractor:
         if not label or not isinstance(label, str):
             return label
 
-        import re
-
         # Removes LaTeX-like scientific notation, e.g., "$10^{6}$"
         cleaned_label = re.sub(r"\s*\$.*?\$", "", label).strip()
         return cleaned_label if cleaned_label else label
@@ -318,7 +92,7 @@ class MplfinanceDataExtractor:
         Returns
         -------
         str
-            Date string in YYYY-MM-DD format or fallback index
+            Date string representation (e.g., "2024-01-15 00:00:00") or fallback index
         """
         try:
             # Check if this looks like a matplotlib date number (typically > 700000)
@@ -326,14 +100,14 @@ class MplfinanceDataExtractor:
                 date_dt = mdates.num2date(date_num)
                 if hasattr(date_dt, "replace"):
                     date_dt = date_dt.replace(tzinfo=None)
-                return date_dt.strftime("%Y-%m-%d")
+                return str(date_dt)
             elif date_num > 1000:
                 # Try converting as if it's a pandas timestamp
                 try:
                     import pandas as pd
 
                     date_dt = pd.to_datetime(date_num, unit="D")
-                    return date_dt.strftime("%Y-%m-%d")
+                    return str(date_dt)
                 except (ValueError, TypeError):
                     pass
         except (ValueError, TypeError, OverflowError):
@@ -341,75 +115,3 @@ class MplfinanceDataExtractor:
 
         # Fallback to index-based date string
         return f"date_{int(date_num):03d}"
-
-    @staticmethod
-    def convert_x_to_date(x_center_num: float, axes: Optional[List] = None) -> str:
-        """
-        Convert matplotlib x-coordinate to date string.
-
-        Parameters
-        ----------
-        x_center_num : float
-            X-coordinate value to convert
-        axes : Optional[List], optional
-            List of matplotlib axes to help with date conversion
-
-        Returns
-        -------
-        str
-            Date string in YYYY-MM-DD format or fallback
-        """
-        # First, try to get the actual dates from the axes x-axis data
-        if axes and len(axes) > 0:
-            ax = axes[0]
-            try:
-                # Get x-axis ticks which might contain the actual dates
-                x_ticks = ax.get_xticks()
-
-                # If we have x-axis ticks and they look like dates (large numbers), use them
-                if len(x_ticks) > 0 and x_ticks[0] > 1000:
-                    # Find the closest tick to our x_center_num
-                    tick_index = int(round(x_center_num))
-                    if 0 <= tick_index < len(x_ticks):
-                        actual_date_num = x_ticks[tick_index]
-
-                        # Convert the actual date number
-                        if actual_date_num > 700000:
-                            date_dt = mdates.num2date(actual_date_num)
-                            if hasattr(date_dt, "replace"):
-                                date_dt = date_dt.replace(tzinfo=None)
-                            date_str = date_dt.strftime("%Y-%m-%d")
-                            return date_str
-            except Exception:
-                pass
-
-        # Use the utility class for date conversion
-        return MplfinanceDataExtractor._convert_date_num_to_string(x_center_num)
-
-    @staticmethod
-    def _extract_ohlc_from_rectangle(
-        y_min: float, y_max: float, is_up: bool
-    ) -> Tuple[float, float]:
-        """
-        Extract open and close values from rectangle bounds.
-
-        Parameters
-        ----------
-        y_min : float
-            Minimum y value of rectangle
-        y_max : float
-            Maximum y value of rectangle
-        is_up : bool
-            Whether this is an up candle
-
-        Returns
-        -------
-        Tuple[float, float]
-            (open_price, close_price)
-        """
-        if is_up:
-            # Up candle: open at bottom, close at top
-            return y_min, y_max
-        else:
-            # Down candle: open at top, close at bottom
-            return y_max, y_min

{maidr-1.9.0.dist-info → maidr-1.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maidr
-Version: 1.9.0
+Version: 1.11.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.9.0.dist-info → maidr-1.11.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-maidr/__init__.py,sha256=szUjuM4cnGyzipfrIxpyZV841yhHjMmIcP7yXHq7kq8,415
+maidr/__init__.py,sha256=F_rKqEP7cG3G5_iKehrmY967FA1fiwdVXlibD7MotpM,416
 maidr/api.py,sha256=WK7jfQttuPeF1q45RuF_wTciYyiFY6SyjfZVSOVkiUs,4316
 maidr/core/__init__.py,sha256=WgxLpSEYMc4k3OyEOf1shOxfEq0ASzppEIZYmE91ThQ,25
 maidr/core/context_manager.py,sha256=6cT7ZGOApSpC-SLD2XZWWU_H08i-nfv-JUlzXOtvWYw,3374
@@ -6,21 +6,21 @@ maidr/core/figure_manager.py,sha256=t-lhe4jj2gsF5-8VUBUZOPlDutKjm_AZ8xXWJU2pFRc,
 maidr/core/maidr.py,sha256=Ye2C8tQPY1o8gfURiTyDPMWFoRT0toZOOCugKAz4uQU,22370
 maidr/core/enum/__init__.py,sha256=9ee78L0dlxEx4ulUGVlD-J23UcUZmrGu0rXms54up3c,93
 maidr/core/enum/library.py,sha256=e8ujT_L-McJWfoVJd1ty9K_2bwITnf1j0GPLsnAcHes,104
-maidr/core/enum/maidr_key.py,sha256=ljG0omqzd8K8Yk213N7i7PXGvG-IOlnE5v7o6RoGJzc,795
+maidr/core/enum/maidr_key.py,sha256=qO8dsRuMqiGmBHygSLRcu-wvfhch_3nY0PUvFBZkLH4,817
 maidr/core/enum/plot_type.py,sha256=7Orx3b_0NdpI_PtVJfLyJPh4qBqYMTsYBBr8VwOtiAM,347
 maidr/core/enum/smooth_keywords.py,sha256=z2kVZZ-mETWWh5reWu_hj9WkJD6WFj7_2-6s1e4C1JE,236
 maidr/core/plot/__init__.py,sha256=xDIpRGM-4DfaSSL3nKcXrjdMecCHJ6en4K4nA_fPefQ,83
 maidr/core/plot/barplot.py,sha256=0hBgp__putezvxXc9G3qmaktmAzze3cN8pQMD9iqktE,2116
 maidr/core/plot/boxplot.py,sha256=i11GdNuz_c-hilmhydu3ah-bzyVdFoBkNvRi5lpMrrY,9946
-maidr/core/plot/candlestick.py,sha256=ofvlUwtzaaopvv6VjNDf1IZODbu1UkMHsi1zdvcG-Yo,10120
+maidr/core/plot/candlestick.py,sha256=r_x3KVLNn6wFX7wYsRUFEp_rNTEjhbAkLk55kX2tIso,8170
 maidr/core/plot/grouped_barplot.py,sha256=odZ52Pl22nb9cWKD3NGsZsyFDxXdBDAEcbOj66HKp9I,4063
 maidr/core/plot/heatmap.py,sha256=yMS-31tS2GW4peds9LtZesMxmmTV_YfqYO5M_t5KasQ,2521
 maidr/core/plot/histogram.py,sha256=QV5W-6ZJQQcZsrM91JJBX-ONktJzH7yg_et5_bBPfQQ,1525
 maidr/core/plot/lineplot.py,sha256=uoJpGkJB3IJSDJTwH6ECxLyXGdarsVQNULELp5NncWg,4522
-maidr/core/plot/maidr_plot.py,sha256=heotWue1IzMOXnpoHVCqKSW88Sfep1IuuP4MBarpSek,4231
+maidr/core/plot/maidr_plot.py,sha256=_Jt0ILyUaMP68kX35Fgd16FcsizUAy52Y54YfVm2bEs,4580
 maidr/core/plot/maidr_plot_factory.py,sha256=NW2iFScswgXbAC9rAOo4iMkAFsjY43DAvFioGr0yzx4,2732
-maidr/core/plot/mplfinance_barplot.py,sha256=zhTp2i6BH0xn7vQvGTotKgu2HbzlKT4p6zA5CVUUHHc,5673
-maidr/core/plot/mplfinance_lineplot.py,sha256=pIbsusnQg1_GrstVVHfMw-t9yipWJowa9ZvGsiVV6l8,7329
+maidr/core/plot/mplfinance_barplot.py,sha256=WSr5OPK05SEDK1VCjMeCb2vNWJgMcz2c8TTbTZqow7U,5944
+maidr/core/plot/mplfinance_lineplot.py,sha256=bE6NHuUYzym_yG7WvjMTIDKOiiqSe67KvCtYHjLhPJ8,7600
 maidr/core/plot/regplot.py,sha256=b7u6bGTz1IxKahplNUrfwIr_OGSwMJ2BuLgFAVjL0s0,2744
 maidr/core/plot/scatterplot.py,sha256=o0i0uS-wXK9ZrENxneoHbh3-u-2goRONp19Yu9QLsaY,1257
 maidr/exception/__init__.py,sha256=PzaXoYBhyZxMDcJkuxJugDx7jZeseI0El6LpxIwXyG4,46
@@ -40,19 +40,21 @@ maidr/patch/mplfinance.py,sha256=ySD32onanoMgdQkV6XlSAbVd_BQuLWuEQtpkYSEDSzA,949
 maidr/patch/regplot.py,sha256=k86ekd0E4XJ_L1u85zObuDnxuXlM83z7tKtyXRTj2rI,3240
 maidr/patch/scatterplot.py,sha256=kln6zZwjVsdQzICalo-RnBOJrx1BnIB2xYUwItHvSNY,525
 maidr/util/__init__.py,sha256=eRJZfRpDX-n7UoV3JXw_9Lbfu_qNl_D0W1UTvLL-Iv4,81
-maidr/util/datetime_conversion.py,sha256=AQ8qShbEkLVo13TUkOOmtOLnOvaI05Vh5oWhgchvXSA,14478
+maidr/util/datetime_conversion.py,sha256=7L8gYw3Fb7oL1swiMRpXgFO06U473vbnJ81Bexnyb2o,14043
 maidr/util/dedup_utils.py,sha256=RpgPL5p-3oULUHaTCZJaQKhPHfyPkvBLHMt8lAGpJ5A,438
 maidr/util/environment.py,sha256=C4VMyB16mqzrFxpJdxFdm40M0IZojxh60UX80680jgo,9403
-maidr/util/mplfinance_utils.py,sha256=OZe5Y7gzjdjve9DViioQvGZYTdZvz8obvN3oHElQFZw,14418
+maidr/util/format_config.py,sha256=mU4BEZJ05FFYTk8mbDQrjADLn486Blb7_eKZQZORvYA,23438
+maidr/util/mplfinance_utils.py,sha256=00YEjrCUbigZZL1j9jzOTamNnwfy5ZZmXJj65AhgNbw,3662
 maidr/util/plot_detection.py,sha256=bgLHoDcHSRwOiyKzUK3EqGwdAIhF44ocHW5ox6xYGZw,3883
 maidr/util/regression_line_utils.py,sha256=yFKr-H0whT_su2YVZwNksBLp5EC5s77sr6HUFgNcsyY,2329
 maidr/util/svg_utils.py,sha256=2gyzBtNKFHs0utrw1iOlxTmznzivOWQMV2aW8zu2c8E,1442
-maidr/util/mixin/__init__.py,sha256=aGJZNhtWh77yIVPc7ipIZm1OajigjMtCWYKPuDWTC-c,217
+maidr/util/mixin/__init__.py,sha256=f_70pOT9tAUm8KXjoU2TJcTNXCTlDBsfPsDuxV101j4,492
 maidr/util/mixin/extractor_mixin.py,sha256=j2Rv2vh_gqqcxLV1ka3xsPaPAfWsX94CtKIW2FgPLnI,6937
+maidr/util/mixin/format_extractor_mixin.py,sha256=jBmZ8JflDOC3Co-tKC2yka0viZawyI-zKNZijQPU8_Y,2726
 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.9.0.dist-info/METADATA,sha256=EK0mJx_hRNjiVvAnGcph7sBceEbiQrgvioGFPcw8-EY,3154
-maidr-1.9.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-maidr-1.9.0.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-maidr-1.9.0.dist-info/RECORD,,
+maidr-1.11.0.dist-info/METADATA,sha256=kriH4WLxxakBNSpLxHNk_nvPdqMXbw4JuK8aejvP9-4,3155
+maidr-1.11.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+maidr-1.11.0.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+maidr-1.11.0.dist-info/RECORD,,

{maidr-1.9.0.dist-info → maidr-1.11.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any