autoglm-gui 0.4.11__py3-none-any.whl → 0.4.12__py3-none-any.whl

AutoGLM_GUI/config_manager.py

@@ -1,124 +1,565 @@
-"""配置文件管理模块."""
+"""统一配置管理模块 - 四层优先级系统.
+
+配置优先级：CLI 参数 > 环境变量 > 配置文件 > 默认值
+
+Features:
+- 类型安全的配置模型（Pydantic 验证）
+- 多层配置系统，带源追踪
+- 配置冲突检测和提示
+- 配置文件热重载（基于 mtime 缓存）
+- 原子文件写入
+- 环境变量同步（支持 --reload 模式）
+"""
 
 import json
+import os
+from dataclasses import dataclass
+from enum import Enum
 from pathlib import Path
+from typing import Optional
+
+from pydantic import BaseModel, field_validator
 
 from AutoGLM_GUI.logger import logger
 
-# 默认配置
-DEFAULT_CONFIG = {"base_url": "", "model_name": "autoglm-phone-9b", "api_key": "EMPTY"}
 
+# ==================== 配置源枚举 ====================
 
-def get_config_path() -> Path:
-    """获取配置文件路径.
 
-    Returns:
-        Path: 配置文件路径 (~/.config/autoglm/config.json)
-    """
-    config_dir = Path.home() / ".config" / "autoglm"
-    return config_dir / "config.json"
+class ConfigSource(str, Enum):
+    """配置来源枚举（按优先级从高到低）."""
+
+    CLI = "CLI arguments"
+    ENV = "environment variables"
+    FILE = "config file (~/.config/autoglm/config.json)"
+    DEFAULT = "default"
+
+
+# ==================== 类型安全配置模型 ====================
+
+
+class ConfigModel(BaseModel):
+    """类型安全的配置模型，使用 Pydantic 进行验证."""
+
+    base_url: str = ""
+    model_name: str = "autoglm-phone-9b"
+    api_key: str = "EMPTY"
+
+    @field_validator("base_url")
+    @classmethod
+    def validate_base_url(cls, v: str) -> str:
+        """验证 base_url 格式."""
+        if v and not v.startswith(("http://", "https://")):
+            raise ValueError("base_url must start with http:// or https://")
+        return v.rstrip("/")  # 去除尾部斜杠
+
+    @field_validator("model_name")
+    @classmethod
+    def validate_model_name(cls, v: str) -> str:
+        """验证 model_name 非空."""
+        if not v or not v.strip():
+            raise ValueError("model_name cannot be empty")
+        return v.strip()
+
+
+# ==================== 配置层数据类 ====================
+
+
+@dataclass
+class ConfigLayer:
+    """单个配置层，带源追踪."""
+
+    base_url: Optional[str] = None
+    model_name: Optional[str] = None
+    api_key: Optional[str] = None
+    source: ConfigSource = ConfigSource.DEFAULT
+
+    def has_value(self, key: str) -> bool:
+        """检查此层是否有非 None 的值.
+
+        Args:
+            key: 配置键名
+
+        Returns:
+            bool: 如果有值返回 True
+        """
+        value = getattr(self, key, None)
+        return value is not None
+
+    def to_dict(self) -> dict:
+        """转换为字典，排除 None 值.
+
+        Returns:
+            dict: 配置字典
+        """
+        return {
+            k: v
+            for k, v in {
+                "base_url": self.base_url,
+                "model_name": self.model_name,
+                "api_key": self.api_key,
+            }.items()
+            if v is not None
+        }
+
+
+# ==================== 配置冲突数据类 ====================
+
+
+@dataclass
+class ConfigConflict:
+    """配置冲突信息."""
 
+    field: str  # 冲突的字段名
+    file_value: Optional[str]  # 配置文件中的值
+    override_value: str  # 覆盖的值
+    override_source: ConfigSource  # 覆盖来源（CLI 或 ENV）
 
-def load_config_file() -> dict | None:
-    """从文件加载配置.
 
-    Returns:
-        dict | None: 配置字典，如果文件不存在或加载失败则返回 None
+# ==================== 统一配置管理器 ====================
+
+
+class UnifiedConfigManager:
     """
