MaaFw 4.5.5__py3-none-win_arm64.whl → 5.0.0a1__py3-none-win_arm64.whl

maa/tasker.py

@@ -7,13 +7,12 @@ from .define import *
 from .library import Library
 from .buffer import ImageListBuffer, RectBuffer, StringBuffer, ImageBuffer
 from .job import Job, JobWithResult
-from .notification_handler import NotificationHandler
+from .event_sink import EventSink, NotificationType
 from .resource import Resource
 from .controller import Controller
 
 
 class Tasker:
-    _notification_handler: Optional[NotificationHandler]
     _handle: MaaTaskerHandle
     _own: bool
 
@@ -21,19 +20,21 @@ class Tasker:
 
     def __init__(
         self,
-        notification_handler: Optional[NotificationHandler] = None,
+        notification_handler: None = None,
         handle: Optional[MaaTaskerHandle] = None,
     ):
+        if notification_handler:
+            raise NotImplementedError(
+                "NotificationHandler is deprecated, use add_sink, add_context_sink instead."
+            )
+
         self._set_api_properties()
 
         if handle:
             self._handle = handle
             self._own = False
         else:
-            self._notification_handler = notification_handler
-            self._handle = Library.framework().MaaTaskerCreate(
-                *NotificationHandler._gen_c_param(self._notification_handler)
-            )
+            self._handle = Library.framework().MaaTaskerCreate()
             self._own = True
 
         if not self._handle:
@@ -112,64 +113,55 @@ class Tasker:
     def clear_cache(self) -> bool:
         return bool(Library.framework().MaaTaskerClearCache(self._handle))
 
-    @staticmethod
-    def set_log_dir(path: Union[Path, str]) -> bool:
-        strpath = str(path)
-        return bool(
-            Library.framework().MaaSetGlobalOption(
-                MaaOption(MaaGlobalOptionEnum.LogDir),
-                strpath.encode(),
-                len(strpath),
-            )
-        )
+    _sink_holder: Dict[int, "TaskerEventSink"] = {}
 
