kotonebot 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

kotonebot/client/implements/windows.py

@@ -1,172 +1,176 @@
-# ruff: noqa: E402
-from kotonebot.util import require_windows
-require_windows('"WindowsImpl" implementation')
-
-from ctypes import windll
-from typing import Literal
-from importlib import resources
-from functools import cached_property
-from dataclasses import dataclass
-
-import cv2
-import win32ui
-import win32gui
-import numpy as np
-from ahk import AHK, MsgBoxIcon
-from cv2.typing import MatLike
-
-from ..device import Device, WindowsDevice
-from ..protocol import Commandable, Touchable, Screenshotable
-from ..registration import ImplConfig
-
-# 1. 定义配置模型
-@dataclass
-class WindowsImplConfig(ImplConfig):
-    window_title: str
-    ahk_exe_path: str
-
-class WindowsImpl(Touchable, Screenshotable):
-    def __init__(self, device: Device, window_title: str, ahk_exe_path: str):
-        self.__hwnd: int | None = None
-        self.window_title = window_title
-        self.ahk = AHK(executable_path=ahk_exe_path)
-        self.device = device
-
-        # 设置 DPI aware，否则高缩放显示器上返回的坐标会错误
-        windll.user32.SetProcessDPIAware()
-        # 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')
-
-    @property
-    def hwnd(self) -> int:
-        if self.__hwnd is None:
-            self.__hwnd = win32gui.FindWindow(None, self.window_title)
-            if self.__hwnd is None or self.__hwnd == 0:
-                raise RuntimeError(f'Failed to find window: {self.window_title}')
-        return self.__hwnd
-
-    def __client_rect(self) -> tuple[int, int, int, int]:
-        """获取 Client 区域屏幕坐标"""
-        hwnd = self.hwnd
-        client_left, client_top, client_right, client_bottom = win32gui.GetClientRect(hwnd)
-        client_left, client_top = win32gui.ClientToScreen(hwnd, (client_left, client_top))
-        client_right, client_bottom = win32gui.ClientToScreen(hwnd, (client_right, client_bottom))
-        return client_left, client_top, client_right, client_bottom
-
-    def __client_to_screen(self, hwnd: int, x: int, y: int) -> tuple[int, int]:
-        """将 Client 区域坐标转换为屏幕坐标"""
-        return win32gui.ClientToScreen(hwnd, (x, y))
-
-    def screenshot(self) -> MatLike:
-        if not self.ahk.win_is_active(self.window_title):
-            self.ahk.win_activate(self.window_title)
-        hwnd = self.hwnd
-
-        # TODO: 需要检查下面这些 WinAPI 的返回结果
-        # 获取整个窗口的坐标
-        left, top, right, bot = win32gui.GetWindowRect(hwnd)
-        w = right - left
-        h = bot - top
-
-        # 获取客户区域的坐标
-        client_left, client_top, client_right, client_bot = self.__client_rect()
-
-        # 获取整个屏幕的截图
-        hwndDC = win32gui.GetWindowDC(0)
-        mfcDC = win32ui.CreateDCFromHandle(hwndDC)
-        saveDC = mfcDC.CreateCompatibleDC()
-
-        saveBitMap = win32ui.CreateBitmap()
-        saveBitMap.CreateCompatibleBitmap(mfcDC, w, h)
-
-        saveDC.SelectObject(saveBitMap)
-
-        # 截图整个屏幕
-        result = windll.gdi32.BitBlt(saveDC.GetSafeHdc(), 0, 0, w, h, mfcDC.GetSafeHdc(), left, top, 0x00CC0020)
-
-        # 将截图转换为OpenCV格式
-        bmpinfo = saveBitMap.GetInfo()
-        bmpstr = saveBitMap.GetBitmapBits(True)
-        im = np.frombuffer(bmpstr, dtype=np.uint8)
-        im = im.reshape((bmpinfo['bmHeight'], bmpinfo['bmWidth'], 4))
-
-        # 裁剪出客户区域
-        cropped_im = im[client_top - top:client_bot - top, client_left - left:client_right - left]
-
-        # 释放资源
-        win32gui.DeleteObject(saveBitMap.GetHandle())
-        saveDC.DeleteDC()
-        mfcDC.DeleteDC()
-        win32gui.ReleaseDC(hwnd, hwndDC)
-
-        # 将 RGBA 转换为 RGB
-        cropped_im = cv2.cvtColor(cropped_im, cv2.COLOR_RGBA2RGB)
-        return cropped_im
-
-    @property
-    def screen_size(self) -> tuple[int, int]:
-        left, top, right, bot = self.__client_rect()
-        w = right - left
-        h = bot - top
-        return w, h
-
-    def detect_orientation(self) -> None | Literal['portrait'] | Literal['landscape']:
-        pos = self.ahk.win_get_position(self.window_title)
-        if pos is None:
-            return None
-        w, h = pos.width, pos.height
-        if w > h:
-            return 'landscape'
-        else:
-            return 'portrait'
-
-    def click(self, x: int, y: int) -> None:
-        # x, y = self.__client_to_screen(self.hwnd, x, y)
-        # (0, 0) 很可能会点到窗口边框上
-        if x == 0:
-            x = 2
-        if y == 0:
-            y = 2
-        if not self.ahk.win_is_active(self.window_title):
-            self.ahk.win_activate(self.window_title)
-        self.ahk.click(x, y)
-
-    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float | None = None) -> None:
-        if not self.ahk.win_is_active(self.window_title):
-            self.ahk.win_activate(self.window_title)
-        # TODO: 这个 speed 的单位是什么？
-        self.ahk.mouse_drag(x2, y2, from_position=(x1, y1), coord_mode='Client', speed=10)
-
-if __name__ == '__main__':
-    from ..device import Device
-    device = Device()
-    # 在测试环境中直接使用默认路径
-    ahk_path = str(resources.files('kaa.res.bin') / 'AutoHotkey.exe')
-    impl = WindowsImpl(device, window_title='gakumas', ahk_exe_path=ahk_path)
-    device._screenshot = impl
-    device._touch = impl
-    device.swipe_scaled(0.5, 0.8, 0.5, 0.2)
-    # impl.swipe(0, 100, 0, 0)
-    # impl.click(100, 100)
-    # while True:
-    #     im = impl.screenshot()
-    #     cv2.imshow('test', im)
-    #     cv2.waitKey(1)
+# ruff: noqa: E402
+from kotonebot.util import require_windows
+require_windows('"WindowsImpl" implementation')
+
+from ctypes import windll
+from typing import Literal
+from importlib import resources
+from functools import cached_property
+from dataclasses import dataclass
+
+import cv2
+import numpy as np
+try:
+    import win32ui
+    import win32gui
+    from ahk import AHK, MsgBoxIcon
+except ImportError as _e:
+    from kotonebot.errors import MissingDependencyError
+    raise MissingDependencyError(_e, 'windows')
+from cv2.typing import MatLike
+
+from ..device import Device, WindowsDevice
+from ..protocol import Commandable, Touchable, Screenshotable
+from ..registration import ImplConfig
+
+# 1. 定义配置模型
+@dataclass
+class WindowsImplConfig(ImplConfig):
+    window_title: str
+    ahk_exe_path: str
+
+class WindowsImpl(Touchable, Screenshotable):
+    def __init__(self, device: Device, window_title: str, ahk_exe_path: str):
+        self.__hwnd: int | None = None
+        self.window_title = window_title
+        self.ahk = AHK(executable_path=ahk_exe_path)
+        self.device = device
+
+        # 设置 DPI aware，否则高缩放显示器上返回的坐标会错误
+        windll.user32.SetProcessDPIAware()
+        # 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')
+
+    @property
+    def hwnd(self) -> int:
+        if self.__hwnd is None:
+            self.__hwnd = win32gui.FindWindow(None, self.window_title)
+            if self.__hwnd is None or self.__hwnd == 0:
+                raise RuntimeError(f'Failed to find window: {self.window_title}')
+        return self.__hwnd
+
+    def __client_rect(self) -> tuple[int, int, int, int]:
+        """获取 Client 区域屏幕坐标"""
+        hwnd = self.hwnd
+        client_left, client_top, client_right, client_bottom = win32gui.GetClientRect(hwnd)
+        client_left, client_top = win32gui.ClientToScreen(hwnd, (client_left, client_top))
+        client_right, client_bottom = win32gui.ClientToScreen(hwnd, (client_right, client_bottom))
+        return client_left, client_top, client_right, client_bottom
+
+    def __client_to_screen(self, hwnd: int, x: int, y: int) -> tuple[int, int]:
+        """将 Client 区域坐标转换为屏幕坐标"""
+        return win32gui.ClientToScreen(hwnd, (x, y))
+
+    def screenshot(self) -> MatLike:
+        if not self.ahk.win_is_active(self.window_title):
+            self.ahk.win_activate(self.window_title)
+        hwnd = self.hwnd
+
+        # TODO: 需要检查下面这些 WinAPI 的返回结果
+        # 获取整个窗口的坐标
+        left, top, right, bot = win32gui.GetWindowRect(hwnd)
+        w = right - left
+        h = bot - top
+
+        # 获取客户区域的坐标
+        client_left, client_top, client_right, client_bot = self.__client_rect()
+
+        # 获取整个屏幕的截图
+        hwndDC = win32gui.GetWindowDC(0)
+        mfcDC = win32ui.CreateDCFromHandle(hwndDC)
+        saveDC = mfcDC.CreateCompatibleDC()
+
+        saveBitMap = win32ui.CreateBitmap()
+        saveBitMap.CreateCompatibleBitmap(mfcDC, w, h)
+
+        saveDC.SelectObject(saveBitMap)
+
+        # 截图整个屏幕
+        result = windll.gdi32.BitBlt(saveDC.GetSafeHdc(), 0, 0, w, h, mfcDC.GetSafeHdc(), left, top, 0x00CC0020)
+
+        # 将截图转换为OpenCV格式
+        bmpinfo = saveBitMap.GetInfo()
+        bmpstr = saveBitMap.GetBitmapBits(True)
+        im = np.frombuffer(bmpstr, dtype=np.uint8)
+        im = im.reshape((bmpinfo['bmHeight'], bmpinfo['bmWidth'], 4))
+
+        # 裁剪出客户区域
+        cropped_im = im[client_top - top:client_bot - top, client_left - left:client_right - left]
+
+        # 释放资源
+        win32gui.DeleteObject(saveBitMap.GetHandle())
+        saveDC.DeleteDC()
+        mfcDC.DeleteDC()
+        win32gui.ReleaseDC(hwnd, hwndDC)
+
+        # 将 RGBA 转换为 RGB
+        cropped_im = cv2.cvtColor(cropped_im, cv2.COLOR_RGBA2RGB)
+        return cropped_im
+
+    @property
+    def screen_size(self) -> tuple[int, int]:
+        left, top, right, bot = self.__client_rect()
+        w = right - left
+        h = bot - top
+        return w, h
+
+    def detect_orientation(self) -> None | Literal['portrait'] | Literal['landscape']:
+        pos = self.ahk.win_get_position(self.window_title)
+        if pos is None:
+            return None
+        w, h = pos.width, pos.height
+        if w > h:
+            return 'landscape'
+        else:
+            return 'portrait'
+
+    def click(self, x: int, y: int) -> None:
+        # x, y = self.__client_to_screen(self.hwnd, x, y)
+        # (0, 0) 很可能会点到窗口边框上
+        if x == 0:
+            x = 2
+        if y == 0:
+            y = 2
+        if not self.ahk.win_is_active(self.window_title):
+            self.ahk.win_activate(self.window_title)
+        self.ahk.click(x, y)
+
+    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float | None = None) -> None:
+        if not self.ahk.win_is_active(self.window_title):
+            self.ahk.win_activate(self.window_title)
+        # TODO: 这个 speed 的单位是什么？
+        self.ahk.mouse_drag(x2, y2, from_position=(x1, y1), coord_mode='Client', speed=10)
+
+if __name__ == '__main__':
+    from ..device import Device
+    device = Device()
+    # 在测试环境中直接使用默认路径
+    ahk_path = str(resources.files('kaa.res.bin') / 'AutoHotkey.exe')
+    impl = WindowsImpl(device, window_title='gakumas', ahk_exe_path=ahk_path)
+    device._screenshot = impl
+    device._touch = impl
+    device.swipe_scaled(0.5, 0.8, 0.5, 0.2)
+    # impl.swipe(0, 100, 0, 0)
+    # impl.click(100, 100)
+    # while True:
+    #     im = impl.screenshot()
+    #     cv2.imshow('test', im)
+    #     cv2.waitKey(1)

