ErisPulse 2.3.1__tar.gz → 2.3.3__tar.gz

{erispulse-2.3.1 → erispulse-2.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ErisPulse
-Version: 2.3.1
+Version: 2.3.3
 Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。
 Author-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>
 License: MIT License
@@ -57,9 +57,7 @@ Requires-Dist: aiohttp
 Requires-Dist: colorama
 Requires-Dist: fastapi>=0.116.1
 Requires-Dist: hypercorn>=0.14.0
-Requires-Dist: keyboard
 Requires-Dist: packaging>=25.0
-Requires-Dist: pip
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: python-multipart>=0.0.20
 Requires-Dist: rich

{erispulse-2.3.1 → erispulse-2.3.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ErisPulse"
-version = "2.3.1"
+version = "2.3.3"
 description = "ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -29,10 +29,8 @@ classifiers = [
 ]
 
 dependencies = [
-    "pip",
     "rich",
     "colorama",
-    "keyboard",
     "aiohttp",
     "watchdog",
     "toml",
@@ -53,6 +51,18 @@ epsdk-cli = "ErisPulse.__main__:main"
 [tool.hatch]
 project.root = "src"
 
+[tool.hatch.build.targets.wheel]
+packages = ["src/ErisPulse"]
+
+[tool.hatch.build.targets.wheel.shared-data]
+"stubs/ErisPulse" = "ErisPulse-stubs/ErisPulse"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src/ErisPulse",
+    "/stubs/ErisPulse",
+]
+
 [tool.ruff]
 target-version = "py310"
 

erispulse-2.3.3/src/ErisPulse/Core/Bases/__init__.pyi

@@ -0,0 +1,14 @@
+# type: ignore
+#
+# Auto-generated type stub for __init__.py
+# DO NOT EDIT MANUALLY - Generated by generate-type-stubs.py
+#
+
+"""
+ErisPulse 基础模块
+
+提供核心基类定义，包括适配器和模块基类
+"""
+
+from .adapter import SendDSL, BaseAdapter
+from .module import BaseModule

{erispulse-2.3.1 → erispulse-2.3.3}/src/ErisPulse/Core/Bases/adapter.py

@@ -72,7 +72,19 @@ class SendDSL:
         >>> adapter.Send.To("123").Using("bot1").Text("Hello")  # 支持乱序
         """
         return self.__class__(self._adapter, self._target_type, self._target_id, account_id)
-
+    
+    def Account(self, account_id: Union[str, int]) -> 'SendDSL':
+        """
+        设置发送账号
+        
+        :param _account_id: 发送账号
+        :return: SendDSL实例
+        
+        :example:
+        >>> adapter.Send.Account("bot1").To("123").Text("Hello")
+        >>> adapter.Send.To("123").Account("bot1").Text("Hello")  # 支持乱序
+        """
+        return self.__class__(self._adapter, self._target_type, self._target_id, account_id)
 
 class BaseAdapter:
     """

erispulse-2.3.3/src/ErisPulse/Core/Bases/adapter.pyi

@@ -0,0 +1,140 @@
+# type: ignore
+#
+# Auto-generated type stub for adapter.py
+# DO NOT EDIT MANUALLY - Generated by generate-type-stubs.py
+#
+
+"""
+ErisPulse 适配器基础模块
+
+提供适配器和消息发送DSL的基类实现
+
+{!--< tips >!--}
+1. 用于实现与不同平台的交互接口
+2. 提供统一的消息发送DSL风格接口
+{!--< /tips >!--}
+"""
+
+import asyncio
+from typing import Any, Optional, Union, Awaitable
+
+class SendDSL:
+    """
+    消息发送DSL基类
+    
+    用于实现 Send.To(...).Func(...) 风格的链式调用接口
+    
+    {!--< tips >!--}
+    1. 子类应实现具体的消息发送方法(如Text, Image等)
+    2. 通过__getattr__实现动态方法调用
+    {!--< /tips >!--}
+    """
+    def __init__(self: None, adapter: BaseAdapter, target_type: Optional[str] = ..., target_id: Optional[str] = ..., account_id: Optional[str] = ...) -> ...:
+        """
+        初始化DSL发送器
+        
+        :param adapter: 所属适配器实例
+        :param target_type: 目标类型(可选)
+        :param target_id: 目标ID(可选)
+        :param _account_id: 发送账号(可选)
+        """
+        ...
+    def To(self: object, target_type: str = ..., target_id: Union[(str, int)] = ...) -> SendDSL:
+        """
+        设置消息目标
+        
+        :param target_type: 目标类型(可选)
+        :param target_id: 目标ID(可选)
+        :return: SendDSL实例
+        
+        :example:
+        >>> adapter.Send.To("user", "123").Text("Hello")
+        >>> adapter.Send.To("123").Text("Hello")  # 简化形式
+        """
+        ...
+    def Using(self: object, account_id: Union[(str, int)]) -> SendDSL:
+        """
+        设置发送账号
+        
+        :param _account_id: 发送账号
+        :return: SendDSL实例
+        
+        :example:
+        >>> adapter.Send.Using("bot1").To("123").Text("Hello")
+        >>> adapter.Send.To("123").Using("bot1").Text("Hello")  # 支持乱序
+        """
+        ...
+    def Account(self: object, account_id: Union[(str, int)]) -> SendDSL:
+        """
+        设置发送账号
+        
+        :param _account_id: 发送账号
+        :return: SendDSL实例
+        
+        :example:
+        >>> adapter.Send.Account("bot1").To("123").Text("Hello")
+        >>> adapter.Send.To("123").Account("bot1").Text("Hello")  # 支持乱序
+        """
+        ...
+
+class BaseAdapter:
+    """
+    适配器基类
+    
+    提供与外部平台交互的标准接口，子类必须实现必要方法
+    
+    {!--< tips >!--}
+    1. 必须实现call_api, start和shutdown方法
+    2. 可以自定义Send类实现平台特定的消息发送逻辑
+    3. 通过on装饰器注册事件处理器
+    4. 支持OneBot12协议的事件处理
+    {!--< /tips >!--}
+    """
+    def __init__(self: None) -> ...:
+        ...
+    async def call_api(self: object, endpoint: str, **params: Any) -> Any:
+        """
+        调用平台API的抽象方法
+        
+        :param endpoint: API端点
+        :param params: API参数
+        :return: API调用结果
+        :raises NotImplementedError: 必须由子类实现
+        """
+        ...
+    async def start(self: object) -> None:
+        """
+        启动适配器的抽象方法
+        
+        :raises NotImplementedError: 必须由子类实现
+        """
+        ...
+    async def shutdown(self: object) -> None:
+        """
+        关闭适配器的抽象方法
+        
+        :raises NotImplementedError: 必须由子类实现
+        """
+        ...
+    async def emit(self: object) -> None:
+        ...
+    def send(self: object, target_type: str, target_id: str, message: Any, **kwargs: Any) -> asyncio.Task:
+        """
+        发送消息的便捷方法，返回一个 asyncio Task
+        
+        :param target_type: 目标类型
+        :param target_id: 目标ID
+        :param message: 消息内容
+        :param kwargs: 其他参数
+            - method: 发送方法名(默认为"Text")
+        :return: asyncio.Task 对象，用户可以自主决定是否等待
+        
+        :raises AttributeError: 当发送方法不存在时抛出
+            
+        :example:
+        >>> task = adapter.send("user", "123", "Hello")
+        >>> # 用户可以选择等待: result = await task
+        >>> # 或者不等待让其在后台执行
+        >>> await adapter.send("group", "456", "Hello", method="Markdown")  # 直接等待
+        """
+        ...

erispulse-2.3.3/src/ErisPulse/Core/Bases/module.pyi

@@ -0,0 +1,52 @@
+# type: ignore
+#
+# Auto-generated type stub for module.py
+# DO NOT EDIT MANUALLY - Generated by generate-type-stubs.py
+#
+
+"""
+ErisPulse 模块基础模块
+
+提供模块基类定义和标准接口
+"""
+
+class BaseModule:
+    """
+    模块基类
+    
+    提供模块加载和卸载的标准接口
+    """
+    def should_eager_load() -> bool:
+        """
+        模块是否应该在启动时加载
+        默认为False(即懒加载)
+        
+        :return: 是否应该在启动时加载
+        """
+        ...
+    async def on_load(self: object, event: dict) -> bool:
+        """
+        当模块被加载时调用
+        
+        :param event: 事件内容
+        :return: 处理结果
+        
+        {!--< tips >!--}
+        其中，event事件内容为:
+            `{ "module_name": "模块名" }`
+        {!--< /tips >!--}
+        """
+        ...
+    async def on_unload(self: object, event: dict) -> bool:
+        """
+        当模块被卸载时调用
+        
+        :param event: 事件内容
+        :return: 处理结果
+        
+        {!--< tips >!--}
+        其中，event事件内容为:
+            `{ "module_name": "模块名" }`
+        {!--< /tips >!--}
+        """
+        ...

{erispulse-2.3.1 → erispulse-2.3.3}/src/ErisPulse/Core/Event/__init__.py

@@ -15,6 +15,7 @@ from .message import message
 from .notice import notice
 from .request import request
 from .meta import meta
+from .wrapper import Event
 from . import exceptions
 from .. import config
 
@@ -61,5 +62,6 @@ __all__ = [
     "notice",
     "request",
     "meta",
+    "Event",
     "exceptions"
-]
+]

