You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
128 lines
3.8 KiB
128 lines
3.8 KiB
# -*- coding: utf-8 -*-
|
|
"""
|
|
===================================
|
|
帮助命令
|
|
===================================
|
|
|
|
显示可用命令列表和使用说明。
|
|
"""
|
|
|
|
from typing import List
|
|
|
|
from bot.commands.base import BotCommand
|
|
from bot.models import BotMessage, BotResponse
|
|
|
|
|
|
class HelpCommand(BotCommand):
|
|
"""
|
|
帮助命令
|
|
|
|
显示所有可用命令的列表和使用说明。
|
|
也可以查看特定命令的详细帮助。
|
|
|
|
用法：
|
|
/help - 显示所有命令
|
|
/help analyze - 显示 analyze 命令的详细帮助
|
|
"""
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
return "help"
|
|
|
|
@property
|
|
def aliases(self) -> List[str]:
|
|
return ["h", "帮助", "?"]
|
|
|
|
@property
|
|
def description(self) -> str:
|
|
return "显示帮助信息"
|
|
|
|
@property
|
|
def usage(self) -> str:
|
|
return "/help [命令名]"
|
|
|
|
def execute(self, message: BotMessage, args: List[str]) -> BotResponse:
|
|
"""执行帮助命令"""
|
|
# 延迟导入避免循环依赖
|
|
from bot.dispatcher import get_dispatcher
|
|
|
|
dispatcher = get_dispatcher()
|
|
|
|
# 如果指定了命令名，显示该命令的详细帮助
|
|
if args:
|
|
cmd_name = args[0]
|
|
command = dispatcher.get_command(cmd_name)
|
|
|
|
if command is None:
|
|
return BotResponse.error_response(f"未知命令: {cmd_name}")
|
|
|
|
# 构建详细帮助
|
|
help_text = self._format_command_help(command, dispatcher.command_prefix)
|
|
return BotResponse.markdown_response(help_text)
|
|
|
|
# 显示所有命令列表
|
|
commands = dispatcher.list_commands(include_hidden=False)
|
|
prefix = dispatcher.command_prefix
|
|
|
|
help_text = self._format_help_list(commands, prefix)
|
|
return BotResponse.markdown_response(help_text)
|
|
|
|
def _format_help_list(self, commands: List[BotCommand], prefix: str) -> str:
|
|
"""格式化命令列表"""
|
|
lines = [
|
|
"📚 **股票分析助手 - 命令帮助**",
|
|
"",
|
|
"可用命令：",
|
|
"",
|
|
]
|
|
|
|
for cmd in commands:
|
|
# 命令名和别名
|
|
aliases_str = ""
|
|
if cmd.aliases:
|
|
# 过滤掉中文别名，只显示英文别名
|
|
en_aliases = [a for a in cmd.aliases if a.isascii()]
|
|
if en_aliases:
|
|
aliases_str = f" ({', '.join(prefix + a for a in en_aliases[:2])})"
|
|
|
|
lines.append(f"• {prefix}{cmd.name}{aliases_str} - {cmd.description}")
|
|
lines.append("")
|
|
|
|
lines.extend([
|
|
"",
|
|
"---",
|
|
f"💡 输入 {prefix}help <命令名> 查看详细用法",
|
|
"",
|
|
"**示例：**",
|
|
"",
|
|
f"• {prefix}analyze 301023 - 奕帆传动",
|
|
"",
|
|
f"• {prefix}market - 查看大盘复盘",
|
|
"",
|
|
f"• {prefix}batch - 批量分析自选股",
|
|
])
|
|
|
|
return "\n".join(lines)
|
|
|
|
def _format_command_help(self, command: BotCommand, prefix: str) -> str:
|
|
"""格式化单个命令的详细帮助"""
|
|
lines = [
|
|
f"📖 **{prefix}{command.name}** - {command.description}",
|
|
"",
|
|
f"**用法：** `{command.usage}`",
|
|
"",
|
|
]
|
|
|
|
# 别名
|
|
if command.aliases:
|
|
aliases = [f"`{prefix}{a}`" if a.isascii() else f"`{a}`" for a in command.aliases]
|
|
lines.append(f"**别名：** {', '.join(aliases)}")
|
|
lines.append("")
|
|
|
|
# 权限
|
|
if command.admin_only:
|
|
lines.append("⚠️ **需要管理员权限**")
|
|
lines.append("")
|
|
|
|
return "\n".join(lines)
|