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

kotonebot/backend/core.py

@@ -1,126 +1,129 @@
-import logging
-from functools import cache
-from typing import Callable
-
-import cv2
-from cv2.typing import MatLike
-
-from kotonebot.util import cv2_imread
-from kotonebot.primitives import RectTuple, Rect, Point
-from kotonebot.errors import ResourceFileMissingError
-
-class Ocr:
-    def __init__(
-        self,
-        text: str | Callable[[str], bool],
-        *,
-        language: str = 'jp',
-    ):
-        self.text = text
-        self.language = language
-
-
-class Image:
-    def __init__(
-        self,
-        *,
-        path: str | None = None,
-        name: str | None = 'untitled',
-        data: MatLike | None = None,
-    ):
-        self.path = path
-        self.name = name
-        self.__data: MatLike | None = data
-        self.__data_with_alpha: MatLike | None = None
-
-    @cache
-    def binary(self) -> 'Image':
-        return Image(data=cv2.cvtColor(self.data, cv2.COLOR_BGR2GRAY))
-
-    @property
-    def data(self) -> MatLike:
-        if self.__data is None:
-            if self.path is None:
-                raise ValueError('Either path or data must be provided.')
-            self.__data = cv2_imread(self.path)
-            if self.__data is None:
-                raise ResourceFileMissingError(self.path, 'sprite')
-            logger.debug(f'Read image "{self.name}" from {self.path}')
-        return self.__data
-    
-    @property
-    def data_with_alpha(self) -> MatLike:
-        if self.__data_with_alpha is None:
-            if self.path is None:
-                raise ValueError('Either path or data must be provided.')
-            self.__data_with_alpha = cv2_imread(self.path, cv2.IMREAD_UNCHANGED)
-            if self.__data_with_alpha is None:
-                raise ResourceFileMissingError(self.path, 'sprite with alpha')
-            logger.debug(f'Read image "{self.name}" from {self.path}')
-        return self.__data_with_alpha
-    
-    def __repr__(self) -> str:
-        if self.path is None:
-            return f'<Image: memory>'
-        else:
-            return f'<Image: "{self.name}" at {self.path}>'
-
-
-class HintBox(Rect):
-    def __init__(
-        self,
-        x1: int,
-        y1: int,
-        x2: int,
-        y2: int,
-        *,
-        name: str | None = None,
-        description: str | None = None,
-        source_resolution: tuple[int, int],
-    ):
-        super().__init__(x1, y1, x2 - x1, y2 - y1, name=name)
-        self.description = description
-        self.source_resolution = source_resolution
-
-    @property
-    def width(self) -> int:
-        return self.x2 - self.x1
-    
-    @property
-    def height(self) -> int:
-        return self.y2 - self.y1
-    
-    @property
-    def rect(self) -> RectTuple:
-        return self.x1, self.y1, self.width, self.height
-
-class HintPoint(Point):
-    def __init__(self, x: int, y: int, *, name: str | None = None, description: str | None = None):
-        super().__init__(x, y, name=name)
-        self.description = description
-
-    def __repr__(self) -> str:
-        return f'HintPoint<"{self.name}" at ({self.x}, {self.y})>'
-
-def unify_image(image: MatLike | str | Image, transparent: bool = False) -> MatLike:
-    if isinstance(image, str):
-        if not transparent:
-            image = cv2_imread(image)
-        else:
-            image = cv2_imread(image, cv2.IMREAD_UNCHANGED)
-    elif isinstance(image, Image):
-        if transparent:
-            image = image.data_with_alpha
-        else:
-            image = image.data
-    return image
-
-logger = logging.getLogger(__name__)
-
-
-if __name__ == '__main__':
-    hint_box = HintBox(100, 100, 200, 200, source_resolution=(1920, 1080))
-    print(hint_box.rect)
-    print(hint_box.width)
-    print(hint_box.height)
-
+import logging
+from functools import cache
+from typing import Callable
+from typing_extensions import deprecated
+
+import cv2
+from cv2.typing import MatLike
+
+from kotonebot.util import cv2_imread
+from kotonebot.primitives import RectTuple, Rect, Point
+from kotonebot.errors import ResourceFileMissingError
+
+@deprecated('unused')
+class Ocr:
+    def __init__(
+        self,
+        text: str | Callable[[str], bool],
+        *,
+        language: str = 'jp',
+    ):
+        self.text = text
+        self.language = language
+
+# TODO: 这个类和 kotonebot.primitives.Image 重复了
+@deprecated('Use kotonebot.primitives.Image instead.')
+class Image:
+    def __init__(
+        self,
+        *,
+        path: str | None = None,
+        name: str | None = 'untitled',
+        data: MatLike | None = None,
+    ):
+        self.path = path
+        self.name = name
+        self.__data: MatLike | None = data
+        self.__data_with_alpha: MatLike | None = None
+
+    @cache
+    def binary(self) -> 'Image':
+        return Image(data=cv2.cvtColor(self.data, cv2.COLOR_BGR2GRAY))
+
+    @property
+    def data(self) -> MatLike:
+        if self.__data is None:
+            if self.path is None:
+                raise ValueError('Either path or data must be provided.')
+            self.__data = cv2_imread(self.path)
+            if self.__data is None:
+                raise ResourceFileMissingError(self.path, 'sprite')
+            logger.debug(f'Read image "{self.name}" from {self.path}')
+        return self.__data
+    
+    @property
+    def data_with_alpha(self) -> MatLike:
+        if self.__data_with_alpha is None:
+            if self.path is None:
+                raise ValueError('Either path or data must be provided.')
+            self.__data_with_alpha = cv2_imread(self.path, cv2.IMREAD_UNCHANGED)
+            if self.__data_with_alpha is None:
+                raise ResourceFileMissingError(self.path, 'sprite with alpha')
+            logger.debug(f'Read image "{self.name}" from {self.path}')
+        return self.__data_with_alpha
+    
+    def __repr__(self) -> str:
+        if self.path is None:
+            return f'<Image: memory>'
+        else:
+            return f'<Image: "{self.name}" at {self.path}>'
+
+# TODO: 这里的其他类应该移动到 primitives 模块下面
+class HintBox(Rect):
+    def __init__(
+        self,
+        x1: int,
+        y1: int,
+        x2: int,
+        y2: int,
+        *,
+        name: str | None = None,
+        description: str | None = None,
+        source_resolution: tuple[int, int],
+    ):
+        super().__init__(x1, y1, x2 - x1, y2 - y1, name=name)
+        self.description = description
+        self.source_resolution = source_resolution
+
+    @property
+    def width(self) -> int:
+        return self.x2 - self.x1
+    
+    @property
+    def height(self) -> int:
+        return self.y2 - self.y1
+    
+    @property
+    def rect(self) -> RectTuple:
+        return self.x1, self.y1, self.width, self.height
+
+class HintPoint(Point):
+    def __init__(self, x: int, y: int, *, name: str | None = None, description: str | None = None):
+        super().__init__(x, y, name=name)
+        self.description = description
+
+    def __repr__(self) -> str:
+        return f'HintPoint<"{self.name}" at ({self.x}, {self.y})>'
+
+def unify_image(image: MatLike | str | Image, transparent: bool = False) -> MatLike:
+    if isinstance(image, str):
+        if not transparent:
+            image = cv2_imread(image)
+        else:
+            image = cv2_imread(image, cv2.IMREAD_UNCHANGED)
+    elif isinstance(image, Image):
+        if transparent:
+            image = image.data_with_alpha
+        else:
+            image = image.data
+    return image
+
+logger = logging.getLogger(__name__)
+
+
+if __name__ == '__main__':
+    hint_box = HintBox(100, 100, 200, 200, source_resolution=(1920, 1080))
+    print(hint_box.rect)
+    print(hint_box.width)
+    print(hint_box.height)
+