erispulse-2.3.3/src/ErisPulse/Core/Event/__init__.pyi

@@ -0,0 +1,26 @@
+# type: ignore
+#
+# Auto-generated type stub for __init__.py
+# DO NOT EDIT MANUALLY - Generated by generate-type-stubs.py
+#
+
+"""
+ErisPulse 事件处理模块
+
+提供统一的事件处理接口，支持命令、消息、通知、请求和元事件处理
+
+{!--< tips >!--}
+1. 所有事件处理都基于OneBot12标准事件格式
+2. 通过装饰器方式注册事件处理器
+3. 支持优先级和条件过滤
+{!--< /tips >!--}
+"""
+
+from .command import command
+from .message import message
+from .notice import notice
+from .request import request
+from .meta import meta
+from .wrapper import Event
+from . import exceptions
+from .. import config

{erispulse-2.3.1 → erispulse-2.3.3}/src/ErisPulse/Core/Event/base.py

@@ -12,6 +12,7 @@ ErisPulse 事件处理基础模块
 from .. import adapter, logger
 from typing import Callable, Any, Dict, List
 import asyncio
+from .wrapper import Event
 
 class BaseEventHandler:
     """
@@ -94,6 +95,10 @@ class BaseEventHandler:
         
         :param event: 事件数据
         """