-    config_path = get_config_path()
-
-    # 文件不存在（首次运行）
-    if not config_path.exists():
-        logger.debug(f"Config file not found at {config_path}")
-        return None
-
-    try:
-        with open(config_path, "r", encoding="utf-8") as f:
-            config = json.load(f)
-            logger.info(f"Loaded configuration from {config_path}")
-            return config
-    except json.JSONDecodeError as e:
-        logger.warning(f"Failed to parse config file {config_path}: {e}")
-        return None
-    except Exception as e:
-        logger.error(f"Failed to read config file {config_path}: {e}")
-        return None
-
-
-def save_config_file(config: dict) -> bool:
-    """保存配置到文件（原子写入）.
-
-    Args:
-        config: 配置字典
-
-    Returns:
-        bool: 成功返回 True，失败返回 False
+    统一配置管理器（单例模式）.
+
+    配置优先级：CLI 参数 > 环境变量 > 配置文件 > 默认值
+
+    Features:
+    - 类型安全配置（Pydantic 验证）
+    - 多层优先级系统
+    - 配置冲突检测
+    - 文件热重载（基于 mtime 缓存）
+    - 原子文件写入
+    - 环境变量同步（reload 模式）
     """
-    config_path = get_config_path()
 
-    try:
-        # 确保目录存在
-        config_path.parent.mkdir(parents=True, exist_ok=True)
+    _instance: Optional["UnifiedConfigManager"] = None
+    _config_path: Path = Path.home() / ".config" / "autoglm" / "config.json"
 
-        # 原子写入：先写入临时文件，然后重命名
-        temp_path = config_path.with_suffix(".tmp")
-        with open(temp_path, "w", encoding="utf-8") as f:
-            json.dump(config, f, indent=2, ensure_ascii=False)
+    def __new__(cls):
+        """单例模式."""
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+            cls._instance._initialized = False
+        return cls._instance
 
-        # 重命名（原子操作）
-        temp_path.replace(config_path)
+    def __init__(self):
+        """初始化配置管理器."""
+        if hasattr(self, "_initialized") and self._initialized:
+            return
 
-        logger.info(f"Configuration saved to {config_path}")
-        return True
-    except Exception as e:
-        logger.error(f"Failed to save config file {config_path}: {e}")
-        return False
+        # 四层配置
+        self._cli_layer = ConfigLayer(source=ConfigSource.CLI)
+        self._env_layer = ConfigLayer(source=ConfigSource.ENV)
+        self._file_layer = ConfigLayer(source=ConfigSource.FILE)
+        self._default_layer = ConfigLayer(
+            base_url="",
+            model_name="autoglm-phone-9b",
+            api_key="EMPTY",
+            source=ConfigSource.DEFAULT,
+        )
 
+        # 文件缓存（带修改时间戳）
+        self._file_cache: Optional[dict] = None
+        self._file_mtime: Optional[float] = None
 
-def delete_config_file() -> bool:
-    """删除配置文件.
+        # 有效配置缓存
+        self._effective_config: Optional[ConfigModel] = None
 
-    Returns:
-        bool: 成功返回 True，失败返回 False
-    """
-    config_path = get_config_path()
+        self._initialized = True
+        logger.debug("UnifiedConfigManager initialized")
 
-    if not config_path.exists():
-        logger.debug(f"Config file does not exist: {config_path}")
-        return True
+    # ==================== 配置加载 ====================
 
-    try:
-        config_path.unlink()
-        logger.info(f"Configuration deleted: {config_path}")
-        return True
-    except Exception as e:
-        logger.error(f"Failed to delete config file {config_path}: {e}")
-        return False
+    def set_cli_config(
+        self,
+        base_url: Optional[str] = None,
+        model_name: Optional[str] = None,
+        api_key: Optional[str] = None,
+    ) -> None:
+        """
+        设置 CLI 参数配置（最高优先级）.
 
+        Args:
+            base_url: 从 --base-url 获取的值
+            model_name: 从 --model 获取的值
+            api_key: 从 --apikey 获取的值
+        """
+        self._cli_layer = ConfigLayer(
+            base_url=base_url,
+            model_name=model_name,
+            api_key=api_key,
+            source=ConfigSource.CLI,
+        )
+        self._effective_config = None  # 清除缓存
+        logger.debug(f"CLI config set: {self._cli_layer.to_dict()}")
 
-def merge_configs(file_config: dict | None, cli_config: dict | None) -> dict:
-    """合并配置（优先级：CLI > 文件 > 默认值）.
+    def load_env_config(self) -> None:
+        """
+        从环境变量加载配置.
 