kotonebot/backend/debug/entry.py

@@ -1,89 +1,89 @@
-import os
-import runpy
-import shutil
-import argparse
-import importlib
-from pathlib import Path
-from threading import Thread
-
-from . import debug
-from kotonebot import logging
-from kotonebot.backend.context import init_context
-
-logger = logging.getLogger(__name__)
-
-def _task_thread(task_module: str):
-    """任务线程。"""
-    runpy.run_module(task_module, run_name="__main__")
-
-def _parse_args():
-    """解析命令行参数。"""
-    parser = argparse.ArgumentParser(description='KotoneBot visual debug tool')
-    parser.add_argument(
-        '-s', '--save', 
-        help='Save dump image and results to the specified folder',
-        type=str,
-        metavar='PATH'
-    )
-    parser.add_argument(
-        '-c', '--clear',
-        help='Clear the dump folder before running',
-        action='store_true'
-    )
-    parser.add_argument(
-        '-t', '--config-type',
-        help='The full path of the config data type. e.g. `kotonebot.tasks.common.BaseConfig`',
-        type=str,
-        metavar='TYPE',
-        required=True
-    )
-    parser.add_argument(
-        'input_module',
-        help='The module to run'
-    )
-    return parser.parse_args()
-
-def _start_task_thread(module: str):
-    """启动任务线程。"""
-    thread = Thread(target=_task_thread, args=(module,))
-    thread.start()
-
-if __name__ == "__main__":
-    args = _parse_args()
-    debug.enabled = True
-    
-    # 设置保存路径
-    if args.save:
-        save_path = Path(args.save)
-        debug.auto_save_to_folder = str(save_path)
-        if not os.path.exists(save_path):
-            os.makedirs(save_path)
-    if args.clear:
-        if debug.auto_save_to_folder:
-            try:
-                logger.info(f"Removing {debug.auto_save_to_folder}")
-                shutil.rmtree(debug.auto_save_to_folder)
-            except PermissionError:
-                logger.warning(f"Failed to remove {debug.auto_save_to_folder}. Trying to remove all contents instead.")
-                for root, dirs, files in os.walk(debug.auto_save_to_folder):
-                    for file in files:
-                        try:
-                            os.remove(os.path.join(root, file))
-                        except PermissionError:
-                            raise
-                
-
-    # 初始化上下文
-    module_name, class_name = args.config_type.rsplit('.', 1)
-    class_ = importlib.import_module(module_name).__getattribute__(class_name)
-    init_context(config_type=class_)
-    
-    # 启动服务器
-    from .server import app
-    import uvicorn
-    
-    # 启动任务线程
-    _start_task_thread(args.input_module)
-    
-    # 启动服务器
-    uvicorn.run(app, host="127.0.0.1", port=8000, log_level='critical' if debug.hide_server_log else None)
+import os
+import runpy
+import shutil
+import argparse
+import importlib
+from pathlib import Path
+from threading import Thread
+
+from . import debug
+from kotonebot import logging
+from kotonebot.backend.context import init_context
+
+logger = logging.getLogger(__name__)
+
+def _task_thread(task_module: str):
+    """任务线程。"""
+    runpy.run_module(task_module, run_name="__main__")
+
+def _parse_args():
+    """解析命令行参数。"""
+    parser = argparse.ArgumentParser(description='KotoneBot visual debug tool')
+    parser.add_argument(
+        '-s', '--save', 
+        help='Save dump image and results to the specified folder',
+        type=str,
+        metavar='PATH'
+    )
+    parser.add_argument(
+        '-c', '--clear',
+        help='Clear the dump folder before running',
+        action='store_true'
+    )
+    parser.add_argument(
+        '-t', '--config-type',
+        help='The full path of the config data type. e.g. `kotonebot.tasks.common.BaseConfig`',
+        type=str,
+        metavar='TYPE',
+        required=True
+    )
+    parser.add_argument(
+        'input_module',
+        help='The module to run'
+    )
+    return parser.parse_args()
+
+def _start_task_thread(module: str):
+    """启动任务线程。"""
+    thread = Thread(target=_task_thread, args=(module,))
+    thread.start()
+
+if __name__ == "__main__":
+    args = _parse_args()
+    debug.enabled = True
+    
+    # 设置保存路径
+    if args.save:
+        save_path = Path(args.save)
+        debug.auto_save_to_folder = str(save_path)
+        if not os.path.exists(save_path):
+            os.makedirs(save_path)
+    if args.clear:
+        if debug.auto_save_to_folder:
+            try:
+                logger.info(f"Removing {debug.auto_save_to_folder}")
+                shutil.rmtree(debug.auto_save_to_folder)
+            except PermissionError:
+                logger.warning(f"Failed to remove {debug.auto_save_to_folder}. Trying to remove all contents instead.")
+                for root, dirs, files in os.walk(debug.auto_save_to_folder):
+                    for file in files:
+                        try:
+                            os.remove(os.path.join(root, file))
+                        except PermissionError:
+                            raise
+                
+
+    # 初始化上下文
+    module_name, class_name = args.config_type.rsplit('.', 1)
+    class_ = importlib.import_module(module_name).__getattribute__(class_name)
+    init_context(config_type=class_)
+    
+    # 启动服务器
+    from .server import app
+    import uvicorn
+    
+    # 启动任务线程
+    _start_task_thread(args.input_module)
+    
+    # 启动服务器
+    uvicorn.run(app, host="127.0.0.1", port=8000, log_level='critical' if debug.hide_server_log else None)