+        # 如果还不是Event对象，则转换为Event对象
+        if not isinstance(event, Event):
+            event = Event(event)
+        
         # 执行处理器
         for handler_info in self.handlers:
             condition = handler_info.get("condition")

erispulse-2.3.3/src/ErisPulse/Core/Event/base.pyi

@@ -0,0 +1,62 @@
+# type: ignore
+#
+# Auto-generated type stub for base.py
+# DO NOT EDIT MANUALLY - Generated by generate-type-stubs.py
+#
+
+"""
+ErisPulse 事件处理基础模块
+
+提供事件处理的核心功能，包括事件注册和处理
+
+{!--< tips >!--}
+1. 所有事件处理都基于OneBot12标准事件格式
+2. 通过适配器系统进行事件分发和接收
+{!--< /tips >!--}
+"""
+
+from .. import adapter, logger
+from typing import Callable, Any, Dict, List
+import asyncio
+from .wrapper import Event
+
+class BaseEventHandler:
+    """
+    基础事件处理器
+    
+    提供事件处理的基本功能，包括处理器注册和注销
+    """
+    def __init__(self: None, event_type: str, module_name: str = ...) -> ...:
+        """
+        初始化事件处理器
+        
+        :param event_type: 事件类型
+        :param module_name: 模块名称
+        """
+        ...
+    def register(self: object, handler: Callable, priority: int = ..., condition: Callable = ...) -> ...:
+        """
+        注册事件处理器
+        
+        :param handler: 事件处理器函数
+        :param priority: 处理器优先级，数值越小优先级越高
+        :param condition: 处理器条件函数，返回True时才会执行处理器
+        """
+        ...
+    def unregister(self: object, handler: Callable) -> bool:
+        """
+        注销事件处理器
+        
+        :param handler: 要注销的事件处理器
+        :return: 是否成功注销
+        """
+        ...
+    def __call__(self: object, priority: int = ..., condition: Callable = ...) -> ...:
+        """
+        装饰器方式注册事件处理器
+        
+        :param priority: 处理器优先级
+        :param condition: 处理器条件函数
+        :return: 装饰器函数
+        """
+        ...

{erispulse-2.3.1 → erispulse-2.3.3}/src/ErisPulse/Core/Event/command.py

