ksaa 2025.5.23.3__py3-none-any.whl → 2025.6.23.0__py3-none-any.whl

kotonebot/kaa/main/kaa.py

@@ -1,21 +1,30 @@
 import io
 import os
+import zipfile
 import logging
-import importlib.metadata
 import traceback
-import zipfile
+import importlib.metadata
 from datetime import datetime
+from typing_extensions import override
 
 import cv2
-from typing_extensions import override
 
-from .dmm_host import DmmHost
 from ...client import Device
 from kotonebot.ui import user
 from kotonebot import KotoneBot
+from ..util.paths import get_ahk_path
 from ..kaa_context import _set_instance
+from .dmm_host import DmmHost, DmmInstance
 from ..common import BaseConfig, upgrade_config
-from kotonebot.client.host import Mumu12Host, LeidianHost
+from kotonebot.config.base_config import UserConfig
+from kotonebot.client.host import (
+    Mumu12Host, LeidianHost, Mumu12Instance,
+    LeidianInstance, CustomInstance
+)
+from kotonebot.client.host.protocol import (
+    Instance, AdbHostConfig, WindowsHostConfig,
+    RemoteWindowsHostConfig
+)
 
 # 初始化日志
 log_formatter = logging.Formatter('[%(asctime)s][%(levelname)s][%(name)s] %(message)s')
@@ -104,23 +113,27 @@ class Kaa(KotoneBot):
             raise ValueError('Backend instance is not set.')
         _set_instance(self.backend_instance)
 
-    @override
-    def _on_create_device(self) -> Device:
+    def __get_backend_instance(self, config: UserConfig) -> Instance:
+        """
+        根据配置获取或创建 Instance。
+
+        :param config: 用户配置对象
+        :return: 后端实例
+        """
         from kotonebot.client.host import create_custom
-        from kotonebot.config.manager import load_config
-        # HACK: 硬编码
-        config = load_config(self.config_path, type=self.config_type)
-        config = config.user_configs[0]
-        logger.info('Checking backend...')
+
+        logger.info(f'Querying for backend: {config.backend.type}')
+
         if config.backend.type == 'custom':
             exe = config.backend.emulator_path