kotonebot/backend/debug/mock.py

@@ -1,79 +1,79 @@
-import time
-from typing_extensions import override
-
-import cv2
-from cv2.typing import MatLike
-
-from kotonebot import sleep
-from kotonebot.client.device import Device
-
-class Video:
-    def __init__(self, path: str, fps: int):
-        self.path = path
-        self.fps = fps
-        self.paused = False
-        """是否暂停"""
-        self.__cap = cv2.VideoCapture(path)
-        self.__last_frame = None
-        self.__last_time = 0
-
-    def __iter__(self):
-        return self
-
-    def __next__(self):
-        if self.paused:
-            return self.__last_frame
-        ret, frame = self.__cap.read()
-        if not ret:
-            raise StopIteration
-        self.__last_frame = frame
-        self.__last_time = time.time()
-        if self.__last_time - time.time() < 1 / self.fps:
-            sleep(1 / self.fps)
-        return frame
-
-    def pause(self):
-        self.paused = True
-
-    def resume(self):
-        self.paused = False
-
-class MockDevice(Device):
-    def __init__(
-        self
-    ):
-        super().__init__()
-        self.__video_stream = None
-        self.__image = None
-        self.__screen_size = None
-
-    def load_video(self, path: str, fps: int):
-        self.__video_stream = Video(path, fps)
-        return self.__video_stream
-
-    def load_image(self, img: str | MatLike):
-        if isinstance(img, str):
-            self.__image = cv2.imread(img)
-        else:
-            self.__image = img
-        return self.__image
-
-    def set_screen_size(self, width: int, height: int):
-        self.__screen_size = (width, height)
-
-    @override
-    def screenshot(self):
-        if self.__image is not None:
-            return self.__image
-        elif self.__video_stream is not None:
-            return next(self.__video_stream)
-        else:
-            raise RuntimeError('No video stream loaded')
-        
-    @property
-    @override
-    def screen_size(self):
-        if self.__screen_size is not None:
-            return self.__screen_size
-        else:
+import time
+from typing_extensions import override
+
+import cv2
+from cv2.typing import MatLike
+
+from kotonebot import sleep
+from kotonebot.client.device import Device
+
+class Video:
+    def __init__(self, path: str, fps: int):
+        self.path = path
+        self.fps = fps
+        self.paused = False
+        """是否暂停"""
+        self.__cap = cv2.VideoCapture(path)
+        self.__last_frame = None
+        self.__last_time = 0
+
+    def __iter__(self):
+        return self
+
+    def __next__(self):
+        if self.paused:
+            return self.__last_frame
+        ret, frame = self.__cap.read()
+        if not ret:
+            raise StopIteration
+        self.__last_frame = frame
+        self.__last_time = time.time()
+        if self.__last_time - time.time() < 1 / self.fps:
+            sleep(1 / self.fps)
+        return frame
+
+    def pause(self):
+        self.paused = True
+
+    def resume(self):
+        self.paused = False
+
+class MockDevice(Device):
+    def __init__(
+        self
+    ):
+        super().__init__()
+        self.__video_stream = None
+        self.__image = None
+        self.__screen_size = None
+
+    def load_video(self, path: str, fps: int):
+        self.__video_stream = Video(path, fps)
+        return self.__video_stream
+
+    def load_image(self, img: str | MatLike):
+        if isinstance(img, str):
+            self.__image = cv2.imread(img)
+        else:
+            self.__image = img
+        return self.__image
+
+    def set_screen_size(self, width: int, height: int):
+        self.__screen_size = (width, height)
+
+    @override
+    def screenshot(self):
+        if self.__image is not None:
+            return self.__image
+        elif self.__video_stream is not None:
+            return next(self.__video_stream)
+        else:
+            raise RuntimeError('No video stream loaded')
+        
+    @property
+    @override
+    def screen_size(self):
+        if self.__screen_size is not None:
+            return self.__screen_size
+        else:
             raise RuntimeError('No screen size set')