ErisPulse-HelpModule 2.0.0__tar.gz → 2.1.1__tar.gz

erispulse_helpmodule-2.1.1/ErisPulse_HelpModule/Core.py

@@ -0,0 +1,171 @@
+from typing import Dict, List, Optional
+
+from ErisPulse import sdk
+from ErisPulse.Core import config
+from ErisPulse.Core.Bases import BaseModule
+from ErisPulse.Core.Event import command
+
+from .templates import HelpTemplates
+
+
+class HelpModule(BaseModule):
+    def __init__(self):
+        self.sdk = sdk
+        self.logger = sdk.logger.get_child("HelpModule")
+        self.command_list = []
+        self.command_map = {}
+
+    @staticmethod
+    def should_eager_load():
+        return True
+
+    async def on_load(self, event):
+        self._register_commands()
+        self.logger.info("HelpModule 已加载")
+        return True
+
+    async def on_unload(self, event):
+        self._unregister_commands()
+        self.logger.info("HelpModule 已卸载")
+        return True
+
+    def _get_config(self):
+        module_config = config.getConfig("HelpModule")
+        if not module_config:
+            default_config = {"show_hidden_commands": False, "group_commands": True}
+            config.setConfig("HelpModule", default_config)
+            self.logger.warning("未找到HelpModule配置，已创建默认配置")
+            return default_config
+        return module_config
+
+    def _get_command_prefix(self) -> str:
+        event_config = config.getConfig("ErisPulse.event", {})
+        command_config = event_config.get("command", {})
+        return command_config.get("prefix", "/")
+
+    def _register_commands(self):
+        self.help_command_func = self._create_help_command()
+        command(
+            "help",
+            aliases=["h", "帮助"],
+            help="显示帮助信息",
+            usage="help [序号] - 显示命令列表或查看指定序号的命令详情",
+        )(self.help_command_func)
+
+    def _unregister_commands(self):
+        if hasattr(self, "help_command_func"):
+            command.unregister(self.help_command_func)
+
+    def _create_help_command(self):
+        async def help_command(event):
+            await self._handle_help_command(event)
+
+        return help_command
+
+    def _build_command_list(self) -> List[Dict]:
+        self.command_list = []
+        module_config = self._get_config()
+        show_hidden = module_config.get("show_hidden_commands", False)
+
+        if show_hidden:
+            all_commands = command.get_commands()
+            for cmd_name in all_commands:
+                cmd_info = command.get_command(cmd_name)
+                if cmd_info and cmd_name == cmd_info.get("main_name"):
+                    self.command_list.append({"name": cmd_name, "info": cmd_info})
+        else:
+            visible_commands = command.get_visible_commands()
+            for cmd_name in visible_commands:
+                cmd_info = command.get_command(cmd_name)
+                if cmd_info and cmd_name == cmd_info.get("main_name"):
+                    self.command_list.append({"name": cmd_name, "info": cmd_info})
+
+        return self.command_list
+
+    def _group_commands_by_category(self, commands: List[Dict]) -> Dict[str, List]:
+        grouped = {}
+        for cmd in commands:
+            group = cmd["info"].get("group") or "default"
+            if group not in grouped:
+                grouped[group] = []
+            grouped[group].append(cmd)
+        return grouped
+
+    async def _handle_help_command(self, event) -> None:
+        try:
+            platform = event.get_platform()
+            args = event.get_command_args()
+
+            commands = self._build_command_list()
+            module_config = self._get_config()
+
+            if args:
+                # 显示命令详情
+                try:
+                    index = int(args[0])
+                    if index in self.command_map:
+                        # 使用模板构建命令详情
+                        templates = HelpTemplates.build_command_detail(
+                            self.command_map[index], self._get_command_prefix()
+                        )
+                    else:
+                        # 使用错误模板
+                        templates = HelpTemplates.build_error(
+                            "序号超出范围", f"请输入 1-{len(commands)} 之间的序号"
+                        )
+                except ValueError:
+                    templates = HelpTemplates.build_error(
+                        "参数错误", "请输入有效的序号"
+                    )
+            else:
+                # 显示命令列表
+                templates = HelpTemplates.build_help_list(
+                    commands,
+                    self.command_map,
+                    self._get_command_prefix(),
+                    module_config.get("group_commands", True),
+                )
+
+            # 根据平台能力选择最佳格式，通过 event.reply 发送
+            # event.reply 内部自动解析会话类型（含 channel/guild/thread 等）
+            format_name, content = self._select_best_format(platform, templates)
+            await event.reply(content, method=format_name)
+        except Exception as e:
+            self.logger.error(f"处理帮助命令时出错: {e}", exc_info=True)
+
+    def _select_best_format(self, platform: str, templates: Dict[str, str]) -> tuple:
+        """
+        根据平台支持的发送方法选择最佳格式
+        优先使用 list_sends，不支持时使用 hasattr 兜底
+
+        返回: (format_name, content)
+        """
+        # 首先尝试使用 list_sends（推荐方式）
+        try:
+            supported_methods = sdk.adapter.list_sends(platform)
+
+            # 优先级: Html > Markdown > Text
+            if "Html" in supported_methods:
+                return ("Html", templates["html"])
+            elif "Markdown" in supported_methods:
+                return ("Markdown", templates["markdown"])
+            else:
+                return ("Text", templates["text"])
+        except Exception as e:
+            self.logger.warning(f"list_sends 检测失败: {e}，尝试使用 hasattr 兜底")
+
+            # 使用 hasattr 作为兜底方案
+            adapter = getattr(sdk.adapter, platform)
+            send_obj = adapter.Send if hasattr(adapter, "Send") else None
+
+            if send_obj is None:
+                self.logger.warning(f"平台 {platform} 不支持 Send 接口，使用纯文本格式")
+                return ("Text", templates["text"])
+
+            # 检查支持的方法
+            if hasattr(send_obj, "Html"):
+                return ("Html", templates["html"])
+            elif hasattr(send_obj, "Markdown"):
+                return ("Markdown", templates["markdown"])
+            else:
+                return ("Text", templates["text"])