-            self.backend_instance = create_custom(
+            instance = create_custom(
                 adb_ip=config.backend.adb_ip,
                 adb_port=config.backend.adb_port,
                 adb_name=config.backend.adb_emulator_name,
                 exe_path=exe,
                 emulator_args=config.backend.emulator_args
             )
+            # 对于 custom 类型，需要额外验证模拟器路径
             if config.backend.check_emulator:
                 if exe is None:
                     user.error('「检查并启动模拟器」已开启但未配置「模拟器 exe 文件路径」。')
@@ -128,42 +141,101 @@ class Kaa(KotoneBot):
                 if not os.path.exists(exe):
                     user.error('「模拟器 exe 文件路径」对应的文件不存在！请检查路径是否正确。')
                     raise FileNotFoundError(f'Emulator executable not found: {exe}')
-                if not self.backend_instance.running():
-                    logger.info('Starting custom backend...')
-                    self.backend_instance.start()
-                    logger.info('Waiting for custom backend to be available...')
-                    self.backend_instance.wait_available()
-                else:
-                    logger.info('Custom backend "%s" already running.', self.backend_instance)
+            return instance
+
         elif config.backend.type == 'mumu12':
             if config.backend.instance_id is None:
                 raise ValueError('MuMu12 instance ID is not set.')
-            self.backend_instance = Mumu12Host.query(id=config.backend.instance_id)
-            if self.backend_instance is None:
+            instance = Mumu12Host.query(id=config.backend.instance_id)
+            if instance is None:
                 raise ValueError(f'MuMu12 instance not found: {config.backend.instance_id}')
-            if not self.backend_instance.running():
-                logger.info('Starting MuMu12 backend...')
-                self.backend_instance.start()
-                logger.info('Waiting for MuMu12 backend to be available...')
-                self.backend_instance.wait_available()
-            else:
-                logger.info('MuMu12 backend "%s" already running.', self.backend_instance)
+            return instance
+
         elif config.backend.type == 'leidian':
             if config.backend.instance_id is None:
                 raise ValueError('Leidian instance ID is not set.')
-            self.backend_instance = LeidianHost.query(id=config.backend.instance_id)
-            if self.backend_instance is None:
+            instance = LeidianHost.query(id=config.backend.instance_id)
+            if instance is None:
                 raise ValueError(f'Leidian instance not found: {config.backend.instance_id}')
-            if not self.backend_instance.running():
-                logger.info('Starting Leidian backend...')
-                self.backend_instance.start()
-                logger.info('Waiting for Leidian backend to be available...')
-                self.backend_instance.wait_available()
-            else:
-                logger.info('Leidian backend "%s" already running.', self.backend_instance)
+            return instance
+
         elif config.backend.type == 'dmm':
-            self.backend_instance = DmmHost.instance
+            return DmmHost.instance
+
         else:
             raise ValueError(f'Unsupported backend type: {config.backend.type}')
-        assert self.backend_instance is not None, 'Backend instance is not set.'
-        return self.backend_instance.create_device(config.backend.screenshot_impl)
+
+    def __ensure_instance_running(self, instance: Instance, config: UserConfig):
+        """
+        确保 Instance 正在运行。
+
+        :param instance: 后端实例
+        :param config: 用户配置对象
+        """
+        # DMM 实例不需要启动，直接返回
+        if isinstance(instance, DmmInstance):
+            logger.info('DMM backend does not require startup.')
+            return
+
+        # 对所有需要启动的后端（custom, mumu, leidian）使用统一逻辑
+        if config.backend.check_emulator and not instance.running():
+            logger.info(f'Starting backend "{instance}"...')
+            instance.start()
+            logger.info(f'Waiting for backend "{instance}" to be available...')
+            instance.wait_available()
+        else:
+            logger.info(f'Backend "{instance}" already running or check is disabled.')
+
+    @override
+    def _on_create_device(self) -> Device:
+        """
+        创建设备。
+        """
+        from kotonebot.config.manager import load_config
+
+        # 步骤1：加载配置
+        config = load_config(self.config_path, type=self.config_type)
+        user_config = config.user_configs[0]  # HACK: 硬编码
+
+        # 步骤2：获取实例
+        self.backend_instance = self.__get_backend_instance(user_config)
+        if self.backend_instance is None:
+            raise RuntimeError(f"Failed to find instance for backend '{user_config.backend.type}'")
+
+        # 步骤3：确保实例运行
+        self.__ensure_instance_running(self.backend_instance, user_config)
+
+        # 步骤4：准备 HostConfig 并创建 Device
+        impl_name = user_config.backend.screenshot_impl
+
+        if isinstance(self.backend_instance, DmmInstance):
+            if impl_name == 'windows':
+                ahk_path = get_ahk_path()
+                host_conf = WindowsHostConfig(
+                    window_title='gakumas',
+                    ahk_exe_path=ahk_path
+                )
+            elif impl_name == 'remote_windows':
+                ahk_path = get_ahk_path()
+                host_conf = RemoteWindowsHostConfig(
+                    windows_host_config=WindowsHostConfig(
+                        window_title='gakumas',
+                        ahk_exe_path=ahk_path
+                    ),
+                    host=user_config.backend.adb_ip,
+                    port=user_config.backend.adb_port
+                )
+            else:
+                raise ValueError(f"Impl of '{impl_name}' is not supported on DMM.")
+            return self.backend_instance.create_device(impl_name, host_conf)
+
+        # 统一处理所有基于 ADB 的后端
+        elif isinstance(self.backend_instance, (CustomInstance, Mumu12Instance, LeidianInstance)):
+            if impl_name in ['adb', 'adb_raw', 'uiautomator2']:
+                host_conf = AdbHostConfig(timeout=180)
+                return self.backend_instance.create_device(impl_name, host_conf)
+            else:
+                raise ValueError(f"{user_config.backend.type} backend does not support implementation '{impl_name}'")
+
+        else:
+            raise TypeError(f"Unknown instance type: {type(self.backend_instance)}")

kotonebot/kaa/metadata.py

@@ -1,6 +1,33 @@
 WHATS_NEW = """
 # 更新日志
 ## kaa
+### v2025.6.23.0
+脚本：
+* [新增] 优化了培育开始的逻辑，修复若干 bug（#86313ec）
+
+框架：
+* [修复] 修复由于分离 AndroidDevice 方法导致的 typing 问题（#4d76e1a）
+* [重构] 将 Commandable 分离为 WindowsCommandable 与 AndroidCommandable（#16a267d）
+* [重构] 将启动 remote_server 的逻辑移动到 kaa cli 中（#b8b5ba8）
+* [重构] 提取三个 adb-based 截图方法的工厂函数的共同部分（#bd57dc4）
+* [重构] 将创建设备的逻辑从 init_context 中移除（#f2599e6）
+* [重构] 重构 Device 与 Impl 的创建方式（#2fc9ad5）
+
+其他：
+* [其他] 更新上游 submodules（#810c341）
+
+### v2025.6.8.0
+脚本：
+* [新增] 新增支持自动禁用与恢复 Gakumasu Localify 汉化插件（#264dac2）
+* [修复] 修复外出事件中可用按钮数量小于 2 导致的下标越界问题（#2452c8c）
+* [修复] 尝试修复第一次领取饮料有几率卡住的问题（#7f2e588）
+
+框架：
+* [新增] 新增全局暂停脚本执行功能（#a8e1f0d）
+
+其他：
+* [其他] 新增开源协议与免责声明（#733aa6a）
+
 ### v2025.5.23.3
 脚本：
 * [修复] 尝试修复行动页有时进入行动失效的问题（#5901771）