@@ -240,35 +240,80 @@ class CommandHandler:
         if event.get("type") != "message":
             return
         
+        async def _process_text_for_command(event: Dict[str, Any], text: str) -> bool:
+            """
+            处理文本内容，尝试匹配并执行命令
+            
+            {!--< internal-use >!--}
+            内部使用的方法，用于处理文本内容并尝试执行命令
+            
+            :param event: 消息事件数据
+            :param text: 要处理的文本内容
+            :return: 是否成功执行命令
+            """
+            if not text:
+                return False
+            
+            # 处理大小写敏感性
+            check_text = text if self.case_sensitive else text.lower()
+            prefix = self.prefix if self.case_sensitive else self.prefix.lower()
+            
+            # 检查前缀
+            has_prefix = check_text.startswith(prefix)
+            has_space_prefix = self.allow_space_prefix and check_text.startswith(prefix + " ")
+            
+            if not has_prefix and not has_space_prefix:
+                return False
+            
+            # 尝试执行命令
+            return await self._try_execute_command(event, text, check_text)
+        
+        # 从 message 列表和 alt_message 中提取文本内容
         message_segments = event.get("message", [])
-        text_content = ""
+        message_text = ""
         for segment in message_segments:
             if segment.get("type") == "text":
-                text_content = segment.get("data", {}).get("text", "")
+                message_text = segment.get("data", {}).get("text", "")
                 break
         
-        if not text_content:
-            return
+        alt_message = event.get("alt_message", "")
         
-        # 处理大小写敏感性
-        check_text = text_content if self.case_sensitive else text_content.lower()
-        prefix = self.prefix if self.case_sensitive else self.prefix.lower()
+        # 尝试使用 message 列表的内容
+        if message_text:
+            command_matched = await _process_text_for_command(event, message_text)
+            if command_matched:
+                return
         
-        # 检查前缀
-        if not check_text.startswith(prefix):
-            # 检查是否允许空格前缀 (例如: "/ command")
-            if self.allow_space_prefix and check_text.startswith(prefix + " "):
-                pass
-            else:
-                # 检查是否是等待回复的消息
-                await self._check_pending_reply(event)
+        # 尝试使用 alt_message
+        if alt_message and alt_message != message_text:
+            command_matched = await _process_text_for_command(event, alt_message)
+            if command_matched:
                 return
         
+        # 如果都没有匹配，检查是否是等待回复的消息
+        await self._check_pending_reply(event)
+        return
+    
+    
+    async def _try_execute_command(self, event: Dict[str, Any], original_text: str, check_text: str) -> bool:
+        """
+        尝试执行命令
+        
+        {!--< internal-use >!--}
+        内部使用的方法，用于尝试解析和执行命令
+        
+        :param event: 消息事件数据
+        :param original_text: 原始文本内容
+        :param check_text: 用于检查的文本内容（可能已转换为小写）
+        :return: 是否成功执行命令
+        """
+        prefix = self.prefix if self.case_sensitive else self.prefix.lower()
+        
         # 解析命令和参数
         command_text = check_text[len(prefix):].strip()
         parts = command_text.split()
         if not parts:
-            return
+            return False
         
         cmd_name = parts[0]
         args = parts[1:] if len(parts) > 1 else []
@@ -323,6 +368,10 @@ class CommandHandler:
             except Exception as e:
                 logger.error(f"命令执行错误: {e}")
                 await self._send_command_error(event, str(e))