erispulse_helpmodule-2.1.1/ErisPulse_HelpModule/templates.py

@@ -0,0 +1,460 @@
+"""
+帮助模块模板系统
+提供多平台支持的消息模板
+"""
+from typing import Dict, List, Optional
+from ErisPulse.Core.Event import command
+
+
+class HelpTemplates:
+    """帮助模块模板类"""
+    
+    # 配色方案
+    PRIMARY_COLOR = "#1565c0"  # 蓝色 - 主标题
+    SUCCESS_COLOR = "#2e7d32"  # 绿色 - 成功信息
+    WARNING_COLOR = "#e65100"  # 橙色 - 警告信息
+    ERROR_COLOR = "#b71c1c"    # 红色 - 错误信息
+    
+    # 半透明背景色
+    PRIMARY_BG = "rgba(21, 101, 192, 0.05)"
+    SUCCESS_BG = "rgba(76, 175, 80, 0.1)"
+    WARNING_BG = "rgba(255, 167, 38, 0.15)"
+    ERROR_BG = "rgba(183, 28, 28, 0.1)"
+    
+    @classmethod
+    def _get_group_name(cls, group: str) -> str:
+        if group == "default":
+            return "通用命令"
+        return f"{group}命令" if group else "其他"
+    
+    # ==================== 帮助列表模板 ====================
+    
+    @classmethod
+    def build_help_list(cls, commands: List[Dict], command_map: Dict[int, Dict], 
+                      prefix: str, group_commands: bool = True) -> Dict[str, str]:
+        # 构建 HTML
+        html = cls._build_help_list_html(commands, command_map, prefix, group_commands)
+        
+        # 构建 Markdown
+        markdown = cls._build_help_list_markdown(commands, command_map, prefix, group_commands)
+        
+        # 构建 Text
+        text = cls._build_help_list_text(commands, command_map, prefix, group_commands)
+        
+        return {"html": html, "markdown": markdown, "text": text}
+    
+    @classmethod
+    def _build_help_list_html(cls, commands: List[Dict], command_map: Dict[int, Dict],
+                            prefix: str, group_commands: bool) -> str:
+        # 重置命令映射
+        grouped = {}
+        if group_commands:
+            for cmd in commands:
+                group = cmd["info"].get("group") or "default"
+                if group not in grouped:
+                    grouped[group] = []
+                grouped[group].append(cmd)
+        else:
+            grouped["default"] = commands
+        
+        # 构建命令列表 HTML（带展开/折叠功能）
+        commands_html = ""
+        global_idx = 1
+        
+        for group, cmds in grouped.items():
+            group_name = cls._get_group_name(group)
+            
+            commands_html += f"""
+<div style="font-size:13px; margin-bottom: 8px; font-weight: bold; color: {cls.PRIMARY_COLOR};">{group_name}</div>
+"""
+            
+            for cmd in cmds:
+                name = cmd["name"]
+                info = cmd["info"]
+                help_text = info.get("help", "暂无描述")
+                command_map[global_idx] = cmd
+                
+                # 构建命令详情内容
+                detail_content = cls._build_command_detail_inline(name, info, prefix)
+                
+                commands_html += f"""<details style="margin-bottom: 8px;">
+    <summary style="cursor: pointer; font-size: 13px; padding: 4px; background: rgba(0, 0, 0, 0.02); border-radius: 4px; display: flex; align-items: center;">
+        <span style="font-weight: bold; margin-right: 8px;">{global_idx}.</span>
+        <code style="background: rgba(0, 0, 0, 0.05); padding: 2px 6px; border-radius: 3px; margin-right: 8px;">{prefix}{name}</code>
+        <span style="color: #666;">- {help_text}</span>
+    </summary>
+    <div style="padding: 8px; margin-top: 6px; border-left: 3px solid {cls.PRIMARY_BG}; background: rgba(0, 0, 0, 0.01); border-radius: 4px;">
+        {detail_content}
+    </div>
+</details>"""
+                global_idx +=1
+            
+            commands_html += "\n"
+        
+        # 构建完整 HTML
+        html = f"""<div style="padding: 12px; border-radius: 8px;">
+    <div style="color: {cls.PRIMARY_COLOR}; font-size: 16px; font-weight: bold; margin-bottom: 12px;">
+        命令帮助
+    </div>
+    
+    <div style="padding: 8px; background: {cls.PRIMARY_BG}; border-radius: 6px; margin-bottom: 12px;">
+        <div style="font-size: 13px;">
+            使用 '{prefix}help <序号>' 查看命令详情
+        </div>
+    </div>
+    
+    {commands_html}
+    
+    <div style="font-size: 12px; color: #666; margin-top: 8px;">
+        共 {len(commands)} 个可用命令
+    </div>
+</div>"""
+        
+        return html
+    
+    @classmethod
+    def _build_help_list_markdown(cls, commands: List[Dict], command_map: Dict[int, Dict],
+                                 prefix: str, group_commands: bool) -> str:
+        lines = [
+            "**命令帮助**",
+            "",
+            f"使用 `{prefix}help <序号>` 查看命令详情",
+            ""
+        ]
+        
+        global_idx = 1
+        
+        if group_commands:
+            grouped = {}
+            for cmd in commands:
+                group = cmd["info"].get("group") or "default"
+                if group not in grouped:
+                    grouped[group] = []
+                grouped[group].append(cmd)
+            
+            for group, cmds in grouped.items():
+                group_name = cls._get_group_name(group)
+                lines.append(f"**{group_name}**")
+                lines.append("")
+                
+                for cmd in cmds:
+                    name = cmd["name"]
+                    help_text = cmd["info"].get("help", "暂无描述")
+                    command_map[global_idx] = cmd
+                    lines.append(f"{global_idx}. `{prefix}{name}` - {help_text}")
+                    global_idx += 1
+                
+                lines.append("")
+        else:
+            lines.append("**所有命令**")
+            lines.append("")
+            for cmd in commands:
+                name = cmd["name"]
+                help_text = cmd["info"].get("help", "暂无描述")
+                command_map[global_idx] = cmd
+                lines.append(f"{global_idx}. `{prefix}{name}` - {help_text}")
+                global_idx += 1
+            lines.append("")
+        
+        lines.append("---")
+        lines.append(f"共 {len(commands)} 个可用命令")
+        
+        return "\n".join(lines)
+    
+    @classmethod
+    def _build_help_list_text(cls, commands: List[Dict], command_map: Dict[int, Dict],
+                             prefix: str, group_commands: bool) -> str:
+        lines = [
+            "命令帮助",
+            "----------",
+            f"使用 '{prefix}help <序号>' 查看命令详情",
+            ""
+        ]
+        
+        global_idx = 1
+        
+        if group_commands:
+            grouped = {}
+            for cmd in commands:
+                group = cmd["info"].get("group") or "default"
+                if group not in grouped:
+                    grouped[group] = []
+                grouped[group].append(cmd)
+            
+            for group, cmds in grouped.items():
+                group_name = cls._get_group_name(group)
+                lines.append(f"[{group_name}]")
+                lines.append("")
+                
+                for cmd in cmds:
+                    name = cmd["name"]
+                    help_text = cmd["info"].get("help", "暂无描述")
+                    command_map[global_idx] = cmd
+                    lines.append(f"{global_idx}. {prefix}{name} - {help_text}")
+                    global_idx += 1
+                
+                lines.append("")
+        else:
+            lines.append("[所有命令]")
+            lines.append("")
+            for cmd in commands:
+                name = cmd["name"]
+                help_text = cmd["info"].get("help", "暂无描述")
+                command_map[global_idx] = cmd
+                lines.append(f"{global_idx}. {prefix}{name} - {help_text}")
+                global_idx += 1
+            lines.append("")
+        
+        lines.append("----------")
+        lines.append(f"共 {len(commands)} 个可用命令")
+        
+        return "\n".join(lines)
+    
+    @classmethod
+    def _build_command_detail_inline(cls, name: str, info: Dict, prefix: str) -> str:
+        """
+        构建内联命令详情（用于展开区域）
+        """
+        parts = []
+        
+        # 描述
+        parts.append(f"""<div style="margin-bottom: 8px;">
+        <strong style="font-size: 12px; color: {cls.PRIMARY_COLOR};">描述:</strong>
+        <span style="font-size: 12px; margin-left: 8px;">{info.get('help', '暂无描述')}</span>
+    </div>""")
+        
+        # 别名 - 从全局 command.aliases 获取
+        main_name = info.get('main_name', name)
+        aliases = []
+        for alias, mapped_name in command.aliases.items():
+            if mapped_name == main_name and alias != main_name:
+                aliases.append(alias)
+        
+        if aliases:
+            aliases_text = ", ".join(f"<code style='font-size: 11px;'>{prefix}{a}</code>" for a in aliases)
+            parts.append(f"""<div style="margin-bottom: 8px;">
+        <strong style="font-size: 12px; color: {cls.PRIMARY_COLOR};">别名:</strong>
+        <span style="font-size: 12px; margin-left: 8px;">{aliases_text}</span>
+    </div>""")
+        
+        # 用法
+        if info.get("usage"):
+            parts.append(f"""<div style="margin-bottom: 8px;">
+        <strong style="font-size: 12px; color: {cls.PRIMARY_COLOR};">用法:</strong>
+        <span style="font-size: 12px; margin-left: 8px; font-family: monospace; background: rgba(0, 0, 0, 0.03); padding: 2px 6px; border-radius: 3px;">{info['usage'].replace('/', prefix)}</span>
+    </div>""")
+        
+        # 权限
+        if info.get("permission"):
+            parts.append(f"""<div style="margin-bottom: 8px;">
+        <strong style="font-size: 12px; color: {cls.PRIMARY_COLOR};">权限:</strong>
+        <span style="font-size: 12px; margin-left: 8px; color: {cls.WARNING_COLOR};">需要特殊权限</span>
+    </div>""")
+        
+        # 分组
+        if info.get("group"):
+            group_name = cls._get_group_name(info["group"])
+            parts.append(f"""<div style="margin-bottom: 8px;">
+        <strong style="font-size: 12px; color: {cls.PRIMARY_COLOR};">分组:</strong>
+        <span style="font-size: 12px; margin-left: 8px;">{group_name}</span>
+    </div>""")
+        
+        return "\n".join(parts)
+    
+    # ==================== 命令详情模板 ====================
+    
+    @classmethod
+    def build_command_detail(cls, cmd: Dict, prefix: str) -> Dict[str, str]:
+        # 构建 HTML
+        html = cls._build_command_detail_html(cmd, prefix)
+        
+        # 构建 Markdown
+        markdown = cls._build_command_detail_markdown(cmd, prefix)
+        
+        # 构建 Text
+        text = cls._build_command_detail_text(cmd, prefix)
+        
+        return {"html": html, "markdown": markdown, "text": text}
+    
+    @classmethod
+    def _build_command_detail_html(cls, cmd: Dict, prefix: str) -> str:
+        name = cmd["name"]
+        info = cmd["info"]
+        
+        html_parts = [
+            f"""<div style="padding: 12px; border-radius: 8px;">
+    <div style="color: {cls.PRIMARY_COLOR}; font-size: 16px; font-weight: bold; margin-bottom: 12px;">
+        命令详情: {prefix}{name}
+    </div>"""
+        ]
+        
+        # 描述
+        html_parts.append(f"""
+    <div style="margin-bottom: 12px; border: 1px solid #e0e0e0; padding: 12px; border-radius: 6px;">
+        <div style="margin-bottom: 8px;">
+            <strong style="font-size: 14px;">描述:</strong>
+        </div>
+        <div style="font-size: 13px;">
+            {info.get('help', '暂无描述')}
+        </div>
+    </div>""")
+        
+        # 别名 - 从全局 command.aliases 获取
+        main_name = info.get('main_name', name)
+        aliases = []
+        for alias, mapped_name in command.aliases.items():
+            if mapped_name == main_name and alias != main_name:
+                aliases.append(alias)
+        
+        if aliases:
+            aliases_text = ", ".join(f"{prefix}{a}" for a in aliases)
+            html_parts.append(f"""
+    <div style="margin-bottom: 8px;">
+        <div style="font-size: 13px; margin-bottom: 4px;">
+            <strong>别名:</strong>
+        </div>
+        <div style="font-size: 13px;">
+            {aliases_text}
+        </div>
+    </div>""")
+        
+        # 用法
+        if info.get("usage"):
+            html_parts.append(f"""
+    <div style="margin-bottom: 8px;">
+        <div style="font-size: 13px; margin-bottom: 4px;">
+            <strong>用法:</strong>
+        </div>
+        <div style="font-size: 13px; font-family: monospace; background: rgba(0, 0, 0, 0.03); padding: 6px; border-radius: 4px;">
+            {info['usage'].replace('/', prefix)}
+        </div>
+    </div>""")
+        
+        # 权限
+        if info.get("permission"):
+            html_parts.append(f"""
+    <div style="margin-bottom: 8px;">
+        <div style="font-size: 13px; margin-bottom: 4px;">
+            <strong>权限:</strong>
+        </div>
+        <div style="font-size: 13px; color: {cls.WARNING_COLOR};">
+            需要特殊权限
+        </div>
+    </div>""")
+        
+        # 分组
+        if info.get("group"):
+            group_name = cls._get_group_name(info["group"])
+            html_parts.append(f"""
+    <div style="margin-bottom: 8px;">
+        <div style="font-size: 13px; margin-bottom: 4px;">
+            <strong>分组:</strong>
+        </div>
+        <div style="font-size: 13px;">
+            {group_name}
+        </div>
+    </div>""")
+        
+        html_parts.append("</div>")
+        
+        return "\n".join(html_parts)
+    
+    @classmethod
+    def _build_command_detail_markdown(cls, cmd: Dict, prefix: str) -> str:
+        name = cmd["name"]
+        info = cmd["info"]
+        
+        lines = [
+            f"**命令详情:** `{prefix}{name}`",
+            "",
+            f"**描述:** {info.get('help', '暂无描述')}",
+            ""
+        ]
+        
+        # 别名 - 从全局 command.aliases 获取
+        main_name = info.get('main_name', name)
+        aliases = []
+        for alias, mapped_name in command.aliases.items():
+            if mapped_name == main_name and alias != main_name:
+                aliases.append(alias)
+        
+        if aliases:
+            aliases_text = ", ".join(f"`{prefix}{a}`" for a in aliases)
+            lines.append(f"**别名:** {aliases_text}")
+            lines.append("")
+        
+        # 用法
+        if info.get("usage"):
+            lines.append(f"**用法:** `{info['usage'].replace('/', prefix)}`")
+            lines.append("")
+        
+        # 权限
+        if info.get("permission"):
+            lines.append("**权限:** 需要特殊权限")
+            lines.append("")
+        
+        # 分组
+        if info.get("group"):
+            group_name = cls._get_group_name(info["group"])
+            lines.append(f"**分组:** {group_name}")
+            lines.append("")
+        
+        return "\n".join(lines)
+    
+    @classmethod
+    def _build_command_detail_text(cls, cmd: Dict, prefix: str) -> str:
+        name = cmd["name"]
+        info = cmd["info"]
+        
+        lines = [
+            f"命令详情: {prefix}{name}",
+            "----------",
+            f"描述: {info.get('help', '暂无描述')}",
+            ""
+        ]
+        
+        # 别名 - 从全局 command.aliases 获取
+        main_name = info.get('main_name', name)
+        aliases = []
+        for alias, mapped_name in command.aliases.items():
+            if mapped_name == main_name and alias != main_name:
+                aliases.append(alias)
+        
+        if aliases:
+            aliases_text = ", ".join(f"{prefix}{a}" for a in aliases)
+            lines.append(f"别名: {aliases_text}")
+            lines.append("")
+        
+        # 用法
+        if info.get("usage"):
+            lines.append(f"用法: {info['usage'].replace('/', prefix)}")
+            lines.append("")
+        
+        # 权限
+        if info.get("permission"):
+            lines.append("权限: 需要特殊权限")
+            lines.append("")
+        
+        # 分组
+        if info.get("group"):
+            group_name = cls._get_group_name(info["group"])
+            lines.append(f"分组: {group_name}")
+            lines.append("")
+        
+        return "\n".join(lines)
+    
+    # ==================== 错误消息模板 ====================
+    
+    @classmethod
+    def build_error(cls, title: str, message: str) -> Dict[str, str]:
+        html = f"""
+<div style="padding: 12px; border-radius: 8px;">
+    <div style="color: {cls.ERROR_COLOR}; font-size: 14px; font-weight: bold; margin-bottom: 8px;">{title}</div>
+    <div style="font-size: 13px;">{message}</div>
+</div>"""
+        
+        markdown = f"**{title}**\n\n{message}"
+        
+        text = f"{title}\n\n{message}"
+        
+        return {"html": html, "markdown": markdown, "text": text}

