scitex 2.3.0__py3-none-any.whl → 2.4.1__py3-none-any.whl

scitex/vis/editor/_edit.py

@@ -0,0 +1,342 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# File: ./src/scitex/vis/editor/_edit.py
+"""Main edit function for launching visual editor."""
+
+from pathlib import Path
+from typing import Union, Optional, Literal
+import hashlib
+import json
+
+
+def edit(
+    path: Union[str, Path],
+    backend: Literal["auto", "web", "dearpygui", "qt", "tkinter", "mpl"] = "auto",
+    apply_manual: bool = True,
+) -> None:
+    """
+    Launch interactive editor for figure style/annotation editing.
+
+    Parameters
+    ----------
+    path : str or Path
+        Path to figure file. Can be:
+        - JSON file (figure.json or figure.manual.json)
+        - CSV file (figure.csv) - for data-only start
+        - PNG file (figure.png)
+        Will auto-detect sibling files in same directory or organized subdirectories.
+    backend : str, optional
+        GUI backend to use (default: "auto"):
+        - "auto": Pick best available with graceful degradation
+          (web -> dearpygui -> qt -> tkinter -> mpl)
+        - "web": Browser-based editor (Flask/FastAPI, modern UI)
+        - "dearpygui": GPU-accelerated modern GUI (fast, requires dearpygui)
+        - "qt": Rich desktop editor (requires PyQt5/6 or PySide2/6)
+        - "tkinter": Built-in Python GUI (works everywhere)
+        - "mpl": Minimal matplotlib interactive mode (always works)
+    apply_manual : bool, optional
+        If True, load .manual.json overrides if exists (default: True)
+
+    Returns
+    -------
+    None
+        Editor runs in GUI event loop. Changes saved to .manual.json.
+
+    Examples
+    --------
+    >>> import scitex as stx
+    >>> stx.vis.edit("output/figure.json")  # Auto-select best backend
+    >>> stx.vis.edit("output/figure.png", backend="web")  # Force web editor
+    >>> stx.vis.edit("output/figure.json", backend="tkinter")  # Force tkinter
+
+    Notes
+    -----
+    - Changes are saved to `{basename}.manual.json` alongside the original
+    - Manual JSON includes hash of base JSON for staleness detection
+    - Original JSON/CSV files are never modified
+    - Backend auto-detection order: web > dearpygui > qt > tkinter > mpl
+    """
+    path = Path(path)
+
+    # Resolve paths (JSON, CSV, PNG)
+    json_path, csv_path, png_path = _resolve_figure_paths(path)
+
+    if not json_path.exists():
+        raise FileNotFoundError(f"JSON file not found: {json_path}")
+
+    # Load data
+    import scitex as stx
+    metadata = stx.io.load(json_path)
+    csv_data = None
+    if csv_path and csv_path.exists():
+        csv_data = stx.io.load(csv_path)
+
+    # Load manual overrides if exists
+    manual_path = json_path.with_suffix('.manual.json')
+    manual_overrides = None
+    if apply_manual and manual_path.exists():
+        manual_data = stx.io.load(manual_path)
+        manual_overrides = manual_data.get('overrides', {})
+
+    # Resolve backend if "auto"
+    if backend == "auto":
+        backend = _detect_best_backend()
+
+    # Launch appropriate backend
+    if backend == "web":
+        try:
+            from ._web_editor import WebEditor
+            editor = WebEditor(
+                json_path=json_path,
+                metadata=metadata,
+                csv_data=csv_data,
+                png_path=png_path,
+                manual_overrides=manual_overrides,
+            )
+            editor.run()
+        except ImportError as e:
+            raise ImportError(
+                "Web backend requires Flask or FastAPI. "
+                "Install with: pip install flask"
+            ) from e
+    elif backend == "dearpygui":
+        try:
+            from ._dearpygui_editor import DearPyGuiEditor
+            editor = DearPyGuiEditor(
+                json_path=json_path,
+                metadata=metadata,
+                csv_data=csv_data,
+                manual_overrides=manual_overrides,
+            )
+            editor.run()
+        except ImportError as e:
+            raise ImportError(
+                "DearPyGui backend requires dearpygui. "
+                "Install with: pip install dearpygui"
+            ) from e
+    elif backend == "qt":
+        try:
+            from ._qt_editor import QtEditor
+            editor = QtEditor(
+                json_path=json_path,
+                metadata=metadata,
+                csv_data=csv_data,
+                manual_overrides=manual_overrides,
+            )
+            editor.run()
+        except ImportError as e:
+            raise ImportError(
+                "Qt backend requires PyQt5/PyQt6 or PySide2/PySide6. "
+                "Install with: pip install PyQt6"
+            ) from e
+    elif backend == "tkinter":
+        from ._tkinter_editor import TkinterEditor
+        editor = TkinterEditor(
+            json_path=json_path,
+            metadata=metadata,
+            csv_data=csv_data,
+            manual_overrides=manual_overrides,
+        )
+        editor.run()
+    elif backend == "mpl":
+        from ._mpl_editor import MplEditor
+        editor = MplEditor(
+            json_path=json_path,
+            metadata=metadata,
+            csv_data=csv_data,
+            manual_overrides=manual_overrides,
+        )
+        editor.run()
+    else:
+        raise ValueError(
+            f"Unknown backend: {backend}. "
+            "Use 'auto', 'web', 'dearpygui', 'qt', 'tkinter', or 'mpl'."
+        )
+
+
+def _detect_best_backend() -> str:
+    """
+    Detect the best available GUI backend with graceful degradation.
+
+    Order: web > dearpygui > qt > tkinter > mpl
+    Shows warnings when falling back to less capable backends.
+    """
+    import warnings
+
+    # Try Web (Flask/FastAPI) - best for modern UI
+    try:
+        import flask
+        return "web"
+    except ImportError:
+        pass
+    try:
+        import fastapi
+        return "web"
+    except ImportError:
+        pass
+
+    # Try DearPyGui - GPU-accelerated, modern
+    try:
+        import dearpygui
+        return "dearpygui"
+    except ImportError:
+        warnings.warn(
+            "Web/Flask not available. Consider: pip install flask\n"
+            "Trying DearPyGui..."
+        )
+
+    # Try DearPyGui
+    try:
+        import dearpygui
+        return "dearpygui"
+    except ImportError:
+        pass
+
+    # Try Qt (richest desktop features)
+    qt_available = False
+    try:
+        import PyQt6
+        qt_available = True
+    except ImportError:
+        pass
+    if not qt_available:
+        try:
+            import PyQt5
+            qt_available = True
+        except ImportError:
+            pass
+    if not qt_available:
+        try:
+            import PySide6
+            qt_available = True
+        except ImportError:
+            pass
+    if not qt_available:
+        try:
+            import PySide2
+            qt_available = True
+        except ImportError:
+            pass
+
+    if qt_available:
+        warnings.warn(
+            "DearPyGui not available. Consider: pip install dearpygui\n"
+            "Using Qt backend instead."
+        )
+        return "qt"
+
+    # Try Tkinter (built-in, good features)
+    try:
+        import tkinter
+        warnings.warn(
+            "Qt not available. Consider: pip install PyQt6\n"
+            "Using Tkinter backend (basic features)."
+        )
+        return "tkinter"
+    except ImportError:
+        pass
+
+    # Fall back to matplotlib interactive (always works)
+    warnings.warn(
+        "No GUI toolkit found. Using minimal matplotlib editor.\n"
+        "For better experience, install: pip install flask (web) or pip install PyQt6 (desktop)"
+    )
+    return "mpl"
+
+
+def _resolve_figure_paths(path: Path) -> tuple:
+    """
+    Resolve JSON, CSV, and PNG paths from any input file path.
+
+    Handles two patterns:
+    1. Flat (sibling): path/to/figure.{json,csv,png}
+    2. Organized (subdirs): path/to/{json,csv,png}/figure.{ext}
+
+    Parameters
+    ----------
+    path : Path
+        Input path (can be JSON, CSV, or PNG)
+
+    Returns
+    -------
+    tuple
+        (json_path, csv_path, png_path) - csv_path/png_path may be None if not found
+    """
+    path = Path(path)
+    stem = path.stem
+    parent = path.parent
+
+    # Check if this is organized pattern (parent is json/, csv/, png/)
+    if parent.name in ('json', 'csv', 'png'):
+        base_dir = parent.parent
+        json_path = base_dir / 'json' / f'{stem}.json'
+        csv_path = base_dir / 'csv' / f'{stem}.csv'
+        png_path = base_dir / 'png' / f'{stem}.png'
+    else:
+        # Flat pattern - sibling files
+        json_path = parent / f'{stem}.json'
+        csv_path = parent / f'{stem}.csv'
+        png_path = parent / f'{stem}.png'
+
+    # If input was .manual.json, get base json
+    if stem.endswith('.manual'):
+        base_stem = stem[:-7]  # Remove '.manual'
+        if parent.name == 'json':
+            json_path = parent / f'{base_stem}.json'
+            csv_path = parent.parent / 'csv' / f'{base_stem}.csv'
+            png_path = parent.parent / 'png' / f'{base_stem}.png'
+        else:
+            json_path = parent / f'{base_stem}.json'
+            csv_path = parent / f'{base_stem}.csv'
+            png_path = parent / f'{base_stem}.png'
+
+    return (
+        json_path,
+        csv_path if csv_path.exists() else None,
+        png_path if png_path.exists() else None,
+    )
+
+
+def _compute_file_hash(path: Path) -> str:
+    """Compute SHA256 hash of file contents."""
+    with open(path, 'rb') as f:
+        return hashlib.sha256(f.read()).hexdigest()
+
+
+def save_manual_overrides(
+    json_path: Path,
+    overrides: dict,
+) -> Path:
+    """
+    Save manual overrides to .manual.json file.
+
+    Parameters
+    ----------
+    json_path : Path
+        Path to base JSON file
+    overrides : dict
+        Override settings (styles, annotations, etc.)
+
+    Returns
+    -------
+    Path
+        Path to saved manual.json file
+    """
+    import scitex as stx
+
+    manual_path = json_path.with_suffix('.manual.json')
+
+    # Compute hash of base JSON for staleness detection
+    base_hash = _compute_file_hash(json_path)
+
+    manual_data = {
+        'base_file': json_path.name,
+        'base_hash': base_hash,
+        'overrides': overrides,
+    }
+
+    stx.io.save(manual_data, manual_path)
+    return manual_path
+
+
+# EOF

