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

kotonebot/client/implements/remote_windows.py

@@ -1,193 +1,189 @@
-"""
-Remote Windows implementation using XML-RPC.
-
-This module provides:
-1. RemoteWindowsImpl - Client implementation that connects to a remote Windows machine
-2. RemoteWindowsServer - Server implementation that exposes a WindowsImpl instance via XML-RPC
-"""
-
-import io
-import base64
-import logging
-import xmlrpc.client
-import xmlrpc.server
-from typing import Literal, cast, Any, Tuple
-from functools import cached_property
-from threading import Thread
-from dataclasses import dataclass
-
-import cv2
-import numpy as np
-from cv2.typing import MatLike
-
-from kotonebot import logging
-from ..device import Device, WindowsDevice
-from ..protocol import Touchable, Screenshotable
-from ..registration import ImplConfig
-from .windows import WindowsImpl, WindowsImplConfig
-
-logger = logging.getLogger(__name__)
-
-# 定义配置模型
-@dataclass
-class RemoteWindowsImplConfig(ImplConfig):
-    windows_impl_config: WindowsImplConfig
-    host: str = "localhost"
-    port: int = 8000
-
-def _encode_image(image: MatLike) -> str:
-    """Encode an image as a base64 string."""
-    success, buffer = cv2.imencode('.png', image)
-    if not success:
-        raise RuntimeError("Failed to encode image")
-    return base64.b64encode(buffer.tobytes()).decode('ascii')
-
-def _decode_image(encoded_image: str) -> MatLike:
-    """Decode a base64 string to an image."""
-    buffer = base64.b64decode(encoded_image)
-    image = cv2.imdecode(np.frombuffer(buffer, np.uint8), cv2.IMREAD_COLOR)
-    if image is None:
-        raise RuntimeError("Failed to decode image")
-    return image
-
-class RemoteWindowsServer:
-    """
-    XML-RPC server that exposes a WindowsImpl instance.
-
-    This class wraps a WindowsImpl instance and exposes its methods via XML-RPC.
-    """
-
-    def __init__(self, windows_impl_config: WindowsImplConfig, host="localhost", port=8000):
-        """Initialize the server with the given host and port."""
-        self.host = host
-        self.port = port
-        self.server = None
-        self.device = WindowsDevice()
-        self.impl = WindowsImpl(
-            WindowsDevice(),
-            ahk_exe_path=windows_impl_config.ahk_exe_path,
-            window_title=windows_impl_config.window_title
-        )
-        self.device._screenshot = self.impl
-        self.device._touch = self.impl
-
-    def start(self):
-        """Start the XML-RPC server."""
-        self.server = xmlrpc.server.SimpleXMLRPCServer(
-            (self.host, self.port),
-            logRequests=True,
-            allow_none=True
-        )
-        self.server.register_instance(self)
-        logger.info(f"Starting RemoteWindowsServer on {self.host}:{self.port}")
-        self.server.serve_forever()
-
-    def start_in_thread(self):
-        """Start the XML-RPC server in a separate thread."""
-        thread = Thread(target=self.start, daemon=True)
-        thread.start()
-        return thread
-
-    # Screenshotable methods
-
-    def screenshot(self) -> str:
-        """Take a screenshot and return it as a base64-encoded string."""
-        try:
-            image = self.impl.screenshot()
-            return _encode_image(image)
-        except Exception as e:
-            logger.error(f"Error taking screenshot: {e}")
-            raise
-
-    def get_screen_size(self) -> tuple[int, int]:
-        """Get the screen size."""
-        return self.impl.screen_size
-
-    def detect_orientation(self) -> str | None:
-        """Detect the screen orientation."""
-        return self.impl.detect_orientation()
-
-    # Touchable methods
-
-    def click(self, x: int, y: int) -> bool:
-        """Click at the given coordinates."""
-        try:
-            self.impl.click(x, y)
-            return True
-        except Exception as e:
-            logger.error(f"Error clicking at ({x}, {y}): {e}")
-            return False
-
-    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float | None = None) -> bool:
-        """Swipe from (x1, y1) to (x2, y2)."""
-        try:
-            self.impl.swipe(x1, y1, x2, y2, duration)
-            return True
-        except Exception as e:
-            logger.error(f"Error swiping from ({x1}, {y1}) to ({x2}, {y2}): {e}")
-            return False
-
-    # Other methods
-
-    def get_scale_ratio(self) -> float:
-        """Get the scale ratio."""
-        return self.impl.scale_ratio
-
-    def ping(self) -> bool:
-        """Check if the server is alive."""
-        return True
-
-
-class RemoteWindowsImpl(Touchable, Screenshotable):
-    """
-    Client implementation that connects to a remote Windows machine via XML-RPC.
-
-    This class implements the same interfaces as WindowsImpl but forwards all
-    method calls to a remote server.
-    """
-
-    def __init__(self, device: Device, host="localhost", port=8000):
-        """Initialize the client with the given device, host, and port."""
-        self.device = device
-        self.host = host
-        self.port = port
-        self.proxy = xmlrpc.client.ServerProxy(
-            f"http://{host}:{port}/",
-            allow_none=True
-        )
-        # Test connection
-        try:
-            if not self.proxy.ping():
-                raise ConnectionError(f"Failed to connect to RemoteWindowsServer at {host}:{port}")
-            logger.info(f"Connected to RemoteWindowsServer at {host}:{port}")
-        except Exception as e:
-            raise ConnectionError(f"Failed to connect to RemoteWindowsServer at {host}:{port}: {e}")
-
-    @cached_property
-    def scale_ratio(self) -> float:
-        """Get the scale ratio from the remote server."""
-        return cast(float, self.proxy.get_scale_ratio())
-
-    @property
-    def screen_size(self) -> tuple[int, int]:
-        """Get the screen size from the remote server."""
-        return cast(Tuple[int, int], self.proxy.get_screen_size())
-
-    def detect_orientation(self) -> None | Literal['portrait'] | Literal['landscape']:
-        """Detect the screen orientation from the remote server."""
-        return cast(None | Literal['portrait'] | Literal['landscape'], self.proxy.detect_orientation())
-
-    def screenshot(self) -> MatLike:
-        """Take a screenshot from the remote server."""
-        encoded_image = cast(str, self.proxy.screenshot())
-        return _decode_image(encoded_image)
-
-    def click(self, x: int, y: int) -> None:
-        """Click at the given coordinates on the remote server."""
-        if not self.proxy.click(x, y):
-            raise RuntimeError(f"Failed to click at ({x}, {y})")
-
-    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float | None = None) -> None:
-        """Swipe from (x1, y1) to (x2, y2) on the remote server."""
-        if not self.proxy.swipe(x1, y1, x2, y2, duration):
+# ruff: noqa: E402
+from kotonebot.util import require_windows
+require_windows('"RemoteWindowsImpl" implementation')
+
+import io
+import base64
+import logging
+import xmlrpc.client
+import xmlrpc.server
+from typing import Literal, cast, Any, Tuple
+from functools import cached_property
+from threading import Thread
+from dataclasses import dataclass
+
+import cv2
+import numpy as np
+from cv2.typing import MatLike
+
+from kotonebot import logging
+from ..device import Device, WindowsDevice
+from ..protocol import Touchable, Screenshotable
+from ..registration import ImplConfig
+from .windows import WindowsImpl, WindowsImplConfig
+
+logger = logging.getLogger(__name__)
+
+# 定义配置模型
+@dataclass
+class RemoteWindowsImplConfig(ImplConfig):
+    windows_impl_config: WindowsImplConfig
+    host: str = "localhost"
+    port: int = 8000
+
+def _encode_image(image: MatLike) -> str:
+    """Encode an image as a base64 string."""
+    success, buffer = cv2.imencode('.png', image)
+    if not success:
+        raise RuntimeError("Failed to encode image")
+    return base64.b64encode(buffer.tobytes()).decode('ascii')
+
+def _decode_image(encoded_image: str) -> MatLike:
+    """Decode a base64 string to an image."""
+    buffer = base64.b64decode(encoded_image)
+    image = cv2.imdecode(np.frombuffer(buffer, np.uint8), cv2.IMREAD_COLOR)
+    if image is None:
+        raise RuntimeError("Failed to decode image")
+    return image
+
+class RemoteWindowsServer:
+    """
+    XML-RPC server that exposes a WindowsImpl instance.
+
+    This class wraps a WindowsImpl instance and exposes its methods via XML-RPC.
+    """
+
+    def __init__(self, windows_impl_config: WindowsImplConfig, host="localhost", port=8000):
+        """Initialize the server with the given host and port."""
+        self.host = host
+        self.port = port
+        self.server = None
+        self.device = WindowsDevice()
+        self.impl = WindowsImpl(
+            WindowsDevice(),
+            ahk_exe_path=windows_impl_config.ahk_exe_path,
+            window_title=windows_impl_config.window_title
+        )
+        self.device._screenshot = self.impl
+        self.device._touch = self.impl
+
+    def start(self):
+        """Start the XML-RPC server."""
+        self.server = xmlrpc.server.SimpleXMLRPCServer(
+            (self.host, self.port),
+            logRequests=True,
+            allow_none=True
+        )
+        self.server.register_instance(self)
+        logger.info(f"Starting RemoteWindowsServer on {self.host}:{self.port}")
+        self.server.serve_forever()
+
+    def start_in_thread(self):
+        """Start the XML-RPC server in a separate thread."""
+        thread = Thread(target=self.start, daemon=True)
+        thread.start()
+        return thread
+
+    # Screenshotable methods
+
+    def screenshot(self) -> str:
+        """Take a screenshot and return it as a base64-encoded string."""
+        try:
+            image = self.impl.screenshot()
+            return _encode_image(image)
+        except Exception as e:
+            logger.error(f"Error taking screenshot: {e}")
+            raise
+
+    def get_screen_size(self) -> tuple[int, int]:
+        """Get the screen size."""
+        return self.impl.screen_size
+
+    def detect_orientation(self) -> str | None:
+        """Detect the screen orientation."""
+        return self.impl.detect_orientation()
+
+    # Touchable methods
+
+    def click(self, x: int, y: int) -> bool:
+        """Click at the given coordinates."""
+        try:
+            self.impl.click(x, y)
+            return True
+        except Exception as e:
+            logger.error(f"Error clicking at ({x}, {y}): {e}")
+            return False
+
+    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float | None = None) -> bool:
+        """Swipe from (x1, y1) to (x2, y2)."""
+        try:
+            self.impl.swipe(x1, y1, x2, y2, duration)
+            return True
+        except Exception as e:
+            logger.error(f"Error swiping from ({x1}, {y1}) to ({x2}, {y2}): {e}")
+            return False
+
+    # Other methods
+
+    def get_scale_ratio(self) -> float:
+        """Get the scale ratio."""
+        return self.impl.scale_ratio
+
+    def ping(self) -> bool:
+        """Check if the server is alive."""
+        return True
+
+
+class RemoteWindowsImpl(Touchable, Screenshotable):
+    """
+    Client implementation that connects to a remote Windows machine via XML-RPC.
+
+    This class implements the same interfaces as WindowsImpl but forwards all
+    method calls to a remote server.
+    """
+
+    def __init__(self, device: Device, host="localhost", port=8000):
+        """Initialize the client with the given device, host, and port."""
+        self.device = device
+        self.host = host
+        self.port = port
+        self.proxy = xmlrpc.client.ServerProxy(
+            f"http://{host}:{port}/",
+            allow_none=True
+        )
+        # Test connection
+        try:
+            if not self.proxy.ping():
+                raise ConnectionError(f"Failed to connect to RemoteWindowsServer at {host}:{port}")
+            logger.info(f"Connected to RemoteWindowsServer at {host}:{port}")
+        except Exception as e:
+            raise ConnectionError(f"Failed to connect to RemoteWindowsServer at {host}:{port}: {e}")
+
+    @cached_property
+    def scale_ratio(self) -> float:
+        """Get the scale ratio from the remote server."""
+        return cast(float, self.proxy.get_scale_ratio())
+
+    @property
+    def screen_size(self) -> tuple[int, int]:
+        """Get the screen size from the remote server."""
+        return cast(Tuple[int, int], self.proxy.get_screen_size())
+
+    def detect_orientation(self) -> None | Literal['portrait'] | Literal['landscape']:
+        """Detect the screen orientation from the remote server."""
+        return cast(None | Literal['portrait'] | Literal['landscape'], self.proxy.detect_orientation())
+
+    def screenshot(self) -> MatLike:
+        """Take a screenshot from the remote server."""
+        encoded_image = cast(str, self.proxy.screenshot())
+        return _decode_image(encoded_image)
+
+    def click(self, x: int, y: int) -> None:
+        """Click at the given coordinates on the remote server."""
+        if not self.proxy.click(x, y):
+            raise RuntimeError(f"Failed to click at ({x}, {y})")
+
+    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float | None = None) -> None:
+        """Swipe from (x1, y1) to (x2, y2) on the remote server."""
+        if not self.proxy.swipe(x1, y1, x2, y2, duration):
             raise RuntimeError(f"Failed to swipe from ({x1}, {y1}) to ({x2}, {y2})")