{erispulse_helpmodule-2.0.0 → erispulse_helpmodule-2.1.1}/ErisPulse_HelpModule.egg-info/PKG-INFO

@@ -1,15 +1,9 @@
 Metadata-Version: 2.4
 Name: ErisPulse-HelpModule
-Version: 2.0.0
+Version: 2.1.1
 Summary: ErisPulse 帮助命令模块，提供自动化的命令帮助系统，支持查看所有可用命令及其用法说明
 Author-email: wsu2059q <wsu2059@qq.com>
-License: Copyright 2025 wsu2059q
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License-Expression: MIT
 Project-URL: homepage, https://github.com/wsu2059q/ErisPulse-HelpModule
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{erispulse_helpmodule-2.0.0 → erispulse_helpmodule-2.1.1}/ErisPulse_HelpModule.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 ErisPulse_HelpModule/Core.py
 ErisPulse_HelpModule/__init__.py
+ErisPulse_HelpModule/templates.py
 ErisPulse_HelpModule.egg-info/PKG-INFO
 ErisPulse_HelpModule.egg-info/SOURCES.txt
 ErisPulse_HelpModule.egg-info/dependency_links.txt

{erispulse_helpmodule-2.0.0 → erispulse_helpmodule-2.1.1}/PKG-INFO

