ksaa 2025.5.23.2__py3-none-any.whl → 2025.6.8.0__py3-none-any.whl

kotonebot/backend/bot.py

@@ -32,7 +32,7 @@ class RunStatus:
     callstack: list[Task | Action] = field(default_factory=list)
 
     def interrupt(self):
-        vars.interrupted.set()
+        vars.flow.request_interrupt()
 
 # Modified from https://stackoverflow.com/questions/70982565/how-do-i-make-an-event-listener-with-decorators-in-python
 Params = ParamSpec('Params')
@@ -158,7 +158,7 @@ class KotoneBot:
         d = self._on_create_device()
         init_context(config_path=self.config_path, config_type=self.config_type, target_device=d)
         self._on_after_init_context()
-        vars.interrupted.clear()
+        vars.flow.clear_interrupt()
 
         if by_priority:
             tasks = sorted(tasks, key=lambda x: x.priority, reverse=True)
@@ -180,7 +180,7 @@ class KotoneBot:
                     logger.exception('Keyboard interrupt detected.')
                     for task1 in tasks[tasks.index(task):]:
                         self.events.task_status_changed.trigger(task1, 'cancelled')
-                    vars.interrupted.clear()
+                    vars.flow.clear_interrupt()
                     break
                 # 其他错误
                 except Exception as e:

kotonebot/backend/context/context.py

@@ -3,6 +3,7 @@ import re
 import time
 import logging
 import warnings