kotonebot/client/implements/uiautomator2.py

@@ -1,82 +1,86 @@
-import time
-from typing import Literal
-
-import numpy as np
-import uiautomator2 as u2
-from cv2.typing import MatLike
-from adbutils._device import AdbDevice as AdbUtilsDevice
-
-from kotonebot import logging
-from ..device import Device
-from ..protocol import Screenshotable, Commandable, Touchable
-
-logger = logging.getLogger(__name__)
-
-SCREENSHOT_INTERVAL = 0.2
-
-class UiAutomator2Impl(Screenshotable, Commandable, Touchable):
-    def __init__(self, adb_connection: AdbUtilsDevice):
-        self.u2_client = u2.Device(adb_connection.serial)
-        self.__last_screenshot_time = 0
-        
-    def screenshot(self) -> MatLike:
-        """
-        截图
-        """
-        from kotonebot import sleep
-        delta = time.time() - self.__last_screenshot_time
-        if delta < SCREENSHOT_INTERVAL:
-            time.sleep(SCREENSHOT_INTERVAL - delta)
-        start_time = time.time()
-        image = self.u2_client.screenshot(format='opencv')
-        logger.verbose(f'uiautomator2 screenshot: {time.time() - start_time}s')
-        self.__last_screenshot_time = time.time()
-        assert isinstance(image, np.ndarray)
-        return image
-    
-    @property
-    def screen_size(self) -> tuple[int, int]:
-        info = self.u2_client.info
-        sizes = info['displayWidth'], info['displayHeight']
-        return sizes
-    
-    def detect_orientation(self) -> Literal['portrait', 'landscape'] | None:
-        """
-        检测设备方向
-        """
-        orientation = self.u2_client.info['displayRotation']
-        if orientation == 1:
-            return 'portrait'
-        elif orientation == 0:
-            return 'landscape'
-        else:
-            return None
-    
-    def launch_app(self, package_name: str) -> None:
-        """
-        启动应用
-        """
-        self.u2_client.app_start(package_name)
-        
-    def current_package(self) -> str | None:
-        """
-        获取当前应用包名
-        """
-        try:
-            result = self.u2_client.app_current()
-            logger.verbose(f'uiautomator2 current_package: {result}')
-            return result['package']
-        except:
-            return None
-        
-    def click(self, x: int, y: int) -> None:
-        """
-        点击屏幕
-        """
-        self.u2_client.click(x, y)
-        
-    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float|None = None) -> None:
-        """
-        滑动屏幕
-        """
+import time
+from typing import Literal
+
+import numpy as np
+try:
+    import uiautomator2 as u2
+    from adbutils._device import AdbDevice as AdbUtilsDevice
+except ImportError as _e:
+    from kotonebot.errors import MissingDependencyError
+    raise MissingDependencyError(_e, 'android')
+from cv2.typing import MatLike
+
+from kotonebot import logging
+from ..device import Device
+from ..protocol import Screenshotable, Commandable, Touchable
+
+logger = logging.getLogger(__name__)
+
+SCREENSHOT_INTERVAL = 0.2
+
+class UiAutomator2Impl(Screenshotable, Commandable, Touchable):
+    def __init__(self, adb_connection: AdbUtilsDevice):
+        self.u2_client = u2.Device(adb_connection.serial)
+        self.__last_screenshot_time = 0
+        
+    def screenshot(self) -> MatLike:
+        """
+        截图
+        """
+        from kotonebot import sleep
+        delta = time.time() - self.__last_screenshot_time
+        if delta < SCREENSHOT_INTERVAL:
+            time.sleep(SCREENSHOT_INTERVAL - delta)
+        start_time = time.time()
+        image = self.u2_client.screenshot(format='opencv')
+        logger.verbose(f'uiautomator2 screenshot: {time.time() - start_time}s')
+        self.__last_screenshot_time = time.time()
+        assert isinstance(image, np.ndarray)
+        return image
+    
+    @property
+    def screen_size(self) -> tuple[int, int]:
+        info = self.u2_client.info
+        sizes = info['displayWidth'], info['displayHeight']
+        return sizes
+    
+    def detect_orientation(self) -> Literal['portrait', 'landscape'] | None:
+        """
+        检测设备方向
+        """
+        orientation = self.u2_client.info['displayRotation']
+        if orientation == 1:
+            return 'portrait'
+        elif orientation == 0:
+            return 'landscape'
+        else:
+            return None
+    
+    def launch_app(self, package_name: str) -> None:
+        """
+        启动应用
+        """
+        self.u2_client.app_start(package_name)
+        
+    def current_package(self) -> str | None:
+        """
+        获取当前应用包名
+        """
+        try:
+            result = self.u2_client.app_current()
+            logger.verbose(f'uiautomator2 current_package: {result}')
+            return result['package']
+        except:
+            return None
+        
+    def click(self, x: int, y: int) -> None:
+        """
+        点击屏幕
+        """
+        self.u2_client.click(x, y)
+        
+    def swipe(self, x1: int, y1: int, x2: int, y2: int, duration: float|None = None) -> None:
+        """
+        滑动屏幕
+        """
         self.u2_client.swipe(x1, y1, x2, y2, duration=duration or 0.1)