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

kotonebot/config/base_config.py

@@ -1,96 +1,96 @@
-import uuid
-from typing import Generic, TypeVar, Literal
-
-from pydantic import BaseModel, ConfigDict
-
-
-T = TypeVar('T')
-BackendType = Literal['custom', 'mumu12', 'mumu12v5', 'leidian', 'dmm']
-DeviceRecipes = Literal['adb', 'adb_raw', 'uiautomator2', 'windows', 'remote_windows', 'nemu_ipc']
-
-class ConfigBaseModel(BaseModel):
-    model_config = ConfigDict(use_attribute_docstrings=True)
-
-class BackendConfig(ConfigBaseModel):
-    type: BackendType = 'custom'
-    """后端类型。"""
-    instance_id: str | None = None
-    """模拟器实例 ID。"""
-    adb_ip: str = '127.0.0.1'
-    """adb 连接的 ip 地址。"""
-    adb_port: int = 5555
-    """adb 连接的端口。"""
-    adb_emulator_name: str | None = None
-    """
-    adb 连接的模拟器名，用于 自动启动模拟器 功能。
-    
-    雷电模拟器需要设置正确的模拟器名，否则 自动启动模拟器 功能将无法正常工作。
-    其他功能不受影响。
-    """
-    screenshot_impl: DeviceRecipes = 'adb'
-    """
-    截图方法。暂时推荐使用【adb】截图方式。
-
-    如果使用 remote_windows，需要在 adb_ip 中填写远程 Windows 的 IP 地址，在 adb_port 中填写远程 Windows 的端口号。
-    """
-    check_emulator: bool = False
-    """
-    检查并启动模拟器
-
-    启动脚本的时候，如果检测到模拟器未启动，则自动启动模拟器。
-    如果模拟器已经启动，则不启动。
-    """
-    emulator_path: str | None = None
-    """模拟器 exe 文件路径"""
-    emulator_args: str = ""
-    """模拟器启动时的命令行参数"""
-    windows_window_title: str = 'gakumas'
-    """Windows 截图方式的窗口标题"""
-    windows_ahk_path: str | None = None
-    """Windows 截图方式的 AutoHotkey 可执行文件路径，为 None 时使用默认路径"""
-    mumu_background_mode: bool = False
-    """MuMu12 模拟器后台保活模式"""
-    target_screenshot_interval: float | None = None
-    """最小截图间隔，单位为秒。为 None 时不限制截图速度。"""
-
-class PushConfig(ConfigBaseModel):
-    """推送配置。"""
-
-    wx_pusher_enabled: bool = False
-    """是否启用 WxPusher 推送。"""
-    wx_pusher_app_token: str | None = None
-    """WxPusher 的 app token。"""
-    wx_pusher_uid: str | None = None
-    """WxPusher 的 uid。"""
-
-    free_image_host_key: str | None = None
-    """FreeImageHost API key。用于在推送通知时显示图片。"""
-
-class UserConfig(ConfigBaseModel, Generic[T]):
-    """用户可以自由添加、删除的配置数据。"""
-
-    name: str = 'default_config'
-    """显示名称。通常由用户输入。"""
-    id: str = uuid.uuid4().hex
-    """唯一标识符。"""
-    category: str = 'default'
-    """类别。如：'global'、'china'、'asia' 等。"""
-    description: str = ''
-    """描述。通常由用户输入。"""
-    backend: BackendConfig = BackendConfig()
-    """后端配置。"""
-    keep_screenshots: bool = False
-    """
-    是否保留截图。
-    若启用，则会保存每一张截图到 `dumps` 目录下。启用该选项有助于辅助调试。
-    """
-    options: T
-    """下游脚本储存的具体数据。"""
-
-
-class RootConfig(ConfigBaseModel, Generic[T]):
-    version: int = 5
-    """配置版本。"""
-    user_configs: list[UserConfig[T]] = []
-    """用户配置。"""
-
+import uuid
+from typing import Generic, TypeVar, Literal
+
+from pydantic import BaseModel, ConfigDict
+
+
+T = TypeVar('T')
+BackendType = Literal['custom', 'mumu12', 'mumu12v5', 'leidian', 'dmm']
+DeviceRecipes = Literal['adb', 'adb_raw', 'uiautomator2', 'windows', 'remote_windows', 'nemu_ipc']
+
+class ConfigBaseModel(BaseModel):
+    model_config = ConfigDict(use_attribute_docstrings=True)
+
+class BackendConfig(ConfigBaseModel):
+    type: BackendType = 'custom'
+    """后端类型。"""
+    instance_id: str | None = None
+    """模拟器实例 ID。"""
+    adb_ip: str = '127.0.0.1'
+    """adb 连接的 ip 地址。"""
+    adb_port: int = 5555
+    """adb 连接的端口。"""
+    adb_emulator_name: str | None = None
+    """
+    adb 连接的模拟器名，用于 自动启动模拟器 功能。
+    
+    雷电模拟器需要设置正确的模拟器名，否则 自动启动模拟器 功能将无法正常工作。
+    其他功能不受影响。
+    """
+    screenshot_impl: DeviceRecipes = 'adb'
+    """
+    截图方法。暂时推荐使用【adb】截图方式。
+
+    如果使用 remote_windows，需要在 adb_ip 中填写远程 Windows 的 IP 地址，在 adb_port 中填写远程 Windows 的端口号。
+    """
+    check_emulator: bool = False
+    """
+    检查并启动模拟器
+
+    启动脚本的时候，如果检测到模拟器未启动，则自动启动模拟器。
+    如果模拟器已经启动，则不启动。
+    """
+    emulator_path: str | None = None
+    """模拟器 exe 文件路径"""
+    emulator_args: str = ""
+    """模拟器启动时的命令行参数"""
+    windows_window_title: str = 'gakumas'
+    """Windows 截图方式的窗口标题"""
+    windows_ahk_path: str | None = None
+    """Windows 截图方式的 AutoHotkey 可执行文件路径，为 None 时使用默认路径"""
+    mumu_background_mode: bool = False
+    """MuMu12 模拟器后台保活模式"""
+    target_screenshot_interval: float | None = None
+    """最小截图间隔，单位为秒。为 None 时不限制截图速度。"""
+
+class PushConfig(ConfigBaseModel):
+    """推送配置。"""
+
+    wx_pusher_enabled: bool = False
+    """是否启用 WxPusher 推送。"""
+    wx_pusher_app_token: str | None = None
+    """WxPusher 的 app token。"""
+    wx_pusher_uid: str | None = None
+    """WxPusher 的 uid。"""
+
+    free_image_host_key: str | None = None
+    """FreeImageHost API key。用于在推送通知时显示图片。"""
+
+class UserConfig(ConfigBaseModel, Generic[T]):
+    """用户可以自由添加、删除的配置数据。"""
+
+    name: str = 'default_config'
+    """显示名称。通常由用户输入。"""
+    id: str = uuid.uuid4().hex
+    """唯一标识符。"""
+    category: str = 'default'
+    """类别。如：'global'、'china'、'asia' 等。"""
+    description: str = ''
+    """描述。通常由用户输入。"""
+    backend: BackendConfig = BackendConfig()
+    """后端配置。"""
+    keep_screenshots: bool = False
+    """
+    是否保留截图。
+    若启用，则会保存每一张截图到 `dumps` 目录下。启用该选项有助于辅助调试。
+    """
+    options: T
+    """下游脚本储存的具体数据。"""
+
+
+class RootConfig(ConfigBaseModel, Generic[T]):
+    version: int = 5
+    """配置版本。"""
+    user_configs: list[UserConfig[T]] = []
+    """用户配置。"""
+