-    @staticmethod
-    def set_save_draw(save_draw: bool) -> bool:
-        cbool = ctypes.c_bool(save_draw)
-        return bool(
-            Library.framework().MaaSetGlobalOption(
-                MaaOption(MaaGlobalOptionEnum.SaveDraw),
-                ctypes.pointer(cbool),
-                ctypes.sizeof(ctypes.c_bool),
+    def add_sink(self, sink: "TaskerEventSink") -> Optional[int]:
+        sink_id = int(
+            Library.framework().MaaTaskerAddSink(
+                self._handle, *EventSink._gen_c_param(sink)
             )
         )
+        if sink_id == MaaInvalidId:
+            return None
 
-    @staticmethod
-    def set_recording(recording: bool) -> bool:
-        """
-        Deprecated
-        """
-        return False
+        self._sink_holder[sink_id] = sink
+        return sink_id
 
-    @staticmethod
-    def set_stdout_level(level: LoggingLevelEnum) -> bool:
-        clevel = MaaLoggingLevel(level)
-        return bool(
-            Library.framework().MaaSetGlobalOption(
-                MaaOption(MaaGlobalOptionEnum.StdoutLevel),
-                ctypes.pointer(clevel),
-                ctypes.sizeof(MaaLoggingLevel),
-            )
-        )
+    def remove_sink(self, sink_id: int) -> None:
+        Library.framework().MaaTaskerRemoveSink(self._handle, sink_id)
+        self._sink_holder.pop(sink_id)
 
-    @staticmethod
-    def set_debug_mode(debug_mode: bool) -> bool:
-        cbool = ctypes.c_bool(debug_mode)
-        return bool(
-            Library.framework().MaaSetGlobalOption(
-                MaaOption(MaaGlobalOptionEnum.DebugMode),
-                ctypes.pointer(cbool),
-                ctypes.sizeof(ctypes.c_bool),
+    def clear_sinks(self) -> None:
+        Library.framework().MaaTaskerClearSinks(self._handle)
+
+    def add_context_sink(self, sink: "ContextEventSink") -> Optional[int]:
+        sink_id = int(
+            Library.framework().MaaTaskerAddContextSink(
+                self._handle, *EventSink._gen_c_param(sink)
             )
         )
+        if sink_id == MaaInvalidId:
+            return None
+
+        self._sink_holder[sink_id] = sink
+        return sink_id
+
+    def remove_context_sink(self, sink_id: int) -> None:
+        Library.framework().MaaTaskerRemoveContextSink(self._handle, sink_id)
+        self._sink_holder.pop(sink_id)
+
+    def clear_context_sinks(self) -> None:
+        Library.framework().MaaTaskerClearContextSinks(self._handle)
 
     ### private ###
 
     @staticmethod
     def _gen_post_param(entry: str, pipeline_override: Dict) -> Tuple[bytes, bytes]:
+        pipeline_json = json.dumps(pipeline_override, ensure_ascii=False)
+
         return (
             entry.encode(),
-            json.dumps(pipeline_override, ensure_ascii=False).encode(),
+            pipeline_json.encode(),
         )
 
     def _gen_task_job(self, taskid: MaaTaskId) -> JobWithResult:
@@ -188,7 +180,7 @@ class Tasker:
 
     def get_recognition_detail(self, reco_id: int) -> Optional[RecognitionDetail]:
         name = StringBuffer()
-        algorithm = StringBuffer()
+        algorithm = StringBuffer()  # type: ignore
         hit = MaaBool()
         box = RectBuffer()
         detail_json = StringBuffer()
@@ -296,6 +288,66 @@ class Tasker:
             task_id=task_id, entry=entry.get(), nodes=nodes, status=Status(status)
         )
 
+    @staticmethod
+    def set_log_dir(path: Union[Path, str]) -> bool:
+        strpath = str(path)
+        return bool(
+            Library.framework().MaaGlobalSetOption(
+                MaaOption(MaaGlobalOptionEnum.LogDir),
+                strpath.encode(),
+                len(strpath),
+            )
+        )
+
+    @staticmethod
+    def set_save_draw(save_draw: bool) -> bool:
+        cbool = ctypes.c_bool(save_draw)
+        return bool(
+            Library.framework().MaaGlobalSetOption(
+                MaaOption(MaaGlobalOptionEnum.SaveDraw),
+                ctypes.pointer(cbool),
+                ctypes.sizeof(ctypes.c_bool),
+            )
+        )
+
+    @staticmethod
+    def set_recording(recording: bool) -> bool:
+        """
+        Deprecated
+        """
+        return False
+
+    @staticmethod
+    def set_stdout_level(level: LoggingLevelEnum) -> bool:
+        clevel = MaaLoggingLevel(level)
+        return bool(
+            Library.framework().MaaGlobalSetOption(
+                MaaOption(MaaGlobalOptionEnum.StdoutLevel),
+                ctypes.pointer(clevel),
+                ctypes.sizeof(MaaLoggingLevel),
+            )
+        )
+
+    @staticmethod
+    def set_debug_mode(debug_mode: bool) -> bool:
+        cbool = ctypes.c_bool(debug_mode)
+        return bool(
+            Library.framework().MaaGlobalSetOption(
+                MaaOption(MaaGlobalOptionEnum.DebugMode),
+                ctypes.pointer(cbool),
+                ctypes.sizeof(ctypes.c_bool),
+            )
+        )
+
+    @staticmethod
+    def load_plugin(path: Union[Path, str]) -> bool:
+        strpath = str(path)
+        return bool(
+            Library.framework().MaaGlobalLoadPlugin(
+                strpath.encode(),
+            )
+        )
+
     _api_properties_initialized: bool = False
 
     @staticmethod
@@ -330,12 +382,21 @@ class Tasker:
             return
         Tasker._api_properties_initialized = True
 
-        Library.framework().MaaTaskerCreate.restype = MaaTaskerHandle
-        Library.framework().MaaTaskerCreate.argtypes = [
-            MaaNotificationCallback,
-            ctypes.c_void_p,
+        Library.framework().MaaGlobalSetOption.restype = MaaBool
+        Library.framework().MaaGlobalSetOption.argtypes = [
+            MaaGlobalOption,
+            MaaOptionValue,
+            MaaOptionValueSize,
+        ]
+
+        Library.framework().MaaGlobalLoadPlugin.restype = MaaBool
+        Library.framework().MaaGlobalLoadPlugin.argtypes = [
+            ctypes.c_char_p,
         ]
 
+        Library.framework().MaaTaskerCreate.restype = MaaTaskerHandle
+        Library.framework().MaaTaskerCreate.argtypes = []
+
         Library.framework().MaaTaskerDestroy.restype = None
         Library.framework().MaaTaskerDestroy.argtypes = [MaaTaskerHandle]
 
@@ -432,9 +493,65 @@ class Tasker:
             MaaTaskerHandle,
         ]
 
-        Library.framework().MaaSetGlobalOption.restype = MaaBool
-        Library.framework().MaaSetGlobalOption.argtypes = [
-            MaaGlobalOption,
-            MaaOptionValue,
-            MaaOptionValueSize,
+        Library.framework().MaaTaskerAddSink.restype = MaaSinkId
+        Library.framework().MaaTaskerAddSink.argtypes = [
+            MaaTaskerHandle,
+            MaaEventCallback,
+            ctypes.c_void_p,
+        ]
+
+        Library.framework().MaaTaskerRemoveSink.restype = None
+        Library.framework().MaaTaskerRemoveSink.argtypes = [
+            MaaTaskerHandle,
+            MaaSinkId,
+        ]
+
+        Library.framework().MaaTaskerClearSinks.restype = None
+        Library.framework().MaaTaskerClearSinks.argtypes = [MaaTaskerHandle]
+
+        Library.framework().MaaTaskerAddContextSink.restype = MaaSinkId
+        Library.framework().MaaTaskerAddContextSink.argtypes = [
+            MaaTaskerHandle,
+            MaaEventCallback,
+            ctypes.c_void_p,
         ]
+
+        Library.framework().MaaTaskerRemoveContextSink.restype = None
+        Library.framework().MaaTaskerRemoveContextSink.argtypes = [
+            MaaTaskerHandle,
+            MaaSinkId,
+        ]
+
+        Library.framework().MaaTaskerClearContextSinks.restype = None
+        Library.framework().MaaTaskerClearContextSinks.argtypes = [MaaTaskerHandle]
+
+
+class TaskerEventSink(EventSink):
+
+    @dataclass
+    class TaskerTaskDetail:
+        task_id: int
+        entry: str
+        uuid: str
+        hash: str
+
+    def on_tasker_task(
+        self, tasker: Tasker, noti_type: NotificationType, detail: TaskerTaskDetail
+    ):
+        pass
+
+    def on_raw_notification(self, handle: ctypes.c_void_p, msg: str, details: dict):
+
+        tasker = Tasker(handle=handle)
+        noti_type = EventSink._notification_type(msg)
+
+        if msg.startswith("Tasker.Task"):
+            detail = self.TaskerTaskDetail(
+                task_id=details["task_id"],
+                entry=details["entry"],
+                uuid=details["uuid"],
+                hash=details["hash"],
+            )
+            self.on_tasker_task(tasker, noti_type, detail)
+        else:
+            self.on_unknown_notification(tasker, msg, details)

maa/toolkit.py

@@ -3,11 +3,9 @@ import json
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Dict, List, Union, Optional, Any
-from collections import defaultdict
 
 from .define import *
 from .library import Library
-from .notification_handler import NotificationHandler
 
 
 @dataclass
@@ -122,70 +120,9 @@ class Toolkit:
         Library.toolkit().MaaToolkitDesktopWindowListDestroy(list_handle)
         return windows
 
-    @staticmethod
-    def pi_register_custom_recognition(
-        name: str, recognition: "CustomRecognition", inst_id: int = 0  # type: ignore
-    ) -> bool:
-        Toolkit._set_api_properties()
-
-        # avoid gc
-        Toolkit._pi_custom_recognition_holder[inst_id][name] = recognition
-
-        return bool(
-            Library.toolkit().MaaToolkitProjectInterfaceRegisterCustomRecognition(
-                ctypes.c_uint64(inst_id),
-                name.encode(),
-                recognition.c_handle,
-                recognition.c_arg,
-            )
-        )
-
-    @staticmethod
-    def pi_register_custom_action(
-        name: str, action: "CustomAction", inst_id: int = 0  # type: ignore
-    ) -> bool:
-        Toolkit._set_api_properties()
-
-        # avoid gc
-        Toolkit._pi_custom_recognition_holder[inst_id][name] = action
-
-        return bool(
-            Library.toolkit().MaaToolkitProjectInterfaceRegisterCustomAction(
-                ctypes.c_uint64(inst_id),
-                name.encode(),
-                action.c_handle,
-                action.c_arg,
-            ),
-        )
-
-    @staticmethod
-    def pi_run_cli(
-        resource_path: Union[str, Path],
-        user_path: Union[str, Path],
-        directly: bool = False,
-        notification_handler: Optional[NotificationHandler] = None,
-        inst_id: int = 0,
-    ) -> bool:
-        Toolkit._set_api_properties()
-
-        Toolkit._pi_notification_handler = notification_handler
-
-        return bool(
-            Library.toolkit().MaaToolkitProjectInterfaceRunCli(
-                ctypes.c_uint64(inst_id),
-                str(resource_path).encode(),
-                str(user_path).encode(),
-                directly,
-                *NotificationHandler._gen_c_param(Toolkit._pi_notification_handler),
-            )
-        )
-
     ### private ###
 
     _api_properties_initialized: bool = False
-    _pi_custom_recognition_holder = defaultdict(dict)
-    _pi_custom_action_holder = defaultdict(dict)
-    _pi_notification_handler: Optional[NotificationHandler] = None
 
     @staticmethod
     def _set_api_properties():
@@ -305,31 +242,3 @@ class Toolkit:
         Library.toolkit().MaaToolkitDesktopWindowGetWindowName.argtypes = [
             MaaToolkitDesktopWindowHandle
         ]
-
-        Library.toolkit().MaaToolkitProjectInterfaceRegisterCustomRecognition.restype = (
-            None
-        )
-        Library.toolkit().MaaToolkitProjectInterfaceRegisterCustomRecognition.argtypes = [
-            ctypes.c_uint64,
-            ctypes.c_char_p,
-            MaaCustomRecognitionCallback,
-            ctypes.c_void_p,
-        ]
-
-        Library.toolkit().MaaToolkitProjectInterfaceRegisterCustomAction.restype = None
-        Library.toolkit().MaaToolkitProjectInterfaceRegisterCustomAction.argtypes = [
-            ctypes.c_uint64,
-            ctypes.c_char_p,
-            MaaCustomActionCallback,
-            ctypes.c_void_p,
-        ]
-
-        Library.toolkit().MaaToolkitProjectInterfaceRunCli.restype = MaaBool
-        Library.toolkit().MaaToolkitProjectInterfaceRunCli.argtypes = [
-            ctypes.c_uint64,
-            ctypes.c_char_p,
-            ctypes.c_char_p,
-            MaaBool,
-            MaaNotificationCallback,
-            ctypes.c_void_p,
-        ]

{maafw-4.5.5.dist-info → maafw-5.0.0a1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MaaFw
-Version: 4.5.5
+Version: 5.0.0a1
 Summary: An automation black-box testing framework based on image recognition
 Project-URL: Homepage, https://github.com/MaaXYZ/MaaFramework
 Author: MaaXYZ
@@ -35,7 +35,7 @@ _✨ 基于图像识别的自动化黑盒测试框架 ✨_
   <img alt="activity" src="https://img.shields.io/github/commit-activity/m/MaaXYZ/MaaFramework?color=%23ff69b4">
   <img alt="stars" src="https://img.shields.io/github/stars/MaaXYZ/MaaFramework?style=social">
   <br>
-  <a href="https://pypi.org/project/MaaFw/" target="_blank"><img alt="pypi" src="https://img.shields.io/badge/PyPI-3775A9?logo=pypi&logoColor=white"></a>
+  <a href="https://pypi.org/project/MaaFw/" target="_blank"><img alt="pypi" src="https://img.shields.io/pypi/dm/maafw?logo=pypi&label=PyPI"></a>
   <a href="https://www.nuget.org/packages/Maa.Framework.Runtimes" target="_blank"><img alt="nuget" src="https://img.shields.io/badge/NuGet-004880?logo=nuget"></a>
   <a href="https://www.npmjs.com/package/@maaxyz/maa-node" target="_blank"><img alt="npm" src="https://img.shields.io/badge/npm-CB3837?logo=npm"></a>
   <a href="https://mirrorchyan.com/zh/projects?source=maafw-badge" target="_blank"><img alt="mirrorc" src="https://img.shields.io/badge/Mirror%E9%85%B1-%239af3f6?logo=countingworkspro&logoColor=4f46e5"></a>
@@ -55,6 +55,9 @@ _✨ 基于图像识别的自动化黑盒测试框架 ✨_
 
 ## 即刻开始
 
+> [!TIP]
+> 访问我们的 [官网](https://maafw.xyz/) 以获得更优秀的文档阅读体验。
+
 - [快速开始](docs/zh_cn/1.1-快速开始.md)
 - [集成文档](docs/zh_cn/2.1-集成文档.md)
 - [Pipeline 协议](docs/zh_cn/3.1-任务流水线协议.md)
@@ -144,7 +147,9 @@ _✨ 基于图像识别的自动化黑盒测试框架 ✨_
 
 - [SLIMEIM_Maa](https://github.com/miaojiuqing/SLIMEIM_Maa) ![Pipeline](https://img.shields.io/badge/Pipeline-%23876f69?logo=paddypower&logoColor=%23FFFFFF) ![Python](https://img.shields.io/badge/Python-3776AB?logo=python&logoColor=white) ![license](https://img.shields.io/github/license/miaojiuqing/SLIMEIM_Maa) ![activity](https://img.shields.io/github/commit-activity/m/miaojiuqing/SLIMEIM_Maa?color=%23ff69b4) ![stars](https://img.shields.io/github/stars/miaojiuqing/SLIMEIM_Maa?style=social) [![mirrorc](https://img.shields.io/badge/Mirror%E9%85%B1-%239af3f6?logo=countingworkspro&logoColor=4f46e5)](https://mirrorchyan.com/zh/projects?source=maafw-badge&rid=SLIMEIM_Maa)  
   魔王与龙的建国谭小助手。使用图像识别+模拟控制技术，解放双手！由 MaaFramework 强力驱动！
-
+  
+- [Maa_bbb](https://github.com/miaojiuqing/Maa_bbb) ![Pipeline](https://img.shields.io/badge/Pipeline-%23876f69?logo=paddypower&logoColor=%23FFFFFF) ![Python](https://img.shields.io/badge/Python-3776AB?logo=python&logoColor=white) ![license](https://img.shields.io/github/license/miaojiuqing/Maa_bbb) ![activity](https://img.shields.io/github/commit-activity/m/miaojiuqing/Maa_bbb?color=%23ff69b4) ![stars](https://img.shields.io/github/stars/miaojiuqing/Maa_bbb?style=social) [![mirrorc](https://img.shields.io/badge/Mirror%E9%85%B1-%239af3f6?logo=countingworkspro&logoColor=4f46e5)](https://mirrorchyan.com/zh/projects?rid=Maa_bbb)  
+  崩坏三小助手。使用图像识别+模拟控制技术，解放双手！PC端与模拟器端同步支持，由 MaaFramework 强力驱动！
 
 ## 生态共建
 

maafw-5.0.0a1.dist-info/RECORD

@@ -0,0 +1,34 @@
+maa/__init__.py,sha256=t2Z9yJWrSZfH16xYN67bKpiPEHDf7iaiw4wi0PjmU8U,250
+maa/agent_client.py,sha256=qx1-3VGp97JB_UMlbkvK-O_GTigbdqD6U4gGKi2yQW4,4049
+maa/buffer.py,sha256=XFr1MnWt-xmZkhQ_2ZzGfiqSJJwmphY4U07EEzMNYQc,16544
+maa/context.py,sha256=KT22q5tnzrIu8RQQSni3zAvUwNNPNB7-ZEyvwSU2Eao,9054
+maa/controller.py,sha256=XstPEuDe2I3ptN1ChcOd9hyh79OjUIKxZvA3WoDbQq8,26428
+maa/custom_action.py,sha256=honGd28UaKWzApYBHO9_Cka8hPfzZUy6HBUfIdfQiaU,2554
+maa/custom_recognition.py,sha256=nfNgPKq9a6t2eoXwKMJRvZMXTh31Jn0JfxUMsfGI33Y,3384
+maa/define.py,sha256=tr_Ecur9tLIJP3MCX2SjiHwECeTfSl2BOOFNPYrj_04,13671
+maa/event_sink.py,sha256=E5QgjQIbqvLfMg4QoelWCPFmLDawaszEsuLZtwb43VI,1925
+maa/job.py,sha256=MUI5T2X9ON9c7Dl6yo_0pp8Ulpn25XOD_uEdGm2k-TA,1231
+maa/library.py,sha256=u6gbEHDV3I0y69-ZoBo1p6-bAtP4jqSQa4FICuzaw3U,3961
+maa/pipeline.py,sha256=ep9RtViltI4J6_8tP1z9geYhV_O2ezP8NXietxAl8nM,8861
+maa/resource.py,sha256=ljULjrCdVOmFxt0cj9HSyUQsU59mPfiJj0AZ4kla50E,14559
+maa/tasker.py,sha256=Dt-tLz8hSiBZMxdJ5MoHIXcAEYbLihUXnGQ9Fg0Z6Ck,17873
+maa/toolkit.py,sha256=QXPEL8nDhtq2mcjxg8YNEd1-1Q-BfuqH8bkHhA-2nso,8318
+maa/agent/__init__.py,sha256=K4vyyD6YgLR6PEQl86t4oKP4eViCdNr3Br94dNk8YjM,257
+maa/agent/agent_server.py,sha256=e0yE_ffWJlTPydJbYLK9OhCM5fVVlZQIcvEQMjB5V68,3636
+maa/bin/DirectML.dll,sha256=d7Dbg_-QPyMj9cr1OEmdda9gOLvqI7eVn30jLZpKudQ,18444832
+maa/bin/MaaAdbControlUnit.dll,sha256=e-vvjq_rEStneWDQYD-KpvJlSTUYmudGmS06ChT43_A,837632
+maa/bin/MaaAgentClient.dll,sha256=kDabOnYqvUk89sQ2KNLdVD8_1jQgxfk4n24Q8y0ZH6A,1147392
+maa/bin/MaaAgentServer.dll,sha256=AU3Em7Mskc6Ht8N68BatQqZWpLEiONZSzLlL5ajUJhw,1329152
+maa/bin/MaaCustomControlUnit.dll,sha256=gw6BAfyAUXx1Hqfu0JxLgWcASD5pxx9VIWCjZM9f9Ik,276992
+maa/bin/MaaDbgControlUnit.dll,sha256=e1ZpwCgf4F-CQfyc2OHd9-qyVOERx6v0-PMO3t2H6y0,394752
+maa/bin/MaaFramework.dll,sha256=u8DIThCbv6Xke0qimpSdDkEy-eUjKOzvP8fBjE1MDKg,2021376
+maa/bin/MaaToolkit.dll,sha256=Wc9nnM-oGRq64aSgF86d1-J4e2_g_H2kWO-JTvhJN4c,496640
+maa/bin/MaaUtils.dll,sha256=aXAfvpXKom-n3jhGCLnlbV4g1LJDn8ujM-_vt4mPU_o,569344
+maa/bin/MaaWin32ControlUnit.dll,sha256=-E-YdPeLUXfptro4ZBI_DniugJ8IveSOGqIEc2uyfsk,354304
+maa/bin/fastdeploy_ppocr_maa.dll,sha256=5LEyrao0OSuJyHjRe3HCyzw_2D2Ynt28TOzjAkQgI8o,1049088
+maa/bin/onnxruntime_maa.dll,sha256=r9qt8ChcpFeoZkstIGFHQ5CLAmfERPXBQJJGdlfB8VQ,19039744
+maa/bin/opencv_world4_maa.dll,sha256=fjKN9Dg59liGwlCpkZ8FZNzbMh65SeSRnD98pWtcfuE,12862464
+maafw-5.0.0a1.dist-info/licenses/LICENSE.md,sha256=RG51X65V_wNLuyG-RGcLXxFsKyZnlH5wNvK_5mMlOag,7560
+maafw-5.0.0a1.dist-info/METADATA,sha256=D8JnUGun19DBzLpbZkXMhN9un53NU4YHsGPDRQg-6Gk,25358
+maafw-5.0.0a1.dist-info/WHEEL,sha256=CUnyDJaykcVTxcKkonAaC86WeSAkytRwcxeIq_huwCo,93
+maafw-5.0.0a1.dist-info/RECORD,,