ErisPulse 2.1.15__py3-none-any.whl → 2.2.0__py3-none-any.whl

ErisPulse/Core/Event/__init__.py

@@ -0,0 +1,51 @@
+"""
+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 . import exceptions
+from .. import config
+
+# 初始化默认配置
+def _setup_default_config():
+    """
+    {!--< internal-use >!--}
+    设置默认配置
+    """
+    default_config = {
+        "command": {
+            "prefix": "/",
+            "case_sensitive": True,
+            "allow_space_prefix": False
+        },
+        "message": {
+            "ignore_self": True
+        }
+    }
+    
+    current_config = config.getConfig("ErisPulse.event")
+    if current_config is None:
+        config.setConfig("ErisPulse.event", default_config)
+
+_setup_default_config()
+
+__all__ = [
+    "command",
+    "message", 
+    "notice",
+    "request",
+    "meta",
+    "exceptions"
+]

ErisPulse/Core/Event/base.py

@@ -0,0 +1,100 @@
+"""
+ErisPulse 事件处理基础模块
+
+提供事件处理的核心功能，包括事件注册和处理
+
+{!--< tips >!--}
+1. 所有事件处理都基于OneBot12标准事件格式
+2. 通过适配器系统进行事件分发和接收
+{!--< /tips >!--}
+"""
+
+from .. import adapter, logger
+from typing import Callable, Any, Dict, List, Optional
+import asyncio
+
+class BaseEventHandler:
+    """
+    基础事件处理器
+    
+    提供事件处理的基本功能，包括处理器注册等
+    """
+    
+    def __init__(self, event_type: str, module_name: str = None):
+        """
+        初始化事件处理器
+        
+        :param event_type: 事件类型
+        :param module_name: 模块名称
+        """
+        self.event_type = event_type
+        self.module_name = module_name
+        self.handlers: List[Dict] = []
+    
+    def register(self, handler: Callable, priority: int = 0, condition: Callable = None):
+        """
+        注册事件处理器
+        
+        :param handler: 事件处理器函数
+        :param priority: 处理器优先级，数值越小优先级越高
+        :param condition: 处理器条件函数，返回True时才会执行处理器
+        """
+        handler_info = {
+            "func": handler,
+            "priority": priority,
+            "condition": condition,
+            "module": self.module_name
+        }
+        self.handlers.append(handler_info)
+        # 按优先级排序
+        self.handlers.sort(key=lambda x: x["priority"])
+        
+        # 注册到适配器
+        if self.event_type:
+            adapter.on(self.event_type)(self._process_event)
+    
+    def __call__(self, priority: int = 0, condition: Callable = None):
+        """
+        装饰器方式注册事件处理器
+        
+        :param priority: 处理器优先级
+        :param condition: 处理器条件函数
+        :return: 装饰器函数
+        """
+        def decorator(func: Callable):
+            self.register(func, priority, condition)
+            return func
+        return decorator
+    
+    async def _process_event(self, event: Dict[str, Any]):
+        """
+        处理事件
+        
+        {!--< internal-use >!--}
+        内部使用的方法，用于处理事件
+        
+        :param event: 事件数据
+        """
+        # 执行处理器
+        for handler_info in self.handlers:
+            condition = handler_info.get("condition")
+            # 检查条件
+            if condition and not condition(event):
+                continue
+                
+            handler = handler_info["func"]
+            try:
+                if asyncio.iscoroutinefunction(handler):
+                    await handler(event)
+                else:
+                    handler(event)
+            except Exception as e:
+                logger.error(f"事件处理器执行错误: {e}")
+    
+    def unregister(self, handler: Callable):
+        """
+        注销事件处理器
+        
+        :param handler: 要注销的事件处理器
+        """
+        self.handlers = [h for h in self.handlers if h["func"] != handler]

ErisPulse/Core/Event/command.py

@@ -0,0 +1,310 @@
+# ErisPulse/Core/Event/cmd.py
+"""
+ErisPulse 命令处理模块
+
+提供基于装饰器的命令注册和处理功能
+
+{!--< tips >!--}
+1. 支持命令别名和命令组
+2. 支持命令权限控制
+3. 支持命令帮助系统
+{!--< /tips >!--}
+"""
+
+from .base import BaseEventHandler
+from .. import adapter, config, logger
+from typing import Callable, Union, List, Dict, Any, Optional
+import asyncio
+import re
+
+class CommandHandler:
+    def __init__(self):
+        self.commands: Dict[str, Dict] = {}
+        self.aliases: Dict[str, str] = {}  # 别名映射
+        self.groups: Dict[str, List[str]] = {}  # 命令组
+        self.permissions: Dict[str, Callable] = {}  # 权限检查函数
+        self.prefix = config.getConfig("ErisPulse.event.command.prefix", "/")
+        self.case_sensitive = config.getConfig("ErisPulse.event.command.case_sensitive", True)
+        self.allow_space_prefix = config.getConfig("ErisPulse.event.command.allow_space_prefix", False)
+        
+        # 创建消息事件处理器
+        self.handler = BaseEventHandler("message", "command")
+        # 注册消息处理器
+        self.handler.register(self._handle_message)
+    
+    def __call__(self, 
+                 name: Union[str, List[str]] = None, 
+                 aliases: List[str] = None,
+                 group: str = None,
+                 priority: int = 0,
+                 permission: Callable = None,
+                 help: str = None,
+                 usage: str = None,
+                 hidden: bool = False):
+        """
+        命令装饰器
+        
+        :param name: 命令名称，可以是字符串或字符串列表
+        :param aliases: 命令别名列表
+        :param group: 命令组名称
+        :param priority: 处理器优先级
+        :param permission: 权限检查函数，返回True时允许执行命令
+        :param help: 命令帮助信息
+        :param usage: 命令使用方法
+        :param hidden: 是否在帮助中隐藏命令
+        :return: 装饰器函数
+        """
+        def decorator(func: Callable):
+            cmd_names = []
+            if isinstance(name, str):
+                cmd_names = [name]
+            elif isinstance(name, list):
+                cmd_names = name
+            else:
+                # 使用函数名作为命令名
+                cmd_names = [func.__name__]
+            
+            main_name = cmd_names[0]
+            
+            # 添加别名
+            alias_list = aliases or []
+            if len(cmd_names) > 1:
+                alias_list.extend(cmd_names[1:])
+            
+            # 注册命令
+            for cmd_name in cmd_names:
+                self.commands[cmd_name] = {
+                    "func": func,
+                    "help": help,
+                    "usage": usage,
+                    "group": group,
+                    "permission": permission,
+                    "hidden": hidden,
+                    "main_name": main_name
+                }
+                
+                # 注册别名映射
+                if cmd_name != main_name:
+                    self.aliases[cmd_name] = main_name
+                
+                # 注册权限检查函数
+                if permission and cmd_name not in self.permissions:
+                    self.permissions[cmd_name] = permission
+            
+            # 添加到命令组
+            if group:
+                if group not in self.groups:
+                    self.groups[group] = []
+                for cmd_name in cmd_names:
+                    if cmd_name not in self.groups[group]:
+                        self.groups[group].append(cmd_name)
+            
+            return func
+        return decorator
+    
+    async def _handle_message(self, event: Dict[str, Any]):
+        """
+        处理消息事件中的命令
+        
+        {!--< internal-use >!--}
+        内部使用的方法，用于从消息中解析并执行命令
+        
+        :param event: 消息事件数据
+        """
+        # 检查是否为文本消息
+        if event.get("type") != "message":
+            return
+        
+        message_segments = event.get("message", [])
+        text_content = ""
+        for segment in message_segments:
+            if segment.get("type") == "text":
+                text_content = segment.get("data", {}).get("text", "")
+                break
+        
+        if not text_content:
+            return
+        
+        # 处理大小写敏感性
+        check_text = text_content if self.case_sensitive else text_content.lower()
+        prefix = self.prefix if self.case_sensitive else self.prefix.lower()
+        
+        # 检查前缀
+        if not check_text.startswith(prefix):
+            # 检查是否允许空格前缀 (例如: "/ command")
+            if self.allow_space_prefix and check_text.startswith(prefix + " "):
+                pass
+            else:
+                return
+        
+        # 解析命令和参数
+        command_text = check_text[len(prefix):].strip()
+        parts = command_text.split()
+        if not parts:
+            return
+        
+        cmd_name = parts[0]
+        args = parts[1:] if len(parts) > 1 else []
+        
+        # 处理大小写敏感性
+        if not self.case_sensitive:
+            cmd_name = cmd_name.lower()
+        
+        # 处理别名
+        actual_cmd_name = self.aliases.get(cmd_name, cmd_name)
+        
+        # 查找命令处理器
+        if actual_cmd_name in self.commands:
+            cmd_info = self.commands[actual_cmd_name]
+            handler = cmd_info["func"]
+            
+            # 检查权限
+            permission_func = cmd_info.get("permission") or self.permissions.get(actual_cmd_name)
+            if permission_func:
+                try:
+                    has_permission = permission_func(event) if not asyncio.iscoroutinefunction(permission_func) \
+                                    else await permission_func(event)
+                    if not has_permission:
+                        await self._send_permission_denied(event)
+                        return
+                except Exception as e:
+                    logger.error(f"权限检查错误: {e}")
+                    await self._send_permission_denied(event)
+                    return
+            
+            # 添加命令相关信息到事件
+            command_info = {
+                "name": actual_cmd_name,
+                "main_name": cmd_info["main_name"],
+                "args": args,
+                "raw": command_text,
+                "help": cmd_info["help"],
+                "usage": cmd_info["usage"],
+                "group": cmd_info["group"]
+            }
+            
+            event["command"] = command_info
+            
+            try:
+                if asyncio.iscoroutinefunction(handler):
+                    await handler(event)
+                else:
+                    handler(event)
+            except Exception as e:
+                logger.error(f"命令执行错误: {e}")
+                await self._send_command_error(event, str(e))
+    
+    async def _send_permission_denied(self, event: Dict[str, Any]):
+        """
+        发送权限拒绝消息
+        
+        {!--< internal-use >!--}
+        内部使用的方法
+        
+        :param event: 事件数据
+        """
+        try:
+            platform = event.get("platform")
+            user_id = event.get("user_id")
+            group_id = event.get("group_id")
+            detail_type = "group" if group_id else "private"
+            target_id = group_id or user_id
+            
+            if platform and hasattr(adapter, platform):
+                adapter_instance = getattr(adapter, platform)
+                await adapter_instance.Send.To(detail_type, target_id).Text("权限不足，无法执行该命令")
+        except Exception as e:
+            logger.error(f"发送权限拒绝消息失败: {e}")
+    
+    async def _send_command_error(self, event: Dict[str, Any], error: str):
+        """
+        发送命令错误消息
+        
+        {!--< internal-use >!--}
+        内部使用的方法
+        
+        :param event: 事件数据
+        :param error: 错误信息
+        """
+        try:
+            platform = event.get("platform")
+            user_id = event.get("user_id")
+            group_id = event.get("group_id")
+            detail_type = "group" if group_id else "private"
+            target_id = group_id or user_id
+            
+            if platform and hasattr(adapter, platform):
+                adapter_instance = getattr(adapter, platform)
+                await adapter_instance.Send.To(detail_type, target_id).Text(f"命令执行出错: {error}")
+        except Exception as e:
+            logger.error(f"发送命令错误消息失败: {e}")
+    
+    def get_command(self, name: str) -> Optional[Dict]:
+        """
+        获取命令信息
+        
+        :param name: 命令名称
+        :return: 命令信息字典，如果不存在则返回None
+        """
+        actual_name = self.aliases.get(name, name)
+        return self.commands.get(actual_name)
+    
+    def get_commands(self) -> Dict[str, Dict]:
+        """
+        获取所有命令
+        
+        :return: 命令信息字典
+        """
+        return self.commands
+    
+    def get_group_commands(self, group: str) -> List[str]:
+        """
+        获取命令组中的命令
+        
+        :param group: 命令组名称
+        :return: 命令名称列表
+        """
+        return self.groups.get(group, [])
+    
+    def get_visible_commands(self) -> Dict[str, Dict]:
+        """
+        获取所有可见命令（非隐藏命令）
+        
+        :return: 可见命令信息字典
+        """
+        return {name: info for name, info in self.commands.items() 
+                if not info.get("hidden", False) and name == info["main_name"]}
+    
+    def help(self, command_name: str = None, show_hidden: bool = False) -> str:
+        """
+        生成帮助信息
+        
+        :param command_name: 命令名称，如果为None则生成所有命令的帮助
+        :param show_hidden: 是否显示隐藏命令
+        :return: 帮助信息字符串
+        """
+        if command_name:
+            cmd_info = self.get_command(command_name)
+            if cmd_info:
+                help_text = cmd_info.get("help", "无帮助信息")
+                usage = cmd_info.get("usage", f"{self.prefix}{command_name}")
+                return f"命令: {command_name}\n用法: {usage}\n说明: {help_text}"
+            else:
+                return f"未找到命令: {command_name}"
+        else:
+            # 生成所有命令的帮助
+            commands_to_show = self.get_visible_commands() if not show_hidden else {
+                name: info for name, info in self.commands.items() 
+                if name == info["main_name"]
+            }
+            
+            if not commands_to_show:
+                return "暂无可用命令"
+            
+            help_lines = ["可用命令:"]
+            for cmd_name, cmd_info in commands_to_show.items():
+                help_text = cmd_info.get("help", "无说明")
+                help_lines.append(f"  {self.prefix}{cmd_name} - {help_text}")
+            return "\n".join(help_lines)
+
+command = CommandHandler()

ErisPulse/Core/Event/exceptions.py

@@ -0,0 +1,37 @@
+"""
+ErisPulse 事件系统异常处理模块
+
+提供事件系统中可能发生的各种异常类型定义
+"""
+
+class EventException(Exception):
+    """
+    事件系统基础异常
+    
+    所有事件系统相关异常的基类
+    """
+    pass
+
+class CommandException(EventException):
+    """
+    命令处理异常
+    
+    当命令处理过程中发生错误时抛出
+    """
+    pass
+
+class EventHandlerException(EventException):
+    """
+    事件处理器异常
+    
+    当事件处理器执行过程中发生错误时抛出
+    """
+    pass
+
+class EventNotFoundException(EventException):
+    """
+    事件未找到异常
+    
+    当尝试获取不存在的事件处理器时抛出
+    """
+    pass

ErisPulse/Core/Event/message.py

@@ -0,0 +1,84 @@
+"""
+ErisPulse 消息处理模块
+
+提供基于装饰器的消息事件处理功能
+
+{!--< tips >!--}
+1. 支持私聊、群聊消息分类处理
+2. 支持@消息特殊处理
+3. 支持自定义条件过滤
+{!--< /tips >!--}
+"""
+
+from .base import BaseEventHandler
+from typing import Callable, Dict, Any
+
+class MessageHandler:
+    def __init__(self):
+        self.handler = BaseEventHandler("message", "message")
+    
+    def on_message(self, priority: int = 0):
+        """
+        消息事件装饰器
+        
+        :param priority: 处理器优先级
+        :return: 装饰器函数
+        """
+        def decorator(func: Callable):
+            self.handler.register(func, priority)
+            return func
+        return decorator
+    
+    def on_private_message(self, priority: int = 0):
+        """
+        私聊消息事件装饰器
+        
+        :param priority: 处理器优先级
+        :return: 装饰器函数
+        """
+        def condition(event: Dict[str, Any]) -> bool:
+            return event.get("detail_type") == "private"
+        
+        def decorator(func: Callable):
+            self.handler.register(func, priority, condition)
+            return func
+        return decorator
+    
+    def on_group_message(self, priority: int = 0):
+        """
+        群聊消息事件装饰器
+        
+        :param priority: 处理器优先级
+        :return: 装饰器函数
+        """
+        def condition(event: Dict[str, Any]) -> bool:
+            return event.get("detail_type") == "group"
+        
+        def decorator(func: Callable):
+            self.handler.register(func, priority, condition)
+            return func
+        return decorator
+    
+    def on_at_message(self, priority: int = 0):
+        """
+        @消息事件装饰器
+        
+        :param priority: 处理器优先级
+        :return: 装饰器函数
+        """
+        def condition(event: Dict[str, Any]) -> bool:
+            # 检查消息中是否有@机器人
+            message_segments = event.get("message", [])
+            self_id = event.get("self", {}).get("user_id")
+            
+            for segment in message_segments:
+                if segment.get("type") == "mention" and segment.get("data", {}).get("user_id") == self_id:
+                    return True
+            return False
+        
+        def decorator(func: Callable):
+            self.handler.register(func, priority, condition)
+            return func
+        return decorator
+
+message = MessageHandler()

ErisPulse/Core/Event/meta.py

@@ -0,0 +1,77 @@
+# ErisPulse/Core/Event/meta.py
+"""
+ErisPulse 元事件处理模块
+
+提供基于装饰器的元事件处理功能
+
+{!--< tips >!--}
+1. 支持连接、断开连接等生命周期事件
+2. 适用于系统状态监控和初始化操作
+{!--< /tips >!--}
+"""
+
+from .base import BaseEventHandler
+from typing import Callable, Dict, Any
+
+class MetaHandler:
+    def __init__(self):
+        self.handler = BaseEventHandler("meta", "meta")
+    
+    def on_meta(self, priority: int = 0):
+        """
+        通用元事件装饰器
+        
+        :param priority: 处理器优先级
+        :return: 装饰器函数
+        """
+        def decorator(func: Callable):
+            self.handler.register(func, priority)
+            return func
+        return decorator
+    
+    def on_connect(self, priority: int = 0):
+        """
+        连接事件装饰器
+        
+        :param priority: 处理器优先级
+        :return: 装饰器函数
+        """
+        def condition(event: Dict[str, Any]) -> bool:
+            return event.get("detail_type") == "connect"
+        
+        def decorator(func: Callable):
+            self.handler.register(func, priority, condition)
+            return func
+        return decorator
+    
+    def on_disconnect(self, priority: int = 0):
+        """
+        断开连接事件装饰器
+        
+        :param priority: 处理器优先级
+        :return: 装饰器函数
+        """
+        def condition(event: Dict[str, Any]) -> bool:
+            return event.get("detail_type") == "disconnect"
+        
+        def decorator(func: Callable):
+            self.handler.register(func, priority, condition)
+            return func
+        return decorator
+    
+    def on_heartbeat(self, priority: int = 0):
+        """
+        心跳事件装饰器
+        
+        :param priority: 处理器优先级
+        :return: 装饰器函数
+        """
+        def condition(event: Dict[str, Any]) -> bool:
+            return event.get("detail_type") == "heartbeat"
+        
+        def decorator(func: Callable):
+            self.handler.register(func, priority, condition)
+            return func
+        return decorator
+
+meta = MetaHandler()