+            
+            return True
+        
+        return False
     
     async def _check_pending_reply(self, event: Dict[str, Any]):
         """
@@ -486,4 +535,4 @@ class CommandHandler:
                 help_lines.append(f"  {self.prefix}{cmd_name} - {help_text}")
             return "\n".join(help_lines)
 
-command = CommandHandler()
+command = CommandHandler()

erispulse-2.3.3/src/ErisPulse/Core/Event/command.pyi

@@ -0,0 +1,113 @@
+# type: ignore
+#
+# Auto-generated type stub for command.py
+# DO NOT EDIT MANUALLY - Generated by generate-type-stubs.py
+#
+
+"""
+ErisPulse 命令处理模块
+
+提供基于装饰器的命令注册和处理功能
+
+{!--< tips >!--}
+1. 支持命令别名和命令组
+2. 支持命令权限控制
+3. 支持命令帮助系统
+4. 支持等待用户回复交互
+{!--< /tips >!--}
+"""
+
+from .base import BaseEventHandler
+from .. import adapter, config, logger
+from typing import Callable, Union, List, Dict, Any, Optional, Awaitable
+import asyncio
+
+class CommandHandler:
+    """
+    命令处理器
+    
+    提供命令注册、处理和管理功能
+    """
+    def __init__(self: None) -> ...:
+        ...
+    def __call__(self: object, name: Union[(str, List[str])] = ..., aliases: List[str] = ..., group: str = ..., priority: int = ..., permission: Callable = ..., help: str = ..., usage: str = ..., hidden: bool = ...) -> ...:
+        """
+        命令装饰器
+        
+        :param name: 命令名称，可以是字符串或字符串列表
+        :param aliases: 命令别名列表
+        :param group: 命令组名称
+        :param priority: 处理器优先级
+        :param permission: 权限检查函数，返回True时允许执行命令
+        :param help: 命令帮助信息
+        :param usage: 命令使用方法
+        :param hidden: 是否在帮助中隐藏命令
+        :return: 装饰器函数
+        """
+        ...
+    def unregister(self: object, handler: Callable) -> bool:
+        """
+        注销命令处理器
+        
+        :param handler: 要注销的命令处理器
+        :return: 是否成功注销
+        """
+        ...
+    async def wait_reply(self: object, event: Dict[(str, Any)], prompt: str = ..., timeout: float = ..., callback: Callable[([Dict[(str, Any)]], Awaitable[Any])] = ..., validator: Callable[([Dict[(str, Any)]], bool)] = ...) -> Optional[Dict[(str, Any)]]:
+        """
+        等待用户回复
+        
+        :param event: 原始事件数据
+        :param prompt: 提示消息，如果提供会发送给用户
+        :param timeout: 等待超时时间(秒)
+        :param callback: 回调函数，当收到回复时执行
+        :param validator: 验证函数，用于验证回复是否有效
+        :return: 用户回复的事件数据，如果超时则返回None
+        """
+        ...
+    async def _check_pending_reply(self: object, event: Dict[(str, Any)]) -> ...:
+        """
+        检查是否是等待回复的消息
+        
+        :param event: 消息事件数据
+        """
+        ...
+    def get_command(self: object, name: str) -> Optional[Dict]:
+        """
+        获取命令信息
+        
+        :param name: 命令名称
+        :return: 命令信息字典，如果不存在则返回None
+        """
+        ...
+    def get_commands(self: object) -> Dict[(str, Dict)]:
+        """
+        获取所有命令
+        
+        :return: 命令信息字典
+        """
+        ...
+    def get_group_commands(self: object, group: str) -> List[str]:
+        """
+        获取命令组中的命令
+        
+        :param group: 命令组名称
+        :return: 命令名称列表
+        """
+        ...
+    def get_visible_commands(self: object) -> Dict[(str, Dict)]:
+        """
+        获取所有可见命令（非隐藏命令）
+        
+        :return: 可见命令信息字典
+        """
+        ...
+    def help(self: object, command_name: str = ..., show_hidden: bool = ...) -> str:
+        """
+        生成帮助信息
+        
+        :param command_name: 命令名称，如果为None则生成所有命令的帮助
+        :param show_hidden: 是否显示隐藏命令
+        :return: 帮助信息字符串
+        """
+        ...

erispulse-2.3.3/src/ErisPulse/Core/Event/exceptions.pyi

@@ -0,0 +1,43 @@
+# type: ignore
+#
+# Auto-generated type stub for exceptions.py
+# DO NOT EDIT MANUALLY - Generated by generate-type-stubs.py
+#
+
+"""
+ErisPulse 事件系统异常处理模块
+
+提供事件系统中可能发生的各种异常类型定义
+"""
+
+class EventException(Exception):
+    """
+    事件系统基础异常
+    
+    所有事件系统相关异常的基类
+    """
+    ...
+
+class CommandException(EventException):
+    """
+    命令处理异常
+    
+    当命令处理过程中发生错误时抛出
+    """
+    ...
+
+class EventHandlerException(EventException):
+    """
+    事件处理器异常
+    
+    当事件处理器执行过程中发生错误时抛出
+    """
+    ...
+
+class EventNotFoundException(EventException):
+    """
+    事件未找到异常
+    
+    当尝试获取不存在的事件处理器时抛出
+    """
+    ...