scitex/vis/editor/_mpl_editor.py

@@ -0,0 +1,231 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# File: ./src/scitex/vis/editor/_mpl_editor.py
+"""Minimal matplotlib-based figure editor."""
+
+from pathlib import Path
+from typing import Dict, Any, Optional
+import copy
+
+
+class MplEditor:
+    """
+    Minimal interactive figure editor using matplotlib's built-in interactivity.
+
+    Features:
+    - Basic figure display with navigation toolbar
+    - Text-based property editing via console
+    - Save to .manual.json
+    """
+
+    def __init__(
+        self,
+        json_path: Path,
+        metadata: Dict[str, Any],
+        csv_data: Optional[Any] = None,
+        manual_overrides: Optional[Dict[str, Any]] = None,
+    ):
+        self.json_path = Path(json_path)
+        self.metadata = metadata
+        self.csv_data = csv_data
+        self.manual_overrides = manual_overrides or {}
+        self.current_overrides = copy.deepcopy(self.manual_overrides)
+
+    def run(self):
+        """Launch the matplotlib editor."""
+        import matplotlib
+        matplotlib.use('TkAgg')  # Use interactive backend
+        import matplotlib.pyplot as plt
+        from matplotlib.widgets import Button, TextBox
+
+        # Create figure with extra space for controls
+        self.fig = plt.figure(figsize=(12, 8))
+
+        # Main axes for plot
+        self.ax = self.fig.add_axes([0.1, 0.25, 0.85, 0.65])
+
+        # Initial render
+        self._render()
+
+        # Add control buttons
+        self._add_controls()
+
+        # Show instructions
+        print("\n" + "="*50)
+        print("SciTeX Matplotlib Editor")
+        print("="*50)
+        print(f"Editing: {self.json_path.name}")
+        print("\nControls:")
+        print("  - Use navigation toolbar for zoom/pan")
+        print("  - Click buttons below figure for actions")
+        print("  - Close window when done")
+        print("="*50 + "\n")
+
+        plt.show()
+
+    def _render(self):
+        """Render the figure."""
+        self.ax.clear()
+
+        # Plot from CSV data
+        if self.csv_data is not None:
+            self._plot_from_csv()
+        else:
+            self.ax.text(0.5, 0.5, "No plot data available\n(CSV not found)",
+                        ha='center', va='center', transform=self.ax.transAxes)
+
+        # Apply overrides
+        if self.current_overrides.get('title'):
+            self.ax.set_title(self.current_overrides['title'])
+        if self.current_overrides.get('xlabel'):
+            self.ax.set_xlabel(self.current_overrides['xlabel'])
+        if self.current_overrides.get('ylabel'):
+            self.ax.set_ylabel(self.current_overrides['ylabel'])
+        if self.current_overrides.get('grid'):
+            self.ax.grid(True)
+        if self.current_overrides.get('xlim'):
+            self.ax.set_xlim(self.current_overrides['xlim'])
+        if self.current_overrides.get('ylim'):
+            self.ax.set_ylim(self.current_overrides['ylim'])
+        if self.current_overrides.get('facecolor'):
+            self.ax.set_facecolor(self.current_overrides['facecolor'])
+
+        # Apply annotations
+        for annot in self.current_overrides.get('annotations', []):
+            if annot.get('type') == 'text':
+                self.ax.text(
+                    annot.get('x', 0.5),
+                    annot.get('y', 0.5),
+                    annot.get('text', ''),
+                    transform=self.ax.transAxes,
+                    fontsize=annot.get('fontsize', 10),
+                )
+
+        self.fig.canvas.draw()
+
+    def _plot_from_csv(self):
+        """Reconstruct plot from CSV data."""
+        import pandas as pd
+
+        if isinstance(self.csv_data, pd.DataFrame):
+            df = self.csv_data
+        else:
+            return
+
+        cols = df.columns.tolist()
+        if len(cols) >= 2:
+            x_col = cols[0]
+            for y_col in cols[1:]:
+                try:
+                    self.ax.plot(df[x_col], df[y_col], label=str(y_col))
+                except Exception:
+                    pass
+            if len(cols) > 2:
+                self.ax.legend()
+        elif len(cols) == 1:
+            self.ax.plot(df[cols[0]])
+
+    def _add_controls(self):
+        """Add control buttons."""
+        from matplotlib.widgets import Button, TextBox
+
+        # Title text box
+        ax_title = self.fig.add_axes([0.15, 0.12, 0.3, 0.04])
+        self.title_box = TextBox(ax_title, 'Title:', initial=self.current_overrides.get('title', ''))
+        self.title_box.on_submit(self._on_title_change)
+
+        # Grid toggle button
+        ax_grid = self.fig.add_axes([0.55, 0.12, 0.1, 0.04])
+        self.grid_btn = Button(ax_grid, 'Toggle Grid')
+        self.grid_btn.on_clicked(self._toggle_grid)
+
+        # Save button
+        ax_save = self.fig.add_axes([0.7, 0.12, 0.1, 0.04])
+        self.save_btn = Button(ax_save, 'Save')
+        self.save_btn.on_clicked(self._save)
+
+        # Edit labels button
+        ax_labels = self.fig.add_axes([0.15, 0.05, 0.15, 0.04])
+        self.labels_btn = Button(ax_labels, 'Edit Labels')
+        self.labels_btn.on_clicked(self._edit_labels)
+
+        # Add annotation button
+        ax_annot = self.fig.add_axes([0.35, 0.05, 0.15, 0.04])
+        self.annot_btn = Button(ax_annot, 'Add Text')
+        self.annot_btn.on_clicked(self._add_annotation)
+
+        # Export PNG button
+        ax_export = self.fig.add_axes([0.55, 0.05, 0.12, 0.04])
+        self.export_btn = Button(ax_export, 'Export PNG')
+        self.export_btn.on_clicked(self._export_png)
+
+    def _on_title_change(self, text):
+        """Handle title change."""
+        self.current_overrides['title'] = text
+        self._render()
+
+    def _toggle_grid(self, event):
+        """Toggle grid visibility."""
+        self.current_overrides['grid'] = not self.current_overrides.get('grid', False)
+        self._render()
+
+    def _edit_labels(self, event):
+        """Edit axis labels via console."""
+        print("\n--- Edit Labels ---")
+        xlabel = input(f"X Label [{self.current_overrides.get('xlabel', '')}]: ").strip()
+        if xlabel:
+            self.current_overrides['xlabel'] = xlabel
+
+        ylabel = input(f"Y Label [{self.current_overrides.get('ylabel', '')}]: ").strip()
+        if ylabel:
+            self.current_overrides['ylabel'] = ylabel
+
+        self._render()
+        print("Labels updated!")
+
+    def _add_annotation(self, event):
+        """Add text annotation via console."""
+        print("\n--- Add Text Annotation ---")
+        text = input("Text: ").strip()
+        if not text:
+            return
+
+        try:
+            x = float(input("X position (0-1) [0.5]: ").strip() or "0.5")
+            y = float(input("Y position (0-1) [0.5]: ").strip() or "0.5")
+        except ValueError:
+            print("Invalid position, using defaults")
+            x, y = 0.5, 0.5
+
+        if 'annotations' not in self.current_overrides:
+            self.current_overrides['annotations'] = []
+
+        self.current_overrides['annotations'].append({
+            'type': 'text',
+            'text': text,
+            'x': x,
+            'y': y,
+            'fontsize': 10,
+        })
+
+        self._render()
+        print("Annotation added!")
+
+    def _save(self, event):
+        """Save to .manual.json."""
+        from ._edit import save_manual_overrides
+
+        try:
+            manual_path = save_manual_overrides(self.json_path, self.current_overrides)
+            print(f"\nSaved: {manual_path}")
+        except Exception as e:
+            print(f"\nError saving: {e}")
+
+    def _export_png(self, event):
+        """Export current view to PNG."""
+        output_path = self.json_path.with_suffix('.edited.png')
+        self.fig.savefig(output_path, dpi=300, bbox_inches='tight')
+        print(f"\nExported: {output_path}")
+
+
+# EOF