kotonebot/config/manager.py

@@ -1,36 +1,36 @@
-import os
-from typing import Type, Generic, TypeVar
-
-from .base_config import RootConfig, UserConfig
-
-T = TypeVar('T')
-
-def load_config(
-    config_path: str,
-    *,
-    type: Type[T],
-    use_default_if_not_found: bool = True
-) -> RootConfig[T]:
-    """
-    从指定路径读取配置文件
-
-    :param config_path: 配置文件路径
-    :param use_default_if_not_found: 如果配置文件不存在，是否使用默认配置
-    """
-    if not os.path.exists(config_path):
-        if use_default_if_not_found:
-            return RootConfig[type]()
-        else:
-            raise FileNotFoundError(f"Config file not found: {config_path}")
-    
-    with open(config_path, 'r', encoding='utf-8') as f:
-        return RootConfig[type].model_validate_json(f.read())
-
-def save_config(
-    config: RootConfig[T],
-    config_path: str,
-):
-    """将配置保存到指定路径"""
-    RootConfig[T].model_validate(config)
-    with open(config_path, 'w+', encoding='utf-8') as f:
-        f.write(config.model_dump_json(indent=4))
+import os
+from typing import Type, Generic, TypeVar
+
+from .base_config import RootConfig, UserConfig
+
+T = TypeVar('T')
+
+def load_config(
+    config_path: str,
+    *,
+    type: Type[T],
+    use_default_if_not_found: bool = True
+) -> RootConfig[T]:
+    """
+    从指定路径读取配置文件
+
+    :param config_path: 配置文件路径
+    :param use_default_if_not_found: 如果配置文件不存在，是否使用默认配置
+    """
+    if not os.path.exists(config_path):
+        if use_default_if_not_found:
+            return RootConfig[type]()
+        else:
+            raise FileNotFoundError(f"Config file not found: {config_path}")
+    
+    with open(config_path, 'r', encoding='utf-8') as f:
+        return RootConfig[type].model_validate_json(f.read())
+
+def save_config(
+    config: RootConfig[T],
+    config_path: str,
+):
+    """将配置保存到指定路径"""
+    RootConfig[T].model_validate(config)
+    with open(config_path, 'w+', encoding='utf-8') as f:
+        f.write(config.model_dump_json(indent=4))

kotonebot/errors.py