@@ -1,15 +1,9 @@
 Metadata-Version: 2.4
 Name: ErisPulse-HelpModule
-Version: 2.0.0
+Version: 2.1.1
 Summary: ErisPulse 帮助命令模块，提供自动化的命令帮助系统，支持查看所有可用命令及其用法说明
 Author-email: wsu2059q <wsu2059@qq.com>
-License: Copyright 2025 wsu2059q
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License-Expression: MIT
 Project-URL: homepage, https://github.com/wsu2059q/ErisPulse-HelpModule
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{erispulse_helpmodule-2.0.0 → erispulse_helpmodule-2.1.1}/pyproject.toml

@@ -1,10 +1,11 @@
 [project]
 name = "ErisPulse-HelpModule"
-version = "2.0.0"
+version = "2.1.1"
 description = "ErisPulse 帮助命令模块，提供自动化的命令帮助系统，支持查看所有可用命令及其用法说明"
 readme = "README.md"
 requires-python = ">=3.10"
-license = { file = "LICENSE" }
+license = "MIT"
+license-files = ["LICENSE"]
 authors = [ { name = "wsu2059q", email = "wsu2059@qq.com" } ]
 
 dependencies = [
@@ -15,3 +16,6 @@ dependencies = [
 
 [project.entry-points."erispulse.module"]
 "HelpModule" = "ErisPulse_HelpModule:HelpModule"
+
+[tool.setuptools.packages.find]
+include = ["ErisPulse_HelpModule*"]

erispulse_helpmodule-2.0.0/ErisPulse_HelpModule/Core.py

@@ -1,213 +0,0 @@
-from ErisPulse import sdk
-from ErisPulse.Core.Event import command
-from ErisPulse.Core import config
-from ErisPulse.Core.Bases import BaseModule
-from typing import Dict, List
-
-class HelpModule(BaseModule):
-    def __init__(self):
-        self.sdk = sdk
-        self.logger = sdk.logger.get_child("HelpModule")
-        self.command_list = []
-        
-    @staticmethod
-    def should_eager_load():
-        return True
-    
-    async def on_load(self, event):
-        self._register_commands()
-        self.logger.info("HelpModule 已加载")
-        return True
-        
-    async def on_unload(self, event):
-        self._unregister_commands()
-        self.logger.info("HelpModule 已卸载")
-        return True
-
-    def _get_config(self):
-        module_config = config.getConfig("HelpModule")
-        if not module_config:
-            default_config = {
-                "show_hidden_commands": False,
-                "group_commands": True
-            }
-            config.setConfig("HelpModule", default_config)
-            self.logger.warning("未找到HelpModule配置，已创建默认配置")
-            return default_config
-        return module_config
-    
-    def _get_command_prefix(self) -> str:
-        event_config = config.getConfig("ErisPulse.event", {})
-        command_config = event_config.get("command", {})
-        return command_config.get("prefix", "/")
-        
-    def _register_commands(self):
-        self.help_command_func = self._create_help_command()
-        command(
-            "help", 
-            aliases=["h", "帮助"], 
-            help="显示帮助信息",
-            usage="help [序号] - 显示命令列表或查看指定序号的命令详情"
-        )(self.help_command_func)
-
-    def _unregister_commands(self):
-        if hasattr(self, 'help_command_func'):
-            command.unregister(self.help_command_func)
-    
-    def _create_help_command(self):
-        async def help_command(event):
-            await self._handle_help_command(event)
-        return help_command
-
-    def _build_command_list(self) -> List[Dict]:
-        self.command_list = []
-        module_config = self._get_config()
-        show_hidden = module_config.get("show_hidden_commands", False)
-        
-        if show_hidden:
-            all_commands = command.get_commands()
-            for cmd_name in all_commands:
-                cmd_info = command.get_command(cmd_name)
-                if cmd_info and cmd_name == cmd_info.get("main_name"):
-                    self.command_list.append({
-                        "name": cmd_name,
-                        "info": cmd_info
-                    })
-        else:
-            visible_commands = command.get_visible_commands()
-            for cmd_name in visible_commands:
-                cmd_info = command.get_command(cmd_name)
-                if cmd_info and cmd_name == cmd_info.get("main_name"):
-                    self.command_list.append({
-                        "name": cmd_name,
-                        "info": cmd_info
-                    })
-        
-        return self.command_list
-
-    def _group_commands_by_category(self, commands: List[Dict]) -> Dict[str, List]:
-        grouped = {}
-        for cmd in commands:
-            group = cmd["info"].get("group") or "default"
-            if group not in grouped:
-                grouped[group] = []
-            grouped[group].append(cmd)
-        return grouped
-
-    async def _handle_help_command(self, event: Dict) -> None:
-        try:
-            platform = event["platform"]
-            if event.get("detail_type") == "group":
-                target_type = "group"
-                target_id = event["group_id"]
-            else:
-                target_type = "user"
-                target_id = event["user_id"]
-                
-            args = event.get("command", {}).get("args", [])
-            adapter = getattr(sdk.adapter, platform)
-            
-            commands = self._build_command_list()
-            
-            if args:
-                try:
-                    index = int(args[0]) - 1
-                    if 0 <= index < len(commands):
-                        help_text = self._format_command_detail(commands[index])
-                    else:
-                        help_text = f"错误: 序号超出范围，请输入 1-{len(commands)} 之间的序号"
-                except ValueError:
-                    help_text = "错误: 请输入有效的序号"
-            else:
-                help_text = self._format_command_list(commands)
-            
-            await adapter.Send.To(target_type, target_id).Text(help_text)
-        except Exception as e:
-            self.logger.error(f"处理帮助命令时出错: {e}")
-
-    def _format_command_list(self, commands: List[Dict]) -> str:
-        prefix = self._get_command_prefix()
-        module_config = self._get_config()
-        
-        lines = [
-            "命令帮助",
-            "-" * 10,
-            f"使用 '{prefix}help <序号>' 查看命令详情",
-            ""
-        ]
-        
-        if module_config.get("group_commands", True):
-            grouped = self._group_commands_by_category(commands)
-            
-            # 默认组
-            if "default" in grouped:
-                lines.append("[通用命令]")
-                for idx, cmd in enumerate(grouped["default"], 1):
-                    name = cmd["name"]
-                    help_text = cmd["info"].get("help", "暂无描述")
-                    lines.append(f"{idx}. {prefix}{name} - {help_text}")
-                lines.append("")
-            
-            # 其他组
-            for group, cmds in grouped.items():
-                if group == "default":
-                    continue
-                group_name = str(group) if group else "其他"
-                lines.append(f"[{group_name}命令]")
-                for idx, cmd in enumerate(cmds, 1):
-                    name = cmd["name"]
-                    help_text = cmd["info"].get("help", "暂无描述")
-                    lines.append(f"{idx}. {prefix}{name} - {help_text}")
-                lines.append("")
-        else:
-            lines.append("[所有命令]")
-            for idx, cmd in enumerate(commands, 1):
-                name = cmd["name"]
-                help_text = cmd["info"].get("help", "暂无描述")
-                lines.append(f"{idx}. {prefix}{name} - {help_text}")
-            lines.append("")
-        
-        lines.append("-" * 10)
-        lines.append(f"共 {len(commands)} 个可用命令")
-        
-        return "\n".join(lines)
-    
-    def _format_command_detail(self, cmd: Dict) -> str:
-        prefix = self._get_command_prefix()
-        name = cmd["name"]
-        info = cmd["info"]
-        
-        lines = [
-            f"命令详情: {prefix}{name}",
-            "-" * 10,
-            f"描述: {info.get('help', '暂无描述')}"
-        ]
-        
-        # 别名
-        aliases = []
-        for alias, main_name in command.aliases.items():
-            if main_name == info['main_name'] and alias != info['main_name']:
-                aliases.append(alias)
-        
-        if aliases:
-            lines.append(f"别名: {', '.join(f'{prefix}{a}' for a in aliases)}")
-        
-        # 用法
-        if info.get("usage"):
-            lines.append(f"用法: {info['usage'].replace('/', prefix)}")
-        
-        # 权限
-        if info.get("permission"):
-            lines.append("权限: 需要特殊权限")
-        
-        # 隐藏状态
-        if info.get("hidden"):
-            lines.append("状态: 隐藏命令")
-        
-        # 分组
-        if info.get("group"):
-            lines.append(f"分组: {info['group']}")
-        
-        lines.append("-" * 10)
-        
-        return "\n".join(lines)