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

kotonebot/client/host/__init__.py

@@ -1,12 +1,43 @@
-from .protocol import HostProtocol, Instance, AdbHostConfig, WindowsHostConfig, RemoteWindowsHostConfig
-from .custom import CustomInstance, create as create_custom
-from .mumu12_host import Mumu12Host, Mumu12Instance, Mumu12V5Host, Mumu12V5Instance
-from .leidian_host import LeidianHost, LeidianInstance
-
-__all__ = [
-    'HostProtocol', 'Instance',
-    'AdbHostConfig', 'WindowsHostConfig', 'RemoteWindowsHostConfig',
-    'CustomInstance', 'create_custom',
-    'Mumu12Host', 'Mumu12Instance', 'Mumu12V5Host', 'Mumu12V5Instance',
-    'LeidianHost', 'LeidianInstance'
-]
+from typing import TYPE_CHECKING
+
+from .protocol import HostProtocol, Instance, AdbHostConfig, WindowsHostConfig, RemoteWindowsHostConfig
+if TYPE_CHECKING:
+    from .custom import CustomInstance, create as create_custom
+    from .mumu12_host import Mumu12Host, Mumu12Instance, Mumu12V5Host, Mumu12V5Instance
+    from .leidian_host import LeidianHost, LeidianInstance
+
+def _require_custom():
+    global CustomInstance, create_custom
+    from .custom import CustomInstance, create as create_custom
+    
+def _require_mumu12():
+    global Mumu12Host, Mumu12Instance, Mumu12V5Host, Mumu12V5Instance
+    from .mumu12_host import Mumu12Host, Mumu12Instance, Mumu12V5Host, Mumu12V5Instance
+    
+def _require_leidian():
+    global LeidianHost, LeidianInstance
+    from .leidian_host import LeidianHost, LeidianInstance
+
+_IMPORT_NAMES = [
+    (_require_custom, ['CustomInstance', 'create_custom']),
+    (_require_mumu12, ['Mumu12Host', 'Mumu12Instance', 'Mumu12V5Host', 'Mumu12V5Instance']),
+    (_require_leidian, ['LeidianHost', 'LeidianInstance']),
+]
+
+def __getattr__(name: str):
+    for item in _IMPORT_NAMES:
+        if name in item[1]:
+            item[0]()
+            break
+    try:
+        return globals()[name]
+    except KeyError:
+        raise AttributeError(name=name)
+
+__all__ = [
+    'HostProtocol', 'Instance',
+    'AdbHostConfig', 'WindowsHostConfig', 'RemoteWindowsHostConfig',
+    'CustomInstance', 'create_custom',
+    'Mumu12Host', 'Mumu12Instance', 'Mumu12V5Host', 'Mumu12V5Instance',
+    'LeidianHost', 'LeidianInstance'
+]

kotonebot/client/host/adb_common.py