@@ -1,72 +1,77 @@
-from typing import Callable
-
-
-class KotonebotError(Exception):
-    pass
-
-class KotonebotWarning(Warning):
-    pass
-
-class UserFriendlyError(KotonebotError):
-    def __init__(
-        self,
-        message: str,
-        actions: list[tuple[int, str, Callable[[], None]]] = [],
-        *args, **kwargs
-    ) -> None:
-        super().__init__(*args, **kwargs)
-        self.message = message
-        self.actions = actions or []
-
-    @property
-    def action_buttons(self) -> list[tuple[int, str]]:
-        """
-        以 (id: int, btn_text: str) 的形式返回所有按钮定义。
-        """
-        return [(id, text) for id, text, _ in self.actions]
-    
-    def invoke(self, action_id: int):
-        """
-        执行指定 ID 的 action。
-        """
-        for id, _, func in self.actions:
-            if id == action_id:
-                func()
-                break
-        else:
-            raise ValueError(f'Action with id {action_id} not found.')
-
-class UnrecoverableError(KotonebotError):
-    pass
-
-class GameUpdateNeededError(UnrecoverableError):
-    def __init__(self):
-        super().__init__(
-            'Game update required. '
-            'Please go to Play Store and update the game manually.'
-        )
-
-class ResourceFileMissingError(KotonebotError):
-    def __init__(self, file_path: str, description: str):
-        self.file_path = file_path
-        self.description = description
-        super().__init__(f'Resource file ({description}) "{file_path}" is missing.')
-
-class TaskNotFoundError(KotonebotError):
-    def __init__(self, task_id: str):
-        self.task_id = task_id
-        super().__init__(f'Task "{task_id}" not found.')
-
-class UnscalableResolutionError(KotonebotError):
-    def __init__(self, target_resolution: tuple[int, int], screen_size: tuple[int, int]):
-        self.target_resolution = target_resolution
-        self.screen_size = screen_size
-        super().__init__(f'Cannot scale to target resolution {target_resolution}. '
-                         f'Screen size: {screen_size}')
-
-class ContextNotInitializedError(KotonebotError):
-    def __init__(self, msg: str = 'Context not initialized'):
-        super().__init__(msg)
-
-class StopCurrentTask(KotonebotError):
+from typing import Callable
+
+
+class KotonebotError(Exception):
+    pass
+
+class KotonebotWarning(Warning):
+    pass
+
+class MissingDependencyError(KotonebotError, ImportError):
+    def __init__(self, e: ImportError, group_name: str) -> None:
+        self.original_error = e
+        super().__init__(f'Cannot import module "{e.name}". Did you forget to run "pip install kotonebot[{group_name}]"?')
+
+class UserFriendlyError(KotonebotError):
+    def __init__(
+        self,
+        message: str,
+        actions: list[tuple[int, str, Callable[[], None]]] = [],
+        *args, **kwargs
+    ) -> None:
+        super().__init__(*args, **kwargs)
+        self.message = message
+        self.actions = actions or []
+
+    @property
+    def action_buttons(self) -> list[tuple[int, str]]:
+        """
+        以 (id: int, btn_text: str) 的形式返回所有按钮定义。
+        """
+        return [(id, text) for id, text, _ in self.actions]
+    
+    def invoke(self, action_id: int):
+        """
+        执行指定 ID 的 action。
+        """
+        for id, _, func in self.actions:
+            if id == action_id:
+                func()
+                break
+        else:
+            raise ValueError(f'Action with id {action_id} not found.')
+
+class UnrecoverableError(KotonebotError):
+    pass
+
+class GameUpdateNeededError(UnrecoverableError):
+    def __init__(self):
+        super().__init__(
+            'Game update required. '
+            'Please go to Play Store and update the game manually.'
+        )
+
+class ResourceFileMissingError(KotonebotError):
+    def __init__(self, file_path: str, description: str):
+        self.file_path = file_path
+        self.description = description
+        super().__init__(f'Resource file ({description}) "{file_path}" is missing.')
+
+class TaskNotFoundError(KotonebotError):
+    def __init__(self, task_id: str):
+        self.task_id = task_id
+        super().__init__(f'Task "{task_id}" not found.')
+
+class UnscalableResolutionError(KotonebotError):
+    def __init__(self, target_resolution: tuple[int, int], screen_size: tuple[int, int]):
+        self.target_resolution = target_resolution
+        self.screen_size = screen_size
+        super().__init__(f'Cannot scale to target resolution {target_resolution}. '
+                         f'Screen size: {screen_size}')
+
+class ContextNotInitializedError(KotonebotError):
+    def __init__(self, msg: str = 'Context not initialized'):
+        super().__init__(msg)
+
+class StopCurrentTask(KotonebotError):
     pass

kotonebot/interop/win/__init__.py

@@ -0,0 +1,10 @@
+# ruff: noqa: E402
+from kotonebot.util import require_windows
+require_windows('kotonebot.interop.win module')
+
+
+from . import _mouse as mouse
+
+__all__ = [
+    'mouse',
+]