-    Args:
-        file_config: 从文件加载的配置（可为 None）
-        cli_config: CLI 参数配置（可为 None）
+        读取环境变量：
+        - AUTOGLM_BASE_URL
+        - AUTOGLM_MODEL_NAME
+        - AUTOGLM_API_KEY
+        """
+        base_url = os.getenv("AUTOGLM_BASE_URL")
+        model_name = os.getenv("AUTOGLM_MODEL_NAME")
+        api_key = os.getenv("AUTOGLM_API_KEY")
 
-    Returns:
-        dict: 合并后的配置字典
-    """
-    # 从默认配置开始
-    merged = DEFAULT_CONFIG.copy()
-
-    # 应用文件配置（如果存在）
-    if file_config:
-        for key in DEFAULT_CONFIG.keys():
-            if key in file_config:
-                merged[key] = file_config[key]
-
-    # 应用 CLI 配置（最高优先级）
-    if cli_config:
-        for key in DEFAULT_CONFIG.keys():
-            if key in cli_config:
-                merged[key] = cli_config[key]
-
-    return merged
+        self._env_layer = ConfigLayer(
+            base_url=base_url if base_url else None,
+            model_name=model_name if model_name else None,
+            api_key=api_key if api_key else None,
+            source=ConfigSource.ENV,
+        )
+        self._effective_config = None  # 清除缓存
+        logger.debug(f"Environment config loaded: {self._env_layer.to_dict()}")
+
+    def load_file_config(self, force_reload: bool = False) -> bool:
+        """
+        从文件加载配置，支持热重载.
+
+        基于文件修改时间（mtime）的缓存机制：
+        - 如果文件未变化且有缓存，直接使用缓存
+        - 否则重新读取文件
+
+        Args:
+            force_reload: 强制重新加载，即使文件未变化
+
+        Returns:
+            bool: 如果配置被加载/重载返回 True，否则返回 False
+        """
+        if not self._config_path.exists():
+            logger.debug(f"Config file not found: {self._config_path}")
+            self._file_layer = ConfigLayer(source=ConfigSource.FILE)
+            self._file_cache = None
+            self._file_mtime = None
+            self._effective_config = None
+            return False
+
+        try:
+            # 获取文件修改时间
+            current_mtime = self._config_path.stat().st_mtime
+
+            # 使用缓存（如果文件未变化）
+            if (
+                not force_reload
+                and self._file_mtime == current_mtime
+                and self._file_cache
+            ):
+                logger.debug("Using cached config file (file unchanged)")
+                return False
+
+            # 读取并解析文件
+            with open(self._config_path, "r", encoding="utf-8") as f:
+                config_data = json.load(f)
+
+            # 更新缓存
+            self._file_cache = config_data
+            self._file_mtime = current_mtime
+
+            # 更新文件层
+            self._file_layer = ConfigLayer(
+                base_url=config_data.get("base_url"),
+                model_name=config_data.get("model_name"),
+                api_key=config_data.get("api_key"),
+                source=ConfigSource.FILE,
+            )
+            self._effective_config = None  # 清除缓存
+
+            logger.info(f"Config file loaded from {self._config_path}")
+            return True
+
+        except json.JSONDecodeError as e:
+            logger.warning(f"Failed to parse config file: {e}")
+            self._file_layer = ConfigLayer(source=ConfigSource.FILE)
+            self._file_cache = None
+            self._file_mtime = None
+            self._effective_config = None
+            return False
+        except Exception as e:
+            logger.error(f"Failed to read config file: {e}")
+            self._file_layer = ConfigLayer(source=ConfigSource.FILE)
+            self._file_cache = None
+            self._file_mtime = None
+            self._effective_config = None
+            return False
+
+    def save_file_config(
+        self,
+        base_url: str,
+        model_name: str,
+        api_key: Optional[str] = None,
+        merge_mode: bool = True,
+    ) -> bool:
+        """
+        保存配置到文件，支持合并模式.
+
+        Args:
+            base_url: Base URL
+            model_name: 模型名称
+            api_key: API key（可选）
+            merge_mode: 是否合并现有配置（True: 保留未提供的字段）
+
+        Returns:
+            bool: 成功返回 True，失败返回 False
+        """
+        try:
+            # 确保目录存在
+            self._config_path.parent.mkdir(parents=True, exist_ok=True)
+
+            # 准备新配置
+            new_config = {
+                "base_url": base_url,
+                "model_name": model_name,
+            }
+
+            if api_key:
+                new_config["api_key"] = api_key
+
+            # 合并模式：保留现有文件中未提供的字段
+            if merge_mode and self._config_path.exists():
+                try:
+                    with open(self._config_path, "r", encoding="utf-8") as f:
+                        existing = json.load(f)
+
+                    # 保留 api_key（如果新配置未提供）
+                    if not api_key and "api_key" in existing:
+                        new_config["api_key"] = existing["api_key"]
+
+                except (json.JSONDecodeError, Exception) as e:
+                    logger.warning(f"Could not merge with existing config: {e}")
+
+            # 原子写入：临时文件 + 重命名
+            temp_path = self._config_path.with_suffix(".tmp")
+            with open(temp_path, "w", encoding="utf-8") as f:
+                json.dump(new_config, f, indent=2, ensure_ascii=False)
+
+            temp_path.replace(self._config_path)
+
+            logger.info(f"Configuration saved to {self._config_path}")
+
+            # 重新加载文件配置以更新缓存
+            self.load_file_config(force_reload=True)
+
+            return True
+
+        except Exception as e:
+            logger.error(f"Failed to save config: {e}")
+            return False
+
+    def delete_file_config(self) -> bool:
+        """
+        删除配置文件.
+
+        Returns:
+            bool: 成功或文件不存在返回 True，失败返回 False
+        """
+        if not self._config_path.exists():
+            logger.debug("Config file doesn't exist, nothing to delete")
+            return True
+
+        try:
+            self._config_path.unlink()
+            self._file_cache = None
+            self._file_mtime = None
+            self._file_layer = ConfigLayer(source=ConfigSource.FILE)
+            self._effective_config = None
+            logger.info(f"Configuration deleted: {self._config_path}")
+            return True
+        except Exception as e:
+            logger.error(f"Failed to delete config file: {e}")
+            return False
+
+    # ==================== 配置合并 ====================
+
+    def get_effective_config(self, reload_file: bool = False) -> ConfigModel:
+        """
+        获取合并后的有效配置.
+
+        配置优先级：CLI > ENV > FILE > DEFAULT
+
+        Args:
+            reload_file: 是否强制重新加载配置文件
+
+        Returns:
+            ConfigModel: 验证后的配置对象
+        """
+        # 重新加载文件（热重载支持）
+        if reload_file:
+            self.load_file_config(force_reload=True)
+
+        # 返回缓存（如果可用）
+        if self._effective_config is not None:
+            return self._effective_config
+
+        # 按优先级合并配置
+        merged = {}
+
+        for key in ["base_url", "model_name", "api_key"]:
+            # 1. CLI 优先
+            if self._cli_layer.has_value(key):
+                merged[key] = getattr(self._cli_layer, key)
+            # 2. 环境变量
+            elif self._env_layer.has_value(key):
+                merged[key] = getattr(self._env_layer, key)
+            # 3. 配置文件
+            elif self._file_layer.has_value(key):
+                merged[key] = getattr(self._file_layer, key)
+            # 4. 默认值
+            else:
+                merged[key] = getattr(self._default_layer, key)
+
+        # 验证并缓存
+        try:
+            self._effective_config = ConfigModel(**merged)
+            logger.debug(f"Effective config computed: {merged}")
+            return self._effective_config
+        except Exception as e:
+            logger.error(f"Configuration validation failed: {e}")
+            # 降级到默认值
+            self._effective_config = ConfigModel()
+            return self._effective_config
+
+    def get_config_source(self) -> ConfigSource:
+        """
+        获取主要配置来源.
+
+        Returns:
+            ConfigSource: 最高优先级的非空配置源
+        """
+        # 检查 CLI 是否有值
+        if self._cli_layer.to_dict():
+            return ConfigSource.CLI
+
+        # 检查 ENV 是否有值
+        if self._env_layer.to_dict():
+            return ConfigSource.ENV
+
+        # 检查 FILE 是否有值
+        if self._file_layer.to_dict():
+            return ConfigSource.FILE
+
+        return ConfigSource.DEFAULT
+
+    def get_field_source(self, field: str) -> ConfigSource:
+        """
+        获取特定字段的配置来源.
+
+        Args:
+            field: 字段名（'base_url', 'model_name', 'api_key'）
+
+        Returns:
+            ConfigSource: 该字段的配置来源
+        """
+        if self._cli_layer.has_value(field):
+            return ConfigSource.CLI
+        elif self._env_layer.has_value(field):
+            return ConfigSource.ENV
+        elif self._file_layer.has_value(field):
+            return ConfigSource.FILE
+        else:
+            return ConfigSource.DEFAULT
+
+    # ==================== 配置冲突检测 ====================
+
+    def detect_conflicts(self) -> list[ConfigConflict]:
+        """
+        检测配置冲突.
+
+        冲突定义：
+        1. 配置文件中有某个字段的值
+        2. CLI 或 ENV 有该字段的不同值（覆盖）
+
+        Returns:
+            list[ConfigConflict]: 冲突列表
+        """
+        conflicts = []
+
+        if not self._file_layer.to_dict():
+            return conflicts  # 无文件配置，无冲突
+
+        for key in ["base_url", "model_name", "api_key"]:
+            file_value = getattr(self._file_layer, key, None)
+
+            if file_value is None:
+                continue  # 文件中没有此字段
+
+            # 检查 CLI 覆盖
+            cli_value = getattr(self._cli_layer, key, None)
+            if cli_value is not None and cli_value != file_value:
+                conflicts.append(
+                    ConfigConflict(
+                        field=key,
+                        file_value=file_value,
+                        override_value=cli_value,
+                        override_source=ConfigSource.CLI,
+                    )
+                )
+                continue
+
+            # 检查 ENV 覆盖
+            env_value = getattr(self._env_layer, key, None)
+            if env_value is not None and env_value != file_value:
+                conflicts.append(
+                    ConfigConflict(
+                        field=key,
+                        file_value=file_value,
+                        override_value=env_value,
+                        override_source=ConfigSource.ENV,
+                    )
+                )
+
+        return conflicts
+
+    # ==================== 环境变量同步 ====================
+
+    def sync_to_env(self) -> None:
+        """
+        将有效配置同步到环境变量.
+
+        这是 --reload 模式必需的：
+        - uvicorn reload 会启动新进程
+        - 新进程继承父进程的环境变量
+        - 通过环境变量恢复配置
+        """
+        config = self.get_effective_config()
+
+        os.environ["AUTOGLM_BASE_URL"] = config.base_url
+        os.environ["AUTOGLM_MODEL_NAME"] = config.model_name
+        os.environ["AUTOGLM_API_KEY"] = config.api_key
+
+        logger.debug("Configuration synced to environment variables")
+
+    # ==================== 工具方法 ====================
+
+    def get_config_path(self) -> Path:
+        """获取配置文件路径.
+
+        Returns:
+            Path: 配置文件路径
+        """
+        return self._config_path
+
+    def to_dict(self) -> dict:
+        """
+        将有效配置转换为字典.
+
+        Returns:
+            dict: 配置字典
+        """
+        config = self.get_effective_config()
+        return {
+            "base_url": config.base_url,
+            "model_name": config.model_name,
+            "api_key": config.api_key,
+        }
+
+
+# ==================== 全局单例 ====================
+
+
+# 全局配置管理器单例
+config_manager = UnifiedConfigManager()

AutoGLM_GUI/exceptions.py

@@ -0,0 +1,7 @@
+"""Custom exceptions for AutoGLM-GUI."""
+
+
+class DeviceNotAvailableError(Exception):
+    """Raised when device is not available (disconnected/offline)."""
+
+    pass

AutoGLM_GUI/platform_utils.py

@@ -11,6 +11,25 @@ def is_windows() -> bool:
     return platform.system() == "Windows"
 
 
+def run_cmd_silently_sync(
+    cmd: Sequence[str], timeout: float | None = None
+) -> subprocess.CompletedProcess:
+    """Run a command synchronously, suppressing output but preserving it in the result.
+
+    This is the synchronous version that works on all platforms.
+
+    Args:
+        cmd: Command to run as a sequence of strings
+        timeout: Optional timeout in seconds
+
+    Returns:
+        CompletedProcess with stdout/stderr captured
+    """
+    return subprocess.run(
+        cmd, capture_output=True, text=True, check=False, timeout=timeout
+    )
+
+
 async def run_cmd_silently(cmd: Sequence[str]) -> subprocess.CompletedProcess:
     """Run a command, suppressing output but preserving it in the result; safe for async contexts on all platforms."""
     if is_windows():