kotonebot/client/protocol.py

@@ -1,69 +1,69 @@
-from typing import Protocol, TYPE_CHECKING, runtime_checkable, Literal
-
-from cv2.typing import MatLike
-
-from kotonebot.primitives import Rect
-if TYPE_CHECKING:
-    from .device import Device
-
-@runtime_checkable
-class ClickableObjectProtocol(Protocol):
-    """
-    可点击对象的协议
-    """
-    @property
-    def rect(self) -> Rect:
-        ...
-
-class DeviceScreenshotProtocol(Protocol):
-    def screenshot(self) -> MatLike:
-        """
-        截图
-        """
-        ...
-
-@runtime_checkable
-class Commandable(Protocol):
-    def __init__(self, device: 'Device'): ...
-    def launch_app(self, package_name: str) -> None: ...
-    def current_package(self) -> str | None: ...
-
-@runtime_checkable
-class AndroidCommandable(Protocol):
-    """定义 Android 平台的特定命令"""
-    def launch_app(self, package_name: str) -> None: ...
-    def current_package(self) -> str | None: ...
-    def adb_shell(self, cmd: str) -> str: ...
-
-@runtime_checkable
-class WindowsCommandable(Protocol):
-    """定义 Windows 平台的特定命令"""
-    def get_foreground_window(self) -> tuple[int, str]: ...
-    def exec_command(self, command: str) -> tuple[int, str, str]: ...
-
-@runtime_checkable
-class Screenshotable(Protocol):
-    def __init__(self, device: 'Device'): ...
-    @property
-    def screen_size(self) -> tuple[int, int]:
-        """
-        屏幕尺寸。格式为 `(width, height)`。
-        
-        **注意**： 此属性返回的分辨率会随设备方向变化。
-        如果 `self.orientation` 为 `landscape`，则返回的分辨率是横屏下的分辨率，
-        否则返回竖屏下的分辨率。
-
-        `self.orientation` 属性默认为竖屏。如果需要自动检测，
-        调用 `self.detect_orientation()` 方法。
-        如果已知方向，也可以直接设置 `self.orientation` 属性。
-        """
-        ...
-    
-    def detect_orientation(self) -> Literal['portrait', 'landscape'] | None: ...
-    def screenshot(self) -> MatLike: ...
-
-@runtime_checkable
-class Touchable(Protocol):
-    def __init__(self, device: 'Device'): ...
-    def click(self, x: int, y: int) -> None: ...
-    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float|None = None) -> None: ...
+from typing import Protocol, TYPE_CHECKING, runtime_checkable, Literal
+
+from cv2.typing import MatLike
+
+from kotonebot.primitives import Rect
+if TYPE_CHECKING:
+    from .device import Device
+
+@runtime_checkable
+class ClickableObjectProtocol(Protocol):
+    """
+    可点击对象的协议
+    """
+    @property
+    def rect(self) -> Rect:
+        ...
+
+class DeviceScreenshotProtocol(Protocol):
+    def screenshot(self) -> MatLike:
+        """
+        截图
+        """
+        ...
+
+@runtime_checkable
+class Commandable(Protocol):
+    def __init__(self, device: 'Device'): ...
+    def launch_app(self, package_name: str) -> None: ...
+    def current_package(self) -> str | None: ...
+
+@runtime_checkable
+class AndroidCommandable(Protocol):
+    """定义 Android 平台的特定命令"""
+    def launch_app(self, package_name: str) -> None: ...
+    def current_package(self) -> str | None: ...
+    def adb_shell(self, cmd: str) -> str: ...
+
+@runtime_checkable
+class WindowsCommandable(Protocol):
+    """定义 Windows 平台的特定命令"""
+    def get_foreground_window(self) -> tuple[int, str]: ...
+    def exec_command(self, command: str) -> tuple[int, str, str]: ...
+
+@runtime_checkable
+class Screenshotable(Protocol):
+    def __init__(self, device: 'Device'): ...
+    @property
+    def screen_size(self) -> tuple[int, int]:
+        """
+        屏幕尺寸。格式为 `(width, height)`。
+        
+        **注意**： 此属性返回的分辨率会随设备方向变化。
+        如果 `self.orientation` 为 `landscape`，则返回的分辨率是横屏下的分辨率，
+        否则返回竖屏下的分辨率。
+
+        `self.orientation` 属性默认为竖屏。如果需要自动检测，
+        调用 `self.detect_orientation()` 方法。
+        如果已知方向，也可以直接设置 `self.orientation` 属性。
+        """
+        ...
+    
+    def detect_orientation(self) -> Literal['portrait', 'landscape'] | None: ...
+    def screenshot(self) -> MatLike: ...
+
+@runtime_checkable
+class Touchable(Protocol):
+    def __init__(self, device: 'Device'): ...
+    def click(self, x: int, y: int) -> None: ...
+    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float|None = None) -> None: ...

