kotonebot 0.2.0__tar.gz → 0.3.0__tar.gz

{kotonebot-0.2.0/kotonebot.egg-info → kotonebot-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kotonebot
-Version: 0.2.0
+Version: 0.3.0
 Summary: Kotonebot is game/app automation library based on computer vision technology, works for Windows and Android.
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{kotonebot-0.2.0 → kotonebot-0.3.0}/kotonebot/backend/ocr.py

@@ -24,6 +24,25 @@ logger = logging.getLogger(__name__)
 StringMatchFunction = Callable[[str], bool]
 REGEX_NUMBERS = re.compile(r'\d+')
 
+global_character_mapping: dict[str, str] = {
+    'ó': '6',
+    'ą': 'a',
+}
+"""
+全局字符映射表。某些字符可能在某些情况下被错误地识别，此时可以在这里添加映射。
+"""
+
+def sanitize_text(text: str) -> str:
+    """
+    对识别结果进行清理。此函数将被所有 OCR 引擎调用。
+    
+    默认使用 `global_character_mapping` 中的映射数据进行清理。
+    可以重写此函数以实现自定义的清理逻辑。
+    """
+    for k, v in global_character_mapping.items():
+        text = text.replace(k, v)
+    return text
+
 @dataclass
 class OcrResult:
     text: str
@@ -330,8 +349,7 @@ class Ocr:
             return OcrResultList()
         ret = []
         for r in result:
-            # HACK: 识别结果中包含奇怪的符号，暂时替换掉
-            text = unicodedata.normalize('NFKC', r[1]).replace('ą', 'a')
+            text = sanitize_text(r[1])
             # r[0] = [左上, 右上, 右下, 左下]
             # 这里有个坑，返回的点不一定是矩形，只能保证是四边形
             # 所以这里需要计算出四个点的外接矩形

{kotonebot-0.2.0 → kotonebot-0.3.0}/kotonebot/client/host/mumu12_host.py

@@ -3,7 +3,7 @@ import os
 import json
 import subprocess
 from functools import lru_cache
-from typing import Any, Literal, overload
+from typing import Any, Literal, overload, TYPE_CHECKING
 from typing_extensions import override
 
 from kotonebot import logging
@@ -22,6 +22,10 @@ else:
         """Stub for read_reg on non-Windows platforms."""
         return default
 
+# Forward declarations for type hints
+if TYPE_CHECKING:
+    from typing import Type
+
 logger = logging.getLogger(__name__)
 MuMu12Recipes = AdbRecipes | Literal['nemu_ipc']
 
@@ -35,24 +39,137 @@ class MuMu12HostConfig(AdbHostConfig):
     app_index: int = 0
     """多开应用索引，传给 get_display_id 方法。"""
 
+class Mumu12Host(HostProtocol[MuMu12Recipes]):
+    InstanceClass: 'Type[Mumu12Instance]'
+
+    @staticmethod
+    @lru_cache(maxsize=1)
+    def _read_install_path() -> str | None:
+        r"""
+        从注册表中读取 MuMu Player 12 的安装路径。
+
+        返回的路径为根目录。如 `F:\Apps\Netease\MuMuPlayer-12.0`。
+
+        :return: 若找到，则返回安装路径；否则返回 None。
+        """
+        if os.name != 'nt':
+            return None
+
+        uninstall_subkeys = [
+            r'SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\MuMuPlayer-12.0',
+            # TODO: 支持国际版 MuMu
+            # r'SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\MuMuPlayerGlobal-12.0'
+        ]
+
+        for subkey in uninstall_subkeys:
+            icon_path = read_reg('HKLM', subkey, 'DisplayIcon', default=None)
+            if icon_path and isinstance(icon_path, str):
+                icon_path = icon_path.replace('"', '')
+                path = os.path.dirname(icon_path)
+                logger.debug('MuMu Player 12 installation path: %s', path)
+                # 返回根目录（去掉 shell 子目录）
+                if os.path.basename(path).lower() == 'shell':
+                    path = os.path.dirname(path)
+                return path
+        return None
+
+    @classmethod
+    def _invoke_manager(cls,args: list[str]) -> str:
+        """
+        调用 MuMuManager.exe。
+        
+        :param args: 命令行参数列表。
+        :return: 命令执行的输出。
+        """
+        install_path = cls._read_install_path()
+        if install_path is None:
+            raise RuntimeError('MuMu Player 12 is not installed.')
+        manager_path = os.path.join(install_path, 'shell', 'MuMuManager.exe')
+        logger.debug('MuMuManager execute: %s', repr(args))
+        output = subprocess.run(
+            [manager_path] + args,
+            capture_output=True,
+            text=True,
+            encoding='utf-8',
+            # https://stackoverflow.com/questions/6011235/run-a-program-from-python-and-have-it-continue-to-run-after-the-script-is-kille
+            creationflags=subprocess.DETACHED_PROCESS | subprocess.CREATE_NEW_PROCESS_GROUP
+        )
+        if output.returncode != 0:
+            # raise RuntimeError(f'Failed to invoke MuMuManager: {output.stderr}')
+            logger.warning('Failed to invoke MuMuManager: %s', output.stderr)
+        return output.stdout
+
+    @staticmethod
+    def installed() -> bool:
+        return Mumu12Host._read_install_path() is not None
+
+    @classmethod
+    def list(cls) -> list[Instance]:
+        nemu_path = cls._read_install_path()
+        if nemu_path is None:
+            raise RuntimeError("Nemu path not found.")
+        output = cls._invoke_manager(['info', '-v', 'all'])
+        logger.debug('MuMuManager.exe output: %s', output)
+        
+        try:
+            data: dict[str, dict[str, Any]] = json.loads(output)
+            if 'name' in data.keys():
+                # 这里有个坑：
+                # 如果只有一个实例，返回的 JSON 结构是单个对象而不是数组
+                data = { '0': data }
+            instances = []
+            for index, instance_data in data.items():
+                instance = cls.InstanceClass(
+                    id=index,
+                    name=instance_data['name'],
+                    adb_port=instance_data.get('adb_port'),  
+                    adb_ip=instance_data.get('adb_host_ip', '127.0.0.1'), 
+                    adb_name=None,
+                )
+                instance.nemu_path = nemu_path
+                instance.index = int(index)
+                instance.is_android_started = instance_data.get('is_android_started', False)
+                logger.debug('Mumu12 instance: %s', repr(instance))
+                instances.append(instance)
+            return instances
+        except json.JSONDecodeError as e:
+            raise RuntimeError(f'Failed to parse output: {e}')
+    
+    @classmethod
+    def query(cls, *, id: str) -> Instance | None:
+        instances = cls.list()
+        for instance in instances:
+            if instance.id == id:
+                return instance
+        return None
+
+    @staticmethod
+    def recipes() -> 'list[MuMu12Recipes]':
+        return ['adb', 'adb_raw', 'uiautomator2', 'nemu_ipc']
 
 class Mumu12Instance(CommonAdbCreateDeviceMixin, Instance[MuMu12HostConfig]):
+    HostClass: 'type[Mumu12Host]' = Mumu12Host
+
     @copy_type(Instance.__init__)
     def __init__(self, *args, **kwargs):
+        if not hasattr(self.HostClass, 'InstanceClass'):
+            raise RuntimeError(f"{self.HostClass.__name__}.InstanceClass not initialized")
+        
         super().__init__(*args, **kwargs)
         self._args = args
         self.index: int | None = None
         self.is_android_started: bool = False
+        self.nemu_path: str | None = None
     
     @override
     def refresh(self):
-        ins = Mumu12Host.query(id=self.id)
-        assert isinstance(ins, Mumu12Instance), f'Expected Mumu12Instance, got {type(ins)}'
-        if ins is not None:
+        ins = self.HostClass.query(id=self.id)
+        if ins is not None and isinstance(ins, self.__class__):
             self.adb_port = ins.adb_port
             self.adb_ip = ins.adb_ip
             self.adb_name = ins.adb_name
             self.is_android_started = ins.is_android_started
+            self.nemu_path = ins.nemu_path
             logger.debug('Refreshed MuMu12 instance: %s', repr(ins))
     
     @override
@@ -61,7 +178,7 @@ class Mumu12Instance(CommonAdbCreateDeviceMixin, Instance[MuMu12HostConfig]):
             logger.warning('Instance is already running.')
             return
         logger.info('Starting MuMu12 instance %s', self)
-        Mumu12Host._invoke_manager(['control', '-v', self.id, 'launch'])
+        self.HostClass._invoke_manager(['control', '-v', self.id, 'launch'])
         self.refresh()
     
     @override
@@ -70,7 +187,7 @@ class Mumu12Instance(CommonAdbCreateDeviceMixin, Instance[MuMu12HostConfig]):
             logger.warning('Instance is not running.')
             return
         logger.info('Stopping MuMu12 instance id=%s name=%s...', self.id, self.name)
-        Mumu12Host._invoke_manager(['control', '-v', self.id, 'shutdown'])
+        self.HostClass._invoke_manager(['control', '-v', self.id, 'shutdown'])
         self.refresh()
     
     @override
@@ -100,11 +217,10 @@ class Mumu12Instance(CommonAdbCreateDeviceMixin, Instance[MuMu12HostConfig]):
 
         if recipe == 'nemu_ipc' and isinstance(host_config, MuMu12HostConfig):
             # NemuImpl
-            nemu_path = Mumu12Host._read_install_path()
-            if not nemu_path:
-                raise RuntimeError("无法找到 MuMu12 的安装路径。")
+            if self.nemu_path is None:
+                raise RuntimeError("Nemu path is not set.")
             nemu_config = NemuIpcImplConfig(
-                nemu_folder=nemu_path,
+                nemu_folder=self.nemu_path,
                 instance_id=int(self.id),
                 display_id=host_config.display_id,
                 target_package_name=host_config.target_package_name,
@@ -129,12 +245,14 @@ class Mumu12Instance(CommonAdbCreateDeviceMixin, Instance[MuMu12HostConfig]):
         else:
             raise ValueError(f'Unknown recipe: {recipe}')
 
-class Mumu12Host(HostProtocol[MuMu12Recipes]):
-    @staticmethod
+class Mumu12V5Host(Mumu12Host):
+    InstanceClass: 'Type[Mumu12V5Instance]'
+
+    @classmethod
     @lru_cache(maxsize=1)
-    def _read_install_path() -> str | None:
+    def _read_install_path(cls) -> str | None:
         r"""
-        从注册表中读取 MuMu Player 12 的安装路径。
+        从注册表中读取 MuMu Player 12 v5.x 的安装路径。
 
         返回的路径为根目录。如 `F:\Apps\Netease\MuMuPlayer-12.0`。
 
@@ -144,9 +262,7 @@ class Mumu12Host(HostProtocol[MuMu12Recipes]):
             return None
 
         uninstall_subkeys = [
-            r'SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\MuMuPlayer-12.0',
-            # TODO: 支持国际版 MuMu
-            # r'SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\MuMuPlayerGlobal-12.0'
+            r'SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\MuMuPlayer',
         ]
 
         for subkey in uninstall_subkeys:
@@ -156,23 +272,23 @@ class Mumu12Host(HostProtocol[MuMu12Recipes]):
                 path = os.path.dirname(icon_path)
                 logger.debug('MuMu Player 12 installation path: %s', path)
                 # 返回根目录（去掉 shell 子目录）
-                if os.path.basename(path).lower() == 'shell':
+                if os.path.basename(path).lower() == 'nx_main':
                     path = os.path.dirname(path)
                 return path
         return None
 
-    @staticmethod
-    def _invoke_manager(args: list[str]) -> str:
+    @classmethod
+    def _invoke_manager(cls, args: list[str]) -> str:
         """
         调用 MuMuManager.exe。
         
         :param args: 命令行参数列表。
         :return: 命令执行的输出。
         """
-        install_path = Mumu12Host._read_install_path()
+        install_path = cls._read_install_path()
         if install_path is None:
-            raise RuntimeError('MuMu Player 12 is not installed.')
-        manager_path = os.path.join(install_path, 'shell', 'MuMuManager.exe')
+            raise RuntimeError('MuMu Player 12 v5.x is not installed.')
+        manager_path = os.path.join(install_path, 'nx_main', 'MuMuManager.exe')
         logger.debug('MuMuManager execute: %s', repr(args))
         output = subprocess.run(
             [manager_path] + args,
@@ -187,13 +303,13 @@ class Mumu12Host(HostProtocol[MuMu12Recipes]):
             logger.warning('Failed to invoke MuMuManager: %s', output.stderr)
         return output.stdout
 
-    @staticmethod
-    def installed() -> bool:
-        return Mumu12Host._read_install_path() is not None
+    @classmethod
+    def installed(cls) -> bool:
+        return cls._read_install_path() is not None
 
-    @staticmethod
-    def list() -> list[Instance]:
-        output = Mumu12Host._invoke_manager(['info', '-v', 'all'])
+    @classmethod
+    def list(cls) -> list[Instance]:
+        output = cls._invoke_manager(['info', '-v', 'all'])
         logger.debug('MuMuManager.exe output: %s', output)
         
         try:
@@ -204,40 +320,37 @@ class Mumu12Host(HostProtocol[MuMu12Recipes]):
                 data = { '0': data }
             instances = []
             for index, instance_data in data.items():
-                instance = Mumu12Instance(
+                instance = cls.InstanceClass(
                     id=index,
                     name=instance_data['name'],
                     adb_port=instance_data.get('adb_port'),  
                     adb_ip=instance_data.get('adb_host_ip', '127.0.0.1'), 
                     adb_name=None
                 )
+                instance.nemu_path = cls._read_install_path()
                 instance.index = int(index)
                 instance.is_android_started = instance_data.get('is_android_started', False)
-                logger.debug('Mumu12 instance: %s', repr(instance))
+                logger.debug('Mumu12 v5.x instance: %s', repr(instance))
                 instances.append(instance)
             return instances
         except json.JSONDecodeError as e:
             raise RuntimeError(f'Failed to parse output: {e}')
-    
-    @staticmethod
-    def query(*, id: str) -> Instance | None:
-        instances = Mumu12Host.list()
-        for instance in instances:
-            if instance.id == id:
-                return instance
-        return None
 
-    @staticmethod
-    def recipes() -> 'list[MuMu12Recipes]':
-        return ['adb', 'adb_raw', 'uiautomator2', 'nemu_ipc']
-    
+class Mumu12V5Instance(Mumu12Instance):
+    HostClass: 'type[Mumu12V5Host]' = Mumu12V5Host
+
+# 延迟初始化 InstanceClass 变量
+Mumu12Host.InstanceClass = Mumu12Instance
+Mumu12V5Host.InstanceClass = Mumu12V5Instance
+
+
 if __name__ == '__main__':
     logging.basicConfig(level=logging.DEBUG, format='[%(asctime)s] [%(levelname)s] [%(name)s] [%(funcName)s] [%(lineno)d] %(message)s')
     print(Mumu12Host._read_install_path())
     print(Mumu12Host.installed())
     print(Mumu12Host.list())
     print(ins:=Mumu12Host.query(id='2'))
-    assert isinstance(ins, Mumu12Instance)
+    assert isinstance(ins, Mumu12Host.InstanceClass)
     ins.start()
     ins.wait_available()
     print('status', ins.running(), ins.adb_port, ins.adb_ip)

{kotonebot-0.2.0 → kotonebot-0.3.0}/kotonebot/client/implements/nemu_ipc/external_renderer_ipc.py

@@ -204,6 +204,7 @@ class ExternalRendererIpc:
     def __load_dll(self, mumu_root_folder: str) -> ctypes.CDLL:
         """尝试多条路径加载 DLL。传入为 MuMu 根目录。"""
         candidate_paths = [
+            # <= 4.x
             os.path.join(mumu_root_folder, "shell", "sdk", "external_renderer_ipc.dll"),
             os.path.join(
                 mumu_root_folder,
@@ -213,6 +214,10 @@ class ExternalRendererIpc:
                 "sdk",
                 "external_renderer_ipc.dll",
             ),
+            # >= 5.x
+            os.path.join(
+                mumu_root_folder, "nx_device", "12.0", "shell", "sdk", "external_renderer_ipc.dll"
+            ),
         ]
         for p in candidate_paths:
             if not os.path.exists(p):

{kotonebot-0.2.0 → kotonebot-0.3.0/kotonebot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kotonebot
-Version: 0.2.0
+Version: 0.3.0
 Summary: Kotonebot is game/app automation library based on computer vision technology, works for Windows and Android.
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{kotonebot-0.2.0 → kotonebot-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "kotonebot"
-version = "0.2.0"
+version = "0.3.0"
 description = "Kotonebot is game/app automation library based on computer vision technology, works for Windows and Android."
 readme = "README.md"
 requires-python = ">=3.10"