py-data-engine 0.1.0__py3-none-any.whl

data_engine/platform/theme.py

@@ -0,0 +1,259 @@
+"""Shared theme tokens and host-theme detection across Data Engine surfaces."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+import os
+import platform
+import subprocess
+
+
+@dataclass(frozen=True)
+class ThemePalette:
+    """One complete application palette."""
+
+    name: str
+    window_bg: str
+    app_bg: str
+    panel_bg: str
+    panel_border: str
+    text: str
+    muted_text: str
+    section_text: str
+    accent_text: str
+    warning_text: str
+    error_text: str
+    button_bg: str
+    button_hover: str
+    button_checked_bg: str
+    button_checked_border: str
+    button_disabled_bg: str
+    button_disabled_border: str
+    button_disabled_text: str
+    input_bg: str
+    input_border: str
+    hover_bg: str
+    hover_border: str
+    selection_bg: str
+    selection_text: str
+    selection_border: str
+    tab_bg: str
+    tab_hover_bg: str
+    tab_selected_bg: str
+    progress_bg: str
+    progress_chunk: str
+    summary_bg: str
+    summary_border: str
+    request_control_bg: str
+    request_control_border: str
+    request_control_hover: str
+    engine_start_bg: str
+    engine_start_border: str
+    engine_start_hover: str
+    engine_stop_bg: str
+    engine_stop_border: str
+    engine_stop_hover: str
+
+
+GITHUB_DARK = ThemePalette(
+    name="dark",
+    window_bg="#0d1117",
+    app_bg="#0d1117",
+    panel_bg="#161b22",
+    panel_border="#30363d",
+    text="#c9d1d9",
+    muted_text="#8b949e",
+    section_text="#7d8590",
+    accent_text="#2ea043",
+    warning_text="#d29922",
+    error_text="#f85149",
+    button_bg="#21262d",
+    button_hover="#30363d",
+    button_checked_bg="#1f6feb",
+    button_checked_border="#388bfd",
+    button_disabled_bg="#161b22",
+    button_disabled_border="#30363d",
+    button_disabled_text="#6e7681",
+    input_bg="#0d1117",
+    input_border="#30363d",
+    hover_bg="#1b2230",
+    hover_border="#3b4556",
+    selection_bg="#1f6feb",
+    selection_text="#f0f6fc",
+    selection_border="#388bfd",
+    tab_bg="#161b22",
+    tab_hover_bg="#1b2230",
+    tab_selected_bg="#21262d",
+    progress_bg="#0d1117",
+    progress_chunk="#2ea043",
+    summary_bg="#21262d",
+    summary_border="#30363d",
+    request_control_bg="#F04A00",
+    request_control_border="#c23c00",
+    request_control_hover="#d84300",
+    engine_start_bg="#1f883d",
+    engine_start_border="#1a7f37",
+    engine_start_hover="#1a7f37",
+    engine_stop_bg="#cf222e",
+    engine_stop_border="#a40e26",
+    engine_stop_hover="#a40e26",
+)
+
+GITHUB_LIGHT = ThemePalette(
+    name="light",
+    window_bg="#ffffff",
+    app_bg="#f6f8fa",
+    panel_bg="#ffffff",
+    panel_border="#d0d7de",
+    text="#1f2328",
+    muted_text="#656d76",
+    section_text="#57606a",
+    accent_text="#1a7f37",
+    warning_text="#9a6700",
+    error_text="#cf222e",
+    button_bg="#f6f8fa",
+    button_hover="#eef2f6",
+    button_checked_bg="#ddf4ff",
+    button_checked_border="#54aeff",
+    button_disabled_bg="#f6f8fa",
+    button_disabled_border="#d8dee4",
+    button_disabled_text="#8c959f",
+    input_bg="#ffffff",
+    input_border="#d0d7de",
+    hover_bg="#f6f8fa",
+    hover_border="#c7d2dd",
+    selection_bg="#0969da",
+    selection_text="#ffffff",
+    selection_border="#54aeff",
+    tab_bg="#f6f8fa",
+    tab_hover_bg="#eef2f6",
+    tab_selected_bg="#ffffff",
+    progress_bg="#eef2f6",
+    progress_chunk="#1a7f37",
+    summary_bg="#f6f8fa",
+    summary_border="#d0d7de",
+    request_control_bg="#F04A00",
+    request_control_border="#c23c00",
+    request_control_hover="#d84300",
+    engine_start_bg="#1f883d",
+    engine_start_border="#1a7f37",
+    engine_start_hover="#1a7f37",
+    engine_stop_bg="#cf222e",
+    engine_stop_border="#a40e26",
+    engine_stop_hover="#a40e26",
+)
+
+THEMES = {
+    "dark": GITHUB_DARK,
+    "light": GITHUB_LIGHT,
+}
+
+DEFAULT_THEME = "system"
+
+
+def toggle_theme_name(theme_name: str) -> str:
+    """Return the opposite theme name."""
+    return "light" if theme_name == "dark" else "dark"
+
+
+def theme_button_text(theme_name: str) -> str:
+    """Return the user-facing label for the theme toggle button."""
+    return "Switch to Light" if theme_name == "dark" else "Switch to Dark"
+
+
+def _qt_theme_name() -> str | None:
+    try:
+        from PySide6.QtCore import Qt  # type: ignore
+        from PySide6.QtGui import QGuiApplication  # type: ignore
+    except Exception:
+        return None
+    app = QGuiApplication.instance()
+    if app is None:
+        return None
+    try:
+        scheme = app.styleHints().colorScheme()
+    except AttributeError:
+        return None
+    return "dark" if scheme == Qt.ColorScheme.Dark else "light"
+
+
+def _macos_theme_name() -> str | None:
+    try:
+        result = subprocess.run(
+            ["defaults", "read", "-g", "AppleInterfaceStyle"],
+            check=False,
+            capture_output=True,
+            text=True,
+            timeout=0.5,
+        )
+    except Exception:
+        return None
+    return "dark" if "dark" in (result.stdout or "").strip().lower() else "light"
+
+
+def _windows_theme_name() -> str | None:
+    try:
+        import winreg  # type: ignore
+    except Exception:
+        return None
+    try:
+        with winreg.OpenKey(
+            winreg.HKEY_CURRENT_USER,
+            r"Software\Microsoft\Windows\CurrentVersion\Themes\Personalize",
+        ) as key:
+            value, _ = winreg.QueryValueEx(key, "AppsUseLightTheme")
+    except Exception:
+        return None
+    return "light" if int(value) else "dark"
+
+
+def _linux_theme_name() -> str | None:
+    gtk_theme = os.environ.get("GTK_THEME", "").lower()
+    if ":dark" in gtk_theme or gtk_theme.endswith("-dark"):
+        return "dark"
+    if gtk_theme:
+        return "light"
+    colorfgbg = os.environ.get("COLORFGBG", "")
+    if colorfgbg:
+        try:
+            bg = int(colorfgbg.split(";")[-1])
+        except ValueError:
+            return None
+        return "dark" if bg <= 6 else "light"
+    return None
+
+
+def system_theme_name() -> str:
+    """Return the host light/dark theme using shared cross-surface detection."""
+    override = os.environ.get("DATA_ENGINE_THEME", "").strip().lower()
+    if override in THEMES:
+        return override
+    qt_theme = _qt_theme_name()
+    if qt_theme is not None:
+        return qt_theme
+    system = platform.system()
+    if system == "Darwin":
+        return _macos_theme_name() or "dark"
+    if system == "Windows":
+        return _windows_theme_name() or "dark"
+    return _linux_theme_name() or "dark"
+
+
+def resolve_theme_name(theme_name: str = DEFAULT_THEME) -> str:
+    """Resolve a requested theme name, honoring system-following default behavior."""
+    if theme_name == DEFAULT_THEME:
+        return system_theme_name()
+    return theme_name if theme_name in THEMES else system_theme_name()
+
+
+__all__ = [
+    "DEFAULT_THEME",
+    "GITHUB_DARK",
+    "GITHUB_LIGHT",
+    "THEMES",
+    "ThemePalette",
+    "resolve_theme_name",
+    "system_theme_name",
+    "theme_button_text",
+    "toggle_theme_name",
+]

data_engine/platform/workspace_models.py

@@ -0,0 +1,190 @@
+"""Shared workspace path models and pure helpers."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+import hashlib
+from pathlib import Path
+import socket
+import sys
+import unicodedata
+
+from data_engine.platform.identity import APP_INTERNAL_ID, env_var
+
+
+def _resolve_app_root_path() -> Path:
+    """Resolve the application root in both dev and frozen executable contexts."""
+    if getattr(sys, "frozen", False):
+        return Path(sys.executable).resolve().parent
+    return Path(__file__).resolve().parents[3]
+
+
+APP_ROOT_PATH: Path = _resolve_app_root_path()
+DATA_ENGINE_APP_ROOT_ENV_VAR: str = env_var("app_root")
+DATA_ENGINE_WORKSPACE_ROOT_ENV_VAR: str = env_var("workspace_root")
+DATA_ENGINE_WORKSPACE_ID_ENV_VAR: str = env_var("workspace_id")
+DATA_ENGINE_WORKSPACE_COLLECTION_ROOT_ENV_VAR: str = env_var("workspace_collection_root")
+DATA_ENGINE_RUNTIME_ROOT_ENV_VAR: str = env_var("runtime_root")
+DATA_ENGINE_RUNTIME_DB_PATH_ENV_VAR: str = env_var("runtime_db_path")
+WORKSPACE_CONFIG_DIR_NAME: str = "config"
+WORKSPACE_FLOW_MODULES_DIR_NAME: str = "flow_modules"
+WORKSPACE_FLOW_HELPERS_DIR_NAME: str = "flow_helpers"
+WORKSPACE_DATABASES_DIR_NAME: str = "databases"
+WORKSPACE_STATE_DIR_NAME: str = ".workspace_state"
+WORKSPACE_AVAILABLE_MARKERS_DIR_NAME: str = "available"
+WORKSPACE_LEASED_MARKERS_DIR_NAME: str = "leased"
+WORKSPACE_STALE_MARKERS_DIR_NAME: str = "stale"
+WORKSPACE_LEASE_METADATA_DIR_NAME: str = "leases"
+WORKSPACE_CONTROL_REQUESTS_DIR_NAME: str = "control_requests"
+WORKSPACE_SHARED_STATE_DIR_NAME: str = "state"
+WORKSPACE_SHARED_RUNS_DIR_NAME: str = "runs"
+WORKSPACE_SHARED_STEP_RUNS_DIR_NAME: str = "step_runs"
+WORKSPACE_SHARED_LOGS_DIR_NAME: str = "logs"
+WORKSPACE_SHARED_FILE_STATE_DIR_NAME: str = "file_state"
+
+
+def normalized_path_text(value: Path | str) -> str:
+    """Return a stable forward-slash path string for display and comparisons."""
+    return unicodedata.normalize("NFC", str(value).replace("\\", "/"))
+
+
+def path_display(value: Path | str | None, *, empty: str = "(not set)") -> str:
+    """Render a path value consistently for UI/display use."""
+    if value is None:
+        return empty
+    return normalized_path_text(value)
+
+
+def toml_path_text(value: Path | str) -> str:
+    """Render a path as TOML-safe text without Windows backslash escapes."""
+    return normalized_path_text(value)
+
+
+class InvalidWorkspaceIdError(ValueError):
+    """Raised when a workspace id contains unsafe path components."""
+
+
+def validate_workspace_id(workspace_id: str) -> str:
+    """Return a workspace id that is safe to use in path components."""
+    candidate = str(workspace_id)
+    if not candidate.strip():
+        raise InvalidWorkspaceIdError("Workspace id cannot be empty.")
+    if candidate in {".", ".."}:
+        raise InvalidWorkspaceIdError(f"Workspace id {candidate!r} is not allowed.")
+    if "\x00" in candidate:
+        raise InvalidWorkspaceIdError("Workspace id cannot contain NUL bytes.")
+    if "/" in candidate or "\\" in candidate:
+        raise InvalidWorkspaceIdError(f"Workspace id {candidate!r} must not contain path separators.")
+    return candidate
+
+
+def local_workspace_namespace(workspace_root: Path | str, workspace_id: str) -> str:
+    """Return the machine-local namespace for one workspace root."""
+    workspace_id = validate_workspace_id(workspace_id)
+    digest = hashlib.sha1(normalized_path_text(Path(workspace_root).expanduser().resolve()).encode("utf-8")).hexdigest()[:12]
+    return f"{workspace_id}_{digest}"
+
+
+@dataclass(frozen=True)
+class WorkspaceSettings:
+    """Machine-local workspace discovery settings."""
+
+    app_root: Path
+    settings_path: Path
+    state_root: Path
+    runtime_root: Path
+    workspace_collection_root: Path | None
+    default_selected: str | None
+
+
+@dataclass(frozen=True)
+class DiscoveredWorkspace:
+    """One discovered authored workspace."""
+
+    workspace_id: str
+    workspace_root: Path
+
+
+@dataclass(frozen=True)
+class WorkspacePaths:
+    """Resolved authored, shared, and local-artifact paths for one workspace."""
+
+    app_root: Path
+    workspace_collection_root: Path
+    workspace_id: str
+    workspace_root: Path
+    config_dir: Path
+    flow_modules_dir: Path
+    databases_dir: Path
+    workspace_state_dir: Path
+    available_markers_dir: Path
+    leased_markers_dir: Path
+    stale_markers_dir: Path
+    lease_metadata_dir: Path
+    lease_metadata_path: Path
+    control_requests_dir: Path
+    control_request_path: Path
+    shared_state_dir: Path
+    shared_runs_path: Path
+    shared_step_runs_path: Path
+    shared_logs_path: Path
+    shared_file_state_path: Path
+    artifacts_dir: Path
+    workspace_cache_dir: Path
+    compiled_flow_modules_dir: Path
+    runtime_state_dir: Path
+    runtime_db_path: Path
+    daemon_log_path: Path
+    documentation_dir: Path
+    daemon_endpoint_kind: str
+    daemon_endpoint_path: str
+    sphinx_source_dir: Path
+    workspace_configured: bool = True
+
+
+def authored_workspace_is_available(paths: WorkspacePaths) -> bool:
+    """Return whether one authored workspace root is still present and usable."""
+    return paths.workspace_configured and paths.workspace_root.is_dir() and paths.flow_modules_dir.is_dir()
+
+
+def machine_id_text() -> str:
+    """Return a stable local machine identifier for lease metadata."""
+    return socket.gethostname()
+
+
+__all__ = [
+    "APP_INTERNAL_ID",
+    "APP_ROOT_PATH",
+    "DATA_ENGINE_APP_ROOT_ENV_VAR",
+    "DATA_ENGINE_RUNTIME_DB_PATH_ENV_VAR",
+    "DATA_ENGINE_RUNTIME_ROOT_ENV_VAR",
+    "DATA_ENGINE_WORKSPACE_COLLECTION_ROOT_ENV_VAR",
+    "DATA_ENGINE_WORKSPACE_ID_ENV_VAR",
+    "DATA_ENGINE_WORKSPACE_ROOT_ENV_VAR",
+    "DiscoveredWorkspace",
+    "InvalidWorkspaceIdError",
+    "WORKSPACE_AVAILABLE_MARKERS_DIR_NAME",
+    "WORKSPACE_CONFIG_DIR_NAME",
+    "WORKSPACE_CONTROL_REQUESTS_DIR_NAME",
+    "WORKSPACE_DATABASES_DIR_NAME",
+    "WORKSPACE_FLOW_HELPERS_DIR_NAME",
+    "WORKSPACE_FLOW_MODULES_DIR_NAME",
+    "WORKSPACE_LEASED_MARKERS_DIR_NAME",
+    "WORKSPACE_LEASE_METADATA_DIR_NAME",
+    "WORKSPACE_SHARED_FILE_STATE_DIR_NAME",
+    "WORKSPACE_SHARED_LOGS_DIR_NAME",
+    "WORKSPACE_SHARED_RUNS_DIR_NAME",
+    "WORKSPACE_SHARED_STATE_DIR_NAME",
+    "WORKSPACE_SHARED_STEP_RUNS_DIR_NAME",
+    "WORKSPACE_STALE_MARKERS_DIR_NAME",
+    "WORKSPACE_STATE_DIR_NAME",
+    "WorkspacePaths",
+    "WorkspaceSettings",
+    "authored_workspace_is_available",
+    "local_workspace_namespace",
+    "machine_id_text",
+    "normalized_path_text",
+    "path_display",
+    "toml_path_text",
+    "validate_workspace_id",
+]