scitex 2.8.1__py3-none-any.whl → 2.10.0__py3-none-any.whl

scitex/bridge/__init__.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # File: ./src/scitex/bridge/__init__.py
 # Time-stamp: "2024-12-09 09:30:00 (ywatanabe)"
 """
@@ -45,40 +44,47 @@ Usage:
 """
 
 # Stats ↔ Plt bridges
-from scitex.bridge._stats_plt import (
-    add_stat_to_axes,
-    extract_stats_from_axes,
-    format_stat_for_plot,
+# FigRecipe integration (optional)
+from scitex.bridge._figrecipe import (
+    FIGRECIPE_AVAILABLE,
+    has_figrecipe,
+    load_recipe,
+    save_with_recipe,
 )
 
-# Stats ↔ Vis bridges
-from scitex.bridge._stats_vis import (
-    stat_result_to_annotation,
-    add_stats_to_figure_model,
-    position_stat_annotation,
+# High-level helpers
+from scitex.bridge._helpers import (
+    add_stats_from_results,
 )
 
 # Plt ↔ Vis bridges
 from scitex.bridge._plt_vis import (
-    figure_to_vis_model,
     axes_to_vis_axes,
-    tracking_to_plot_configs,
     collect_figure_data,
-)
-
-# High-level helpers
-from scitex.bridge._helpers import (
-    add_stats_from_results,
+    figure_to_vis_model,
+    tracking_to_plot_configs,
 )
 
 # Protocol versioning
 from scitex.bridge._protocol import (
     BRIDGE_PROTOCOL_VERSION,
+    COORDINATE_SYSTEMS,
     ProtocolInfo,
-    check_protocol_compatibility,
     add_protocol_metadata,
+    check_protocol_compatibility,
     extract_protocol_metadata,
-    COORDINATE_SYSTEMS,
+)
+from scitex.bridge._stats_plt import (
+    add_stat_to_axes,
+    extract_stats_from_axes,
+    format_stat_for_plot,
+)
+
+# Stats ↔ Vis bridges
+from scitex.bridge._stats_vis import (
+    add_stats_to_figure_model,
+    position_stat_annotation,
+    stat_result_to_annotation,
 )
 
 __all__ = [
@@ -104,6 +110,11 @@ __all__ = [
     "collect_figure_data",
     # High-level helpers
     "add_stats_from_results",
+    # FigRecipe integration
+    "save_with_recipe",
+    "load_recipe",
+    "has_figrecipe",
+    "FIGRECIPE_AVAILABLE",
 ]
 
 

scitex/bridge/_figrecipe.py

@@ -0,0 +1,245 @@
+#!/usr/bin/env python3
+"""Bridge adapter for figrecipe integration.
+
+This module provides functions to save figures with both:
+- SigmaPlot-compatible CSV (scitex format)
+- figrecipe YAML recipe (reproducible figures)
+
+The FTS bundle structure:
+    figure/
+    ├── recipe.yaml     # Source of truth (figrecipe format)
+    ├── recipe_data/    # Large arrays (if needed)
+    ├── plot.csv        # SigmaPlot combined CSV (derived)
+    ├── plot.png        # Primary image (derived)
+    └── meta.yaml       # FTS metadata (optional)
+"""
+
+from pathlib import Path
+from typing import Any, Dict, Optional, Union
+
+# Check figrecipe availability
+try:
+    import figrecipe as fr
+    from figrecipe._serializer import save_recipe as _fr_save_recipe
+
+    FIGRECIPE_AVAILABLE = True
+except ImportError:
+    FIGRECIPE_AVAILABLE = False
+
+
+def save_with_recipe(
+    fig,
+    path: Union[str, Path],
+    include_csv: bool = True,
+    include_recipe: bool = True,
+    data_format: str = "csv",
+    dpi: int = 300,
+    **kwargs,
+) -> Dict[str, Path]:
+    """Save figure with both CSV and figrecipe recipe.
+
+    Parameters
+    ----------
+    fig : FigWrapper or matplotlib Figure
+        The figure to save.
+    path : str or Path
+        Output path. Can be:
+        - Directory path (creates bundle)
+        - File path with .zip extension (creates zip bundle)
+        - File path with image extension (saves image + sidecar files)
+    include_csv : bool
+        If True, save SigmaPlot-compatible CSV.
+    include_recipe : bool
+        If True, save figrecipe YAML recipe (requires figrecipe).
+    data_format : str
+        Format for recipe data: 'csv', 'npz', or 'inline'.
+    dpi : int
+        Resolution for image output.
+    **kwargs
+        Additional arguments passed to savefig.
+
+    Returns
+    -------
+    dict
+        Paths to saved files: {'image': Path, 'csv': Path, 'recipe': Path}
+    """
+    from scitex.fts._bundle._storage import get_storage
+
+    path = Path(path)
+    result = {}
+
+    # Determine if this is a bundle (directory or zip)
+    is_bundle = path.suffix == ".zip" or path.suffix == "" or path.is_dir()
+
+    if is_bundle:
+        # Create bundle storage
+        storage = get_storage(path)
+        storage.ensure_exists()
+
+        # Get underlying matplotlib figure
+        mpl_fig = fig._fig_mpl if hasattr(fig, "_fig_mpl") else fig
+
+        # 1. Save image
+        image_path = storage.path / "plot.png"
+        mpl_fig.savefig(image_path, dpi=dpi, **kwargs)
+        result["image"] = image_path
+
+        # 2. Save SigmaPlot CSV
+        if include_csv and hasattr(fig, "export_as_csv"):
+            try:
+                csv_df = fig.export_as_csv()
+                if not csv_df.empty:
+                    csv_path = storage.path / "plot.csv"
+                    csv_df.to_csv(csv_path, index=False)
+                    result["csv"] = csv_path
+            except Exception:
+                pass  # CSV export is optional
+
+        # 3. Save figrecipe recipe
+        if include_recipe:
+            recipe_path = _save_recipe_to_path(
+                fig, storage.path / "recipe.yaml", data_format
+            )
+            if recipe_path:
+                result["recipe"] = recipe_path
+
+    else:
+        # Single file save (image + sidecars)
+        mpl_fig = fig._fig_mpl if hasattr(fig, "_fig_mpl") else fig
+        mpl_fig.savefig(path, dpi=dpi, **kwargs)
+        result["image"] = path
+
+        # Save CSV sidecar
+        if include_csv and hasattr(fig, "export_as_csv"):
+            try:
+                csv_df = fig.export_as_csv()
+                if not csv_df.empty:
+                    csv_path = path.with_suffix(".csv")
+                    csv_df.to_csv(csv_path, index=False)
+                    result["csv"] = csv_path
+            except Exception:
+                pass
+
+        # Save recipe sidecar
+        if include_recipe:
+            recipe_path = _save_recipe_to_path(
+                fig, path.with_suffix(".yaml"), data_format
+            )
+            if recipe_path:
+                result["recipe"] = recipe_path
+
+    return result
+
+
+def _save_recipe_to_path(
+    fig,
+    path: Path,
+    data_format: str = "csv",
+) -> Optional[Path]:
+    """Save figrecipe recipe if available.
+
+    Parameters
+    ----------
+    fig : FigWrapper
+        Figure with optional _figrecipe_recorder attribute.
+    path : Path
+        Output path for recipe.yaml.
+    data_format : str
+        Format for data: 'csv', 'npz', or 'inline'.
+
+    Returns
+    -------
+    Path or None
+        Path to saved recipe, or None if not available.
+    """
+    if not FIGRECIPE_AVAILABLE:
+        return None
+
+    try:
+        # Check if figure has figrecipe recorder
+        if hasattr(fig, "_figrecipe_recorder") and fig._figrecipe_enabled:
+            recorder = fig._figrecipe_recorder
+            figure_record = recorder.figure_record
+
+            # Capture current figure state into record
+            _capture_figure_state(fig, figure_record)
+
+            # Save using figrecipe's serializer
+            _fr_save_recipe(
+                figure_record, path, include_data=True, data_format=data_format
+            )
+            return path
+
+        # Alternative: if figure was created with fr.subplots() directly
+        if hasattr(fig, "save_recipe"):
+            fig.save_recipe(path, include_data=True, data_format=data_format)
+            return path
+
+    except Exception:
+        pass  # Recipe saving is optional
+
+    return None
+
+
+def _capture_figure_state(fig, figure_record):
+    """Capture current figure state into the record.
+
+    This syncs the matplotlib figure state with the figrecipe record,
+    ensuring the recipe reflects the final figure appearance.
+    """
+    try:
+        mpl_fig = fig._fig_mpl if hasattr(fig, "_fig_mpl") else fig
+
+        # Update figure dimensions
+        figsize = mpl_fig.get_size_inches()
+        figure_record.figsize = list(figsize)
+        figure_record.dpi = int(mpl_fig.dpi)
+
+        # Capture style from scitex metadata if available
+        if hasattr(mpl_fig, "_scitex_theme"):
+            if not hasattr(figure_record, "style") or figure_record.style is None:
+                figure_record.style = {}
+            figure_record.style["theme"] = mpl_fig._scitex_theme
+
+    except Exception:
+        pass  # Non-critical
+
+
+def load_recipe(
+    path: Union[str, Path],
+) -> Any:
+    """Load figrecipe recipe from FTS bundle.
+
+    Parameters
+    ----------
+    path : str or Path
+        Path to bundle directory, zip file, or recipe.yaml.
+
+    Returns
+    -------
+    tuple
+        (fig, axes) reproduced from recipe.
+    """
+    if not FIGRECIPE_AVAILABLE:
+        raise ImportError("figrecipe is required for loading recipes")
+
+    path = Path(path)
+
+    # Handle bundle paths
+    if path.is_dir():
+        recipe_path = path / "recipe.yaml"
+    elif path.suffix == ".zip":
+        # figrecipe can handle zip files directly
+        recipe_path = path
+    else:
+        recipe_path = path
+
+    return fr.reproduce(recipe_path)
+
+
+def has_figrecipe() -> bool:
+    """Check if figrecipe is available."""
+    return FIGRECIPE_AVAILABLE
+
+
+# EOF

scitex/bridge/_helpers.py

@@ -11,7 +11,8 @@ multiple modules, abstracting away backend-specific details.
 
 from typing import Union, List, Optional, Literal
 
-from scitex.schema import StatResult
+# StatResult is now a dict - the GUI-specific StatResult is deprecated
+StatResult = dict
 
 
 def add_stats_from_results(

scitex/bridge/_plt_vis.py

@@ -14,16 +14,29 @@ Provides adapters to:
 from typing import Optional, Dict, Any, List, Tuple, Union
 import warnings
 
-from scitex.fig.model import (
-    FigureModel,
-    AxesModel,
-    PlotModel,
-    AnnotationModel,
-    GuideModel,
-    PlotStyle,
-    AxesStyle,
-    TextStyle,
-)
+# Legacy model imports - may not be available (deleted module)
+try:
+    from scitex.fig.model import (
+        FigureModel,
+        AxesModel,
+        PlotModel,
+        AnnotationModel,
+        GuideModel,
+        PlotStyle,
+        AxesStyle,
+        TextStyle,
+    )
+    VIS_MODEL_AVAILABLE = True
+except ImportError:
+    FigureModel = None
+    AxesModel = None
+    PlotModel = None
+    AnnotationModel = None
+    GuideModel = None
+    PlotStyle = None
+    AxesStyle = None
+    TextStyle = None
+    VIS_MODEL_AVAILABLE = False
 
 
 def figure_to_vis_model(

scitex/bridge/_stats_plt.py

@@ -28,7 +28,11 @@ the caller intends (typically data coordinates unless transform is set).
 from typing import Optional, Dict, Any, Union, List
 import warnings
 
-from scitex.schema import StatResult, Position
+# Import GUI classes from FTS (single source of truth)
+from scitex.fts._stats import Position
+
+# StatResult is now a dict - the GUI-specific StatResult is deprecated
+StatResult = dict
 
 
 def format_stat_for_plot(
@@ -205,10 +209,19 @@ def _parse_stat_annotation(text: str) -> Optional[StatResult]:
     Optional[StatResult]
         Parsed StatResult or None if not parseable
     """
-    from scitex.schema import create_stat_result
-
     text = text.strip()
 
+    def _create_stat_dict(test_type, statistic_name, statistic_value, p_value):
+        """Create a simple stat result dict."""
+        from scitex.stats.utils import p2stars
+        return {
+            "test_type": test_type,
+            "test_category": "other",
+            "statistic": {"name": statistic_name, "value": statistic_value},
+            "p_value": p_value,
+            "stars": p2stars(p_value, ns_symbol=False),
+        }
+
     # Try to detect asterisks pattern
     if text in ["*", "**", "***", "ns", "n.s."]:
         stars = text.replace("n.s.", "ns")
@@ -219,7 +232,7 @@ def _parse_stat_annotation(text: str) -> Optional[StatResult]:
             "*": 0.03,
             "ns": 0.5,
         }.get(stars, 0.5)
-        return create_stat_result(
+        return _create_stat_dict(
             test_type="unknown",
             statistic_name="stat",
             statistic_value=0.0,
@@ -241,7 +254,7 @@ def _parse_stat_annotation(text: str) -> Optional[StatResult]:
             "*": 0.03,
             "ns": 0.5,
         }.get(stars, 0.5)
-        return create_stat_result(
+        return _create_stat_dict(
             test_type="unknown",
             statistic_name=stat_name,
             statistic_value=stat_value,

scitex/bridge/_stats_vis.py

@@ -26,8 +26,22 @@ When bridging between plt and vis, coordinate transformation may be needed.
 
 from typing import Optional, Dict, Any, List, Tuple
 
-from scitex.schema import StatResult, Position, StatPositioning
-from scitex.fig.model import AnnotationModel, FigureModel, AxesModel, TextStyle
+# Import GUI classes from FTS (single source of truth)
+from scitex.fts._stats import Position, StatPositioning
+
+# Legacy model imports - may not be available
+try:
+    from scitex.fig.model import AnnotationModel, FigureModel, AxesModel, TextStyle
+    VIS_MODEL_AVAILABLE = True
+except ImportError:
+    AnnotationModel = None
+    FigureModel = None
+    AxesModel = None
+    TextStyle = None
+    VIS_MODEL_AVAILABLE = False
+
+# StatResult placeholder for type hints (actual usage is through dict)
+StatResult = dict  # Use dict as StatResult is deprecated
 
 
 def stat_result_to_annotation(

scitex/browser/__init__.py

@@ -1,56 +1,96 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # SciTeX Browser Utilities - Universal Playwright helpers organized by category
 # ----------------------------------------
 
+# All browser utilities require playwright - make them optional
+
 # Debugging utilities
-from .debugging import (
-    browser_logger,
-    show_grid_async,
-    highlight_element_async,
-    # Visual cursor/feedback utilities (sync and async)
-    inject_visual_effects,
-    inject_visual_effects_async,
-    show_cursor_at,
-    show_cursor_at_async,
-    show_click_effect,
-    show_click_effect_async,
-    show_step,
-    show_step_async,
-    show_test_result,
-    show_test_result_async,
-    # Failure capture utilities (mirrors console-interceptor.ts)
-    setup_console_interceptor,
-    collect_console_logs,
-    collect_console_logs_detailed,
-    format_logs_devtools_style,
-    save_failure_artifacts,
-    create_failure_capture_fixture,
-    # Test monitoring (periodic screenshots via scitex.capture)
-    TestMonitor,
-    create_test_monitor_fixture,
-    monitor_test,
-    # Sync browser session for zombie prevention
-    SyncBrowserSession,
-    sync_browser_session,
-    create_browser_session_fixture,
-)
+try:
+    from .debugging import (
+        # Sync browser session for zombie prevention
+        SyncBrowserSession,
+        # Test monitoring (periodic screenshots via scitex.capture)
+        TestMonitor,
+        browser_logger,
+        collect_console_logs,
+        collect_console_logs_detailed,
+        create_browser_session_fixture,
+        create_failure_capture_fixture,
+        create_test_monitor_fixture,
+        format_logs_devtools_style,
+        highlight_element_async,
+        # Visual cursor/feedback utilities (sync and async)
+        inject_visual_effects,
+        inject_visual_effects_async,
+        monitor_test,
+        save_failure_artifacts,
+        # Failure capture utilities (mirrors console-interceptor.ts)
+        setup_console_interceptor,
+        show_click_effect,
+        show_click_effect_async,
+        show_cursor_at,
+        show_cursor_at_async,
+        show_grid_async,
+        show_step,
+        show_step_async,
+        show_test_result,
+        show_test_result_async,
+        sync_browser_session,
+    )
+except ImportError:
+    browser_logger = None
+    show_grid_async = None
+    highlight_element_async = None
+    inject_visual_effects = None
+    inject_visual_effects_async = None
+    show_cursor_at = None
+    show_cursor_at_async = None
+    show_click_effect = None
+    show_click_effect_async = None
+    show_step = None
+    show_step_async = None
+    show_test_result = None
+    show_test_result_async = None
+    setup_console_interceptor = None
+    collect_console_logs = None
+    collect_console_logs_detailed = None
+    format_logs_devtools_style = None
+    save_failure_artifacts = None
+    create_failure_capture_fixture = None
+    TestMonitor = None
+    create_test_monitor_fixture = None
+    monitor_test = None
+    SyncBrowserSession = None
+    sync_browser_session = None
+    create_browser_session_fixture = None
 
 # PDF utilities
-from .pdf import (
-    detect_chrome_pdf_viewer_async,
-    click_download_for_chrome_pdf_viewer_async,
-)
+try:
+    from .pdf import (
+        click_download_for_chrome_pdf_viewer_async,
+        detect_chrome_pdf_viewer_async,
+    )
+except ImportError:
+    detect_chrome_pdf_viewer_async = None
+    click_download_for_chrome_pdf_viewer_async = None
 
 # Interaction utilities
-from .interaction import (
-    click_center_async,
-    click_with_fallbacks_async,
-    fill_with_fallbacks_async,
-    PopupHandler,
-    close_popups_async,
-    ensure_no_popups_async,
-)
+try:
+    from .interaction import (
+        PopupHandler,
+        click_center_async,
+        click_with_fallbacks_async,
+        close_popups_async,
+        ensure_no_popups_async,
+        fill_with_fallbacks_async,
+    )
+except ImportError:
+    click_center_async = None
+    click_with_fallbacks_async = None
+    fill_with_fallbacks_async = None
+    PopupHandler = None
+    close_popups_async = None
+    ensure_no_popups_async = None
 
 __all__ = [
     # Debugging

scitex/browser/automation/__init__.py

@@ -1,6 +1,10 @@
 """Browser automation utilities."""
 
-from .CookieHandler import CookieAutoAcceptor
+# Optional: CookieAutoAcceptor requires playwright
+try:
+    from .CookieHandler import CookieAutoAcceptor
+except ImportError:
+    CookieAutoAcceptor = None
 
 __all__ = [
     "CookieAutoAcceptor",

scitex/browser/core/BrowserMixin.py

@@ -1,19 +1,31 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # Timestamp: "2025-08-07 20:04:42 (ywatanabe)"
 # File: /home/ywatanabe/proj/scitex_repo/src/scitex/scholar/browser/local/_BrowserMixin.py
 # ----------------------------------------
 from __future__ import annotations
+
 import os
 
 __FILE__ = __file__
 __DIR__ = os.path.dirname(__FILE__)
 # ----------------------------------------
 
-import aiohttp
-from playwright.async_api import Browser, async_playwright
+# Optional dependencies - browser module requires these
+try:
+    import aiohttp
+except ImportError:
+    aiohttp = None
+
+try:
+    from playwright.async_api import Browser, async_playwright
+except ImportError:
+    Browser = None
+    async_playwright = None
 
-from scitex.browser.automation import CookieAutoAcceptor
+try:
+    from scitex.browser.automation import CookieAutoAcceptor
+except ImportError:
+    CookieAutoAcceptor = None
 
 
 class BrowserMixin:
@@ -236,6 +248,7 @@ class BrowserMixin:
 def main(args):
     """Demonstrate BrowserMixin functionality."""
     import asyncio
+
     from scitex.browser.core import BrowserMixin
 
     class DemoBrowser(BrowserMixin):

scitex/browser/core/__init__.py

@@ -1,7 +1,16 @@
 """Core browser management components."""
 
-from .BrowserMixin import BrowserMixin
-from .ChromeProfileManager import ChromeProfileManager
+# Optional: BrowserMixin requires playwright
+try:
+    from .BrowserMixin import BrowserMixin
+except ImportError:
+    BrowserMixin = None
+
+# Optional: ChromeProfileManager may have dependencies
+try:
+    from .ChromeProfileManager import ChromeProfileManager
+except ImportError:
+    ChromeProfileManager = None
 
 __all__ = [
     "BrowserMixin",

scitex/browser/remote/CaptchaHandler.py

@@ -40,7 +40,7 @@ import aiohttp
 import json
 
 from scitex import logging
-from scitex.errors import ScholarError
+from scitex.logging import ScholarError
 
 logger = logging.getLogger(__name__)