+import threading
 from datetime import datetime
 from threading import Event
 from typing import (
@@ -25,6 +26,7 @@ import cv2
 from cv2.typing import MatLike
 
 from kotonebot.client.device import Device
+from kotonebot.backend.flow_controller import FlowController
 import kotonebot.backend.image as raw_image
 from kotonebot.backend.image import (
     TemplateMatchResult,
@@ -126,8 +128,7 @@ def interruptible(func: Callable[P, T]) -> Callable[P, T]:
     """
     def _decorator(*args: P.args, **kwargs: P.kwargs) -> T:
         global vars
-        if vars.interrupted.is_set():
-            raise KeyboardInterrupt("User requested interrupt.")
+        vars.flow.check()
         return func(*args, **kwargs)
     return _decorator
 
@@ -145,15 +146,13 @@ def interruptible_class(cls: Type[T]) -> Type[T]:
 
 def sleep(seconds: float, /):
     """
-    可中断的 sleep 函数。
+    可中断和可暂停的 sleep 函数。
 
     建议使用本函数代替 `time.sleep()`，
-    这样能以最快速度响应用户请求中断。
+    这样能以最快速度响应用户请求中断和暂停。
     """
     global vars
-    vars.interrupted.wait(timeout=seconds)
-    if vars.interrupted.is_set():
-        raise KeyboardInterrupt("User requested interrupt.")
+    vars.flow.sleep(seconds)
 
 def warn_manual_screenshot_mode(name: str, alternative: str):
     """
@@ -175,8 +174,8 @@ def is_manual_screenshot_mode() -> bool:
 class ContextGlobalVars:
     def __init__(self):
         self.__vars = dict[str, Any]()
-        self.interrupted: Event = Event()
-        """用户请求中断事件"""
+        self.flow: FlowController = FlowController()
+        """流程控制器，负责停止、暂停、恢复等操作"""
 
     def __getitem__(self, key: str) -> Any:
         return self.__vars[key]
@@ -198,6 +197,17 @@ class ContextGlobalVars:
 
     def clear(self):
         self.__vars.clear()
+        self.flow.reset()  # 重置流程控制器
+
+def check_flow_control():
+    """
+    统一的流程控制检查函数。
+
+    检查用户是否请求中断或暂停，如果是则相应处理：
+    - 如果请求中断，抛出 KeyboardInterrupt 异常
+    - 如果请求暂停，等待直到恢复
+    """
+    vars.flow.check()
 
 class ContextStackVars:
     stack: list['ContextStackVars'] = []
@@ -716,6 +726,7 @@ class ContextDevice(Device):
         """
         截图。返回截图数据，同时更新当前上下文的截图数据。
         """
+        check_flow_control()
         global next_wait, last_screenshot_time, next_wait_time
         current = ContextStackVars.ensure_current()
         if force:
@@ -950,5 +961,4 @@ def manual_context(screenshot_mode: ScreenshotMode = 'auto') -> ManualContextMan
     默认情况下，Context* 类仅允许在 @task/@action 函数中使用。
     如果想要在其他地方使用，使用此函数手动创建一个上下文。
     """
-    return ManualContextManager(screenshot_mode)
-
+    return ManualContextManager(screenshot_mode)

kotonebot/backend/debug/server.py

@@ -115,7 +115,7 @@ async def run_code(request: RunCodeRequest):
         except KeyboardInterrupt as e:
             result = {"status": "error", "result": stdout.getvalue(), "message": str(e), "traceback": traceback.format_exc()}
         finally:
-            context_vars.interrupted.clear()
+            context_vars.flow.clear_interrupt()
         event.set()
     threading.Thread(target=_runner, daemon=True).start()
     await event.wait()
@@ -124,8 +124,8 @@ async def run_code(request: RunCodeRequest):
 @app.get("/api/code/stop")
 async def stop_code():
     from kotonebot.backend.context import vars
-    vars.interrupted.set()
-    while vars.interrupted.is_set():
+    vars.flow.request_interrupt()
+    while vars.flow.is_interrupted:
         await asyncio.sleep(0.1)
     return {"status": "ok"}
 

kotonebot/backend/flow_controller.py

@@ -0,0 +1,195 @@
+import time
+import logging
+import threading
+from typing import Literal
+
+logger = logging.getLogger(__name__)
+
+class FlowController:
+    """
+    一个用于控制任务执行流程（如停止、暂停、恢复）的类。
+
+    这个类是线程安全的，提供了以下功能：
+
+    * 停止任务执行（通过中断信号）
+    * 暂停/恢复任务执行
+    * 可中断和可暂停的 sleep 功能
+    * 流程状态检查
+
+    使用方法::
+
+        controller = FlowController()
+
+        # 在任务的关键路径上调用检查
+        controller.check()
+
+        # 使用可控制的 sleep
+        controller.sleep(1.0)
+
+        # 外部控制
+        controller.request_pause()  # 暂停
+        controller.request_resume()  # 恢复
+        controller.request_stop()   # 停止
+    """
+    
+    def __init__(self):
+        self.interrupt_event: threading.Event = threading.Event()
+        """中断事件，用于停止任务"""
+
+        self.paused: bool = False
+        """暂停标志"""
+
+        self.pause_condition: threading.Condition = threading.Condition()
+        """暂停条件变量，用于线程间同步"""
+    
+    def check(self) -> None:
+        """
+        检查当前流程状态。
+
+        如果收到停止请求，则抛出 KeyboardInterrupt 异常。
+        如果收到暂停请求，则阻塞直到恢复。
+
+        这是核心的检查点方法，应在任务的关键路径上（如循环或等待前）调用。
+
+        :raises KeyboardInterrupt: 当收到停止请求时
+        """
+        # 优先检查中断信号
+        if self.interrupt_event.is_set():
+            raise KeyboardInterrupt("User requested interrupt.")
+        
+        # 检查暂停状态
+        with self.pause_condition:
+            while self.paused:
+                self.pause_condition.wait()
+    
+    def sleep(self, seconds: float) -> None:
+        """
+        一个可被中断和暂停的 sleep 方法。
+
+        与标准的 time.sleep() 不同，这个方法会响应停止和暂停请求。
+        在暂停状态下，计时器会暂停，恢复后继续计时。
+
+        :param seconds: 睡眠时间（秒）
+        :raises KeyboardInterrupt: 当收到停止请求时
+        """
+        with self.pause_condition:
+            end_time = time.time() + seconds
+            while True:
+                self.check()  # 每次循环都检查状态
+                remaining = end_time - time.time()
+                if remaining <= 0:
+                    break
+                # 等待指定时间或直到被唤醒
+                self.pause_condition.wait(timeout=remaining)
+        
+        # 结束后再次检查状态
+        self.check()
+    
+    def request_interrupt(self) -> None:
+        """
+        请求停止任务。
+
+        设置中断信号，所有正在执行的任务将在下一个检查点停止。
+        停止的优先级高于暂停。
+        """
+        logger.info('Interrupt requested.')
+        self.interrupt_event.set()
+    
+    def request_pause(self) -> None:
+        """
+        请求暂停任务。
+
+        设置暂停标志，所有正在执行的任务将在下一个检查点暂停。
+        如果任务已经暂停，此操作无效果。
+        """
+        with self.pause_condition:
+            if not self.paused:
+                logger.info('Pause requested.')
+                self.paused = True
+    
+    def request_resume(self) -> None:
+        """
+        请求恢复任务。
+
+        清除暂停标志并通知所有等待的线程恢复执行。
+        如果任务没有暂停，此操作无效果。
+        """
+        with self.pause_condition:
+            if self.paused:
+                logger.info('Resume requested.')
+                self.paused = False
+                self.pause_condition.notify_all()
+    
+    def toggle_pause(self) -> bool:
+        """
+        切换暂停/恢复状态。
+
+        :returns: 操作后的暂停状态。True 表示已暂停，False 表示已恢复。
+        """
+        with self.pause_condition:
+            logger.info('Pause toggled.')
+            if self.paused:
+                self.paused = False
+                self.pause_condition.notify_all()
+                return False
+            else:
+                self.paused = True
+                return True
+    
+    def clear_interrupt(self) -> None:
+        """
+        清除中断信号。
+
+        用于任务正常结束或重启时重置状态。
+        通常在开始新任务前调用。
+        """
+        self.interrupt_event.clear()
+        logger.info('Interrupt cleared.')
+    
+    def reset(self) -> None:
+        """
+        重置流程控制器到初始状态。
+
+        清除所有信号和状态，相当于重新创建一个新的控制器。
+        """
+        self.interrupt_event.clear()
+        with self.pause_condition:
+            if self.paused:
+                self.paused = False
+                self.pause_condition.notify_all()
+        logger.info('FlowController reset.')
+    
+    @property
+    def is_interrupted(self) -> bool:
+        """
+        检查是否收到中断请求。
+
+        :returns: True 表示已收到中断请求
+        """
+        return self.interrupt_event.is_set()
+    
+    @property
+    def is_paused(self) -> bool:
+        """
+        检查是否处于暂停状态。
+
+        :returns: True 表示当前处于暂停状态
+        """
+        return self.paused
+    
+    @property
+    def status(self) -> Literal['running', 'paused', 'interrupted']:
+        """
+        获取当前状态的字符串描述。
+
+        :returns: 状态描述，可能的值：'running', 'paused', 'interrupted'
+        """
+        if self.is_interrupted:
+            return 'interrupted'
+        elif self.is_paused:
+            return 'paused'
+        else:
+            return 'running'
+    
+    def __repr__(self) -> str:
+        return f"FlowController(status='{self.status}')"

kotonebot/client/implements/windows.py

@@ -7,7 +7,7 @@ import cv2
 import win32ui
 import win32gui
 import numpy as np
-from ahk import AHK
+from ahk import AHK, MsgBoxIcon
 from cv2.typing import MatLike
 
 from ..device import Device
@@ -19,14 +19,26 @@ class WindowsImpl(Touchable, Screenshotable):
         # TODO: 硬编码路径
         self.ahk = AHK(executable_path=str(resources.files('kaa.res.bin') / 'AutoHotkey.exe'))
         self.device = device
-        self.emergency = False
 
         # 设置 DPI aware，否则高缩放显示器上返回的坐标会错误
         windll.user32.SetProcessDPIAware()
-        def toggle_emergency():
-            self.emergency = True
-            self.ahk.msg_box('已启用紧急暂停模式')
-        self.ahk.add_hotkey('^F4', toggle_emergency)
+        # TODO: 这个应该移动到其他地方去
+        def _stop():
+            from kotonebot.backend.context.context import vars
+            vars.flow.request_interrupt()
+            self.ahk.msg_box('任务已停止。', title='琴音小助手', icon=MsgBoxIcon.EXCLAMATION)
+
+        def _toggle_pause():
+            from kotonebot.backend.context.context import vars
+            if vars.flow.is_paused:
+                self.ahk.msg_box('任务即将恢复。\n关闭此消息框后将会继续执行', title='琴音小助手', icon=MsgBoxIcon.EXCLAMATION)
+                vars.flow.request_resume()
+            else:
+                vars.flow.request_pause()
+                self.ahk.msg_box('任务已暂停。\n关闭此消息框后再按一次快捷键恢复执行。', title='琴音小助手', icon=MsgBoxIcon.EXCLAMATION)
+
+        self.ahk.add_hotkey('^F4', _toggle_pause) # Ctrl+F4 暂停/恢复
+        self.ahk.add_hotkey('^F3', _stop)  # Ctrl+F3 停止
         self.ahk.start_hotkeys()
         # 将点击坐标设置为相对 Client
         self.ahk.set_coord_mode('Mouse', 'Client')
@@ -60,11 +72,6 @@ class WindowsImpl(Touchable, Screenshotable):
         """将 Client 区域坐标转换为屏幕坐标"""
         return win32gui.ClientToScreen(hwnd, (x, y))
 
-    def __wait_not_emergency(self):
-        from time import sleep # TODO: 改为 kotonebot.backend.context.sleep
-        while self.emergency:
-            sleep(0.2)
-
     def screenshot(self) -> MatLike:
         if not self.ahk.win_is_active('gakumas'):
             self.ahk.win_activate('gakumas')
@@ -133,7 +140,6 @@ class WindowsImpl(Touchable, Screenshotable):
             return 'portrait'
 
     def click(self, x: int, y: int) -> None:
-        self.__wait_not_emergency()
         # x, y = self.__client_to_screen(self.hwnd, x, y)
         # (0, 0) 很可能会点到窗口边框上
         if x == 0:
@@ -146,7 +152,6 @@ class WindowsImpl(Touchable, Screenshotable):
         self.ahk.click(x, y)
 
     def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float | None = None) -> None:
-        self.__wait_not_emergency()
         if not self.ahk.win_is_active('gakumas'):
             self.ahk.win_activate('gakumas')
         x1, y1 = int(x1 / self.scale_ratio), int(y1 / self.scale_ratio)

kotonebot/kaa/common.py

@@ -425,6 +425,20 @@ class StartGameConfig(ConfigBaseModel):
 
     kuyo_package_name: str = 'org.kuyo.game'
     """Kuyo包名"""
+    
+    disable_gakumas_localify: bool = False
+    """
+    自动检测并禁用 Gakumas Localify 汉化插件。
+    
+    （目前仅对 DMM 版有效。）
+    """
+    
+    dmm_game_path: str | None = None
+    """
+    DMM 版游戏路径。若不填写，会自动检测。
+    
+    例：`F:\\Games\\gakumas\\gakumas.exe`
+    """
 
 class EndGameConfig(ConfigBaseModel):
     exit_kaa: bool = False
@@ -439,6 +453,13 @@ class EndGameConfig(ConfigBaseModel):
     """关闭系统"""
     hibernate: bool = False
     """休眠系统"""
+    restore_gakumas_localify: bool = False
+    """
+    恢复 Gakumas Localify 汉化插件状态至启动前。通常与
+    `disable_gakumas_localify` 配对使用。
+    
+    （目前仅对 DMM 版有效。）
+    """
 
 class BaseConfig(ConfigBaseModel):
     purchase: PurchaseConfig = PurchaseConfig()