kotonebot/client/registration.py

@@ -1,24 +1,24 @@
-from dataclasses import dataclass
-from typing import TypeVar, Callable, Dict, Type, Any, overload, Literal, cast, TYPE_CHECKING
-
-from ..errors import KotonebotError
-from .device import Device
-if TYPE_CHECKING:
-    from .implements.adb import AdbImplConfig
-    from .implements.remote_windows import RemoteWindowsImplConfig
-    from .implements.windows import WindowsImplConfig
-    from .implements.nemu_ipc import NemuIpcImplConfig
-
-AdbBasedImpl = Literal['adb', 'adb_raw', 'uiautomator2']
-DeviceImpl = str | AdbBasedImpl | Literal['windows', 'remote_windows', 'nemu_ipc']
-
-# --- 核心类型定义 ---
-
-class ImplRegistrationError(KotonebotError):
-    """与 impl 注册相关的错误"""
-    pass
-
-@dataclass
-class ImplConfig:
-    """所有设备实现配置模型的名义上的基类，便于类型约束。"""
-    pass
+from dataclasses import dataclass
+from typing import TypeVar, Callable, Dict, Type, Any, overload, Literal, cast, TYPE_CHECKING
+
+from ..errors import KotonebotError
+from .device import Device
+if TYPE_CHECKING:
+    from .implements.adb import AdbImplConfig
+    from .implements.remote_windows import RemoteWindowsImplConfig
+    from .implements.windows import WindowsImplConfig
+    from .implements.nemu_ipc import NemuIpcImplConfig
+
+AdbBasedImpl = Literal['adb', 'adb_raw', 'uiautomator2']
+DeviceImpl = str | AdbBasedImpl | Literal['windows', 'remote_windows', 'nemu_ipc']
+
+# --- 核心类型定义 ---
+
+class ImplRegistrationError(KotonebotError):
+    """与 impl 注册相关的错误"""
+    pass
+
+@dataclass
+class ImplConfig:
+    """所有设备实现配置模型的名义上的基类，便于类型约束。"""
+    pass