@@ -1,94 +1,107 @@
-from abc import ABC
-from typing import Any, Literal, TypeGuard, TypeVar, get_args
-from typing_extensions import assert_never
-
-from adbutils import adb
-from adbutils._device import AdbDevice
-from kotonebot import logging
-from kotonebot.client.device import AndroidDevice
-from .protocol import Instance, AdbHostConfig, Device
-
-logger = logging.getLogger(__name__)
-AdbRecipes = Literal['adb', 'adb_raw', 'uiautomator2']
-
-def is_adb_recipe(recipe: Any) -> TypeGuard[AdbRecipes]:
-    return recipe in get_args(AdbRecipes)
-
-def connect_adb(
-    ip: str,
-    port: int,
-    connect: bool = True,
-    disconnect: bool = True,
-    timeout: float = 180,
-    device_serial: str | None = None
-) -> AdbDevice:
-    """
-    创建 ADB 连接。
-    """
-    if disconnect:
-        logger.debug('adb disconnect %s:%d', ip, port)
-        adb.disconnect(f'{ip}:{port}')
-    if connect:
-        logger.debug('adb connect %s:%d', ip, port)
-        result = adb.connect(f'{ip}:{port}')
-        if 'cannot connect to' in result:
-            raise ValueError(result)
-    serial = device_serial or f'{ip}:{port}'
-    logger.debug('adb wait for %s', serial)
-    adb.wait_for(serial, timeout=timeout)
-    devices = adb.device_list()
-    logger.debug('adb device_list: %s', devices)
-    d = [d for d in devices if d.serial == serial]
-    if len(d) == 0:
-        raise ValueError(f"Device {serial} not found")
-    d = d[0]
-    return d
-
-class CommonAdbCreateDeviceMixin(ABC):
-    """
-    通用 ADB 创建设备的 Mixin。
-    该 Mixin 定义了创建 ADB 设备的通用接口。
-    """
-    def __init__(self, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
-        # 下面的属性只是为了让类型检查通过，无实际实现
-        self.adb_ip: str
-        self.adb_port: int
-        self.adb_name: str
-    
-    def create_device(self, recipe: AdbRecipes, config: AdbHostConfig) -> Device:
-        """
-        创建 ADB 设备。
-        """
-        connection = connect_adb(
-            self.adb_ip,
-            self.adb_port,
-            connect=True,
-            disconnect=True,
-            timeout=config.timeout,
-            device_serial=self.adb_name
-        )
-        d = AndroidDevice(connection)
-        match recipe:
-            case 'adb':
-                from kotonebot.client.implements.adb import AdbImpl
-                impl = AdbImpl(connection)
-                d._screenshot = impl
-                d._touch = impl
-                d.commands = impl
-            case 'adb_raw':
-                from kotonebot.client.implements.adb_raw import AdbRawImpl
-                impl = AdbRawImpl(connection)
-                d._screenshot = impl
-                d._touch = impl
-                d.commands = impl
-            case 'uiautomator2':
-                from kotonebot.client.implements.uiautomator2 import UiAutomator2Impl
-                from kotonebot.client.implements.adb import AdbImpl
-                impl = UiAutomator2Impl(connection)
-                d._screenshot = impl
-                d._touch = impl
-                d.commands = AdbImpl(connection)
-            case _:
-                assert_never(f'Unsupported ADB recipe: {recipe}')
-        return d
+from abc import ABC
+from typing import Any, Literal, TypeGuard, TypeVar, get_args
+from typing_extensions import assert_never
+
+try:
+    from adbutils import adb
+    from adbutils._device import AdbDevice
+except ImportError as _e:
+    from kotonebot.errors import MissingDependencyError
+    raise MissingDependencyError(_e, 'android')
+from kotonebot import logging
+from kotonebot.client.device import AndroidDevice
+from .protocol import Instance, AdbHostConfig, Device
+
+logger = logging.getLogger(__name__)
+AdbRecipes = Literal['adb', 'adb_raw', 'uiautomator2']
+
+def is_adb_recipe(recipe: Any) -> TypeGuard[AdbRecipes]:
+    return recipe in get_args(AdbRecipes)
+
+def connect_adb(
+    ip: str,
+    port: int,
+    connect: bool = True,
+    disconnect: bool = True,
+    timeout: float = 180,
+    device_serial: str | None = None
+) -> AdbDevice:
+    """
+    创建 ADB 连接。
+    """
+    if disconnect:
+        logger.debug('adb disconnect %s:%d', ip, port)
+        adb.disconnect(f'{ip}:{port}')
+    else:
+        logger.debug('Skip adb disconnect.')
+    if connect:
+        logger.debug('adb connect %s:%d', ip, port)
+        result = adb.connect(f'{ip}:{port}')
+        if 'cannot connect to' in result:
+            raise ValueError(result)
+    else:
+        logger.debug('Skip adb connect.')
+    serial = device_serial or f'{ip}:{port}'
+    logger.debug('adb wait for %s', serial)
+    adb.wait_for(serial, timeout=timeout)
+    devices = adb.device_list()
+    logger.debug('adb device_list: %s', devices)
+    d = [d for d in devices if d.serial == serial]
+    if len(d) == 0:
+        raise ValueError(f"Device {serial} not found")
+    d = d[0]
+    return d
+
+class CommonAdbCreateDeviceMixin(ABC):
+    """
+    通用 ADB 创建设备的 Mixin。
+    该 Mixin 定义了创建 ADB 设备的通用接口。
+    """
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        # 下面的属性只是为了让类型检查通过，无实际实现
+        self.adb_ip: str
+        self.adb_port: int
+        self.adb_name: str
+    
+    def create_device(self, recipe: AdbRecipes, config: AdbHostConfig, *, connect: bool = True, disconnect: bool = True) -> Device:
+        """
+        创建 ADB 设备。
+
+        :param recipe: 连接方式配方名称。
+        :param config: ADB 配置。
+        :param connect: 创建设备实例前，是否连接 ADB（执行 adb connect）。
+        :param disconnect: 创建设备实例前，是否先断开已有 ADB 连接（执行 adb disconnect）。
+        """
+        connection = connect_adb(
+            self.adb_ip,
+            self.adb_port,
+            connect=connect,
+            disconnect=disconnect,
+            timeout=config.timeout,
+            device_serial=self.adb_name
+        )
+        d = AndroidDevice(connection)
+        match recipe:
+            case 'adb':
+                from kotonebot.client.implements.adb import AdbImpl
+                impl = AdbImpl(connection)
+                d._screenshot = impl
+                d._touch = impl
+                d.commands = impl
+            case 'adb_raw':
+                from kotonebot.client.implements.adb_raw import AdbRawImpl
+                impl = AdbRawImpl(connection)
+                d._screenshot = impl
+                d._touch = impl
+                d.commands = impl
+            case 'uiautomator2':
+                from kotonebot.client.implements.uiautomator2 import UiAutomator2Impl
+                from kotonebot.client.implements.adb import AdbImpl
+                impl = UiAutomator2Impl(connection)
+                d._screenshot = impl
+                d._touch = impl
+                d.commands = AdbImpl(connection)
+            case _:
+                assert_never(f'Unsupported ADB recipe: {recipe}')
+        return d

kotonebot/client/host/custom.py

@@ -1,114 +1,118 @@
-import os
-import subprocess
-from psutil import process_iter
-from .protocol import Instance, AdbHostConfig, HostProtocol
-from typing import ParamSpec, TypeVar
-from typing_extensions import override
-
-from kotonebot import logging
-from kotonebot.client import Device
-from .adb_common import AdbRecipes, CommonAdbCreateDeviceMixin
-
-logger = logging.getLogger(__name__)
-CustomRecipes = AdbRecipes
-
-P = ParamSpec('P')
-T = TypeVar('T')
-
-class CustomInstance(CommonAdbCreateDeviceMixin, Instance[AdbHostConfig]):
-    def __init__(self, exe_path: str | None, emulator_args: str = "", *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.exe_path: str | None = exe_path
-        self.exe_args: str = emulator_args
-        self.process: subprocess.Popen | None = None
-
-    @override
-    def start(self):
-        if self.process:
-            logger.warning('Process is already running.')
-            return
-
-        if not self.exe_path:
-            raise ValueError('Executable path is not set.')
-        if self.exe_args:
-            logger.info('Starting process "%s" with args "%s"...', self.exe_path, self.exe_args)
-            cmd = f'"{self.exe_path}" {self.exe_args}'
-            self.process = subprocess.Popen(cmd, shell=True)
-        else:
-            logger.info('Starting process "%s"...', self.exe_path)
-            self.process = subprocess.Popen(self.exe_path)
-
-    @override
-    def stop(self):
-        if not self.process:
-            logger.warning('Process is not running.')
-            return
-        logger.info('Stopping process "%s"...', self.process.pid)
-        self.process.terminate()
-        self.process.wait()
-        self.process = None
-
-    @override
-    def running(self) -> bool:
-        if self.process is not None:
-            return True
-        else:
-            if not self.exe_path:
-                logger.warning('Executable path is not set, cannot check if process is running.')
-                return False
-            process_name = os.path.basename(self.exe_path)
-            p = next((proc for proc in process_iter() if proc.name() == process_name), None)
-            if p:
-                return True
-            else:
-                return False
-
-    @override
-    def refresh(self):
-        pass
-
-    @override
-    def create_device(self, impl: CustomRecipes, host_config: AdbHostConfig) -> Device:
-        """为自定义实例创建 Device。"""
-        if self.adb_port is None:
-            raise ValueError("ADB port is not set and is required.")
-
-        return super().create_device(impl, host_config)
-
-    def __repr__(self) -> str:
-        return f'CustomInstance(#{self.id}# at "{self.exe_path}" with {self.adb_ip}:{self.adb_port})'
-
-def _type_check(ins: Instance) -> CustomInstance:
-    if not isinstance(ins, CustomInstance):
-        raise ValueError(f'Instance {ins} is not a CustomInstance')
-    return ins
-
-def create(exe_path: str | None, adb_ip: str, adb_port: int, adb_name: str | None, emulator_args: str = "") -> CustomInstance:
-    return CustomInstance(exe_path, emulator_args=emulator_args, id='custom', name='Custom', adb_ip=adb_ip, adb_port=adb_port, adb_name=adb_name)
-
-class CustomHost(HostProtocol[CustomRecipes]):
-    @staticmethod
-    def installed() -> bool:
-        # Custom instances don't have a specific installation requirement
-        return True
-
-    @staticmethod
-    def list() -> list[Instance]:
-        # Custom instances are created manually, not discovered
-        return []
-
-    @staticmethod
-    def query(*, id: str) -> Instance | None:
-        # Custom instances are created manually, not discovered
-        return None
-
-    @staticmethod
-    def recipes() -> 'list[CustomRecipes]':
-        return ['adb', 'adb_raw', 'uiautomator2']
-
-if __name__ == '__main__':
-    ins = create(r'C:\Program Files\BlueStacks_nxt\HD-Player.exe', '127.0.0.1', 5555, '**emulator-name**')
-    ins.start()
-    ins.wait_available()
-    input('Press Enter to stop...')
-    ins.stop()
+import os
+import subprocess
+try:
+    from psutil import process_iter
+except ImportError as _e:
+    from kotonebot.errors import MissingDependencyError
+    raise MissingDependencyError(_e, 'windows')
+from .protocol import Instance, AdbHostConfig, HostProtocol
+from typing import ParamSpec, TypeVar
+from typing_extensions import override
+
+from kotonebot import logging
+from kotonebot.client import Device
+from .adb_common import AdbRecipes, CommonAdbCreateDeviceMixin
+
+logger = logging.getLogger(__name__)
+CustomRecipes = AdbRecipes
+
+P = ParamSpec('P')
+T = TypeVar('T')
+
+class CustomInstance(CommonAdbCreateDeviceMixin, Instance[AdbHostConfig]):
+    def __init__(self, exe_path: str | None, emulator_args: str = "", *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.exe_path: str | None = exe_path
+        self.exe_args: str = emulator_args
+        self.process: subprocess.Popen | None = None
+
+    @override
+    def start(self):
+        if self.process:
+            logger.warning('Process is already running.')
+            return
+
+        if not self.exe_path:
+            raise ValueError('Executable path is not set.')
+        if self.exe_args:
+            logger.info('Starting process "%s" with args "%s"...', self.exe_path, self.exe_args)
+            cmd = f'"{self.exe_path}" {self.exe_args}'
+            self.process = subprocess.Popen(cmd, shell=True)
+        else:
+            logger.info('Starting process "%s"...', self.exe_path)
+            self.process = subprocess.Popen(self.exe_path)
+
+    @override
+    def stop(self):
+        if not self.process:
+            logger.warning('Process is not running.')
+            return
+        logger.info('Stopping process "%s"...', self.process.pid)
+        self.process.terminate()
+        self.process.wait()
+        self.process = None
+
+    @override
+    def running(self) -> bool:
+        if self.process is not None:
+            return True
+        else:
+            if not self.exe_path:
+                logger.warning('Executable path is not set, cannot check if process is running.')
+                return False
+            process_name = os.path.basename(self.exe_path)
+            p = next((proc for proc in process_iter() if proc.name() == process_name), None)
+            if p:
+                return True
+            else:
+                return False
+
+    @override
+    def refresh(self):
+        pass
+
+    @override
+    def create_device(self, impl: CustomRecipes, host_config: AdbHostConfig) -> Device:
+        """为自定义实例创建 Device。"""
+        if self.adb_port is None:
+            raise ValueError("ADB port is not set and is required.")
+
+        return super().create_device(impl, host_config)
+
+    def __repr__(self) -> str:
+        return f'CustomInstance(#{self.id}# at "{self.exe_path}" with {self.adb_ip}:{self.adb_port})'
+
+def _type_check(ins: Instance) -> CustomInstance:
+    if not isinstance(ins, CustomInstance):
+        raise ValueError(f'Instance {ins} is not a CustomInstance')
+    return ins
+
+def create(exe_path: str | None, adb_ip: str, adb_port: int, adb_name: str | None, emulator_args: str = "") -> CustomInstance:
+    return CustomInstance(exe_path, emulator_args=emulator_args, id='custom', name='Custom', adb_ip=adb_ip, adb_port=adb_port, adb_name=adb_name)
+
+class CustomHost(HostProtocol[CustomRecipes]):
+    @staticmethod
+    def installed() -> bool:
+        # Custom instances don't have a specific installation requirement
+        return True
+
+    @staticmethod
+    def list() -> list[Instance]:
+        # Custom instances are created manually, not discovered
+        return []
+
+    @staticmethod
+    def query(*, id: str) -> Instance | None:
+        # Custom instances are created manually, not discovered
+        return None
+
+    @staticmethod
+    def recipes() -> 'list[CustomRecipes]':
+        return ['adb', 'adb_raw', 'uiautomator2']
+
+if __name__ == '__main__':
+    ins = create(r'C:\Program Files\BlueStacks_nxt\HD-Player.exe', '127.0.0.1', 5555, '**emulator-name**')
+    ins.start()
+    ins.wait_available()
+    input('Press Enter to stop...')
+    ins.stop()