mofox-plugin-dev-toolkit 0.3.3__py3-none-any.whl

mpdt/templates/action_template.py

@@ -0,0 +1,102 @@
+"""
+Action 组件模板
+"""
+
+ACTION_TEMPLATE = '''"""
+{description}
+
+Created by: {author}
+Created at: {date}
+"""
+
+from src.common.logger import get_logger
+from src.plugin_system import BaseAction, ActionActivationType, ChatMode
+
+logger = get_logger(__name__)
+
+
+class {class_name}(BaseAction):
+    """
+    {description}
+
+    Action 组件用于执行聊天中的具体动作任务。
+    """
+
+    # Action 元数据
+    action_name: str = "{component_name}"
+    action_description: str = "{description}"
+
+    # 激活配置
+    mode_enable: list[ChatMode] = [ChatMode.FOCUS, ChatMode.NORMAL]  # 支持的聊天模式
+    parallel_action: bool = False  # 是否允许与其他 Action 并行执行
+
+    # 专注模式激活配置
+    focus_activation_type: ActionActivationType = ActionActivationType.KEYWORD
+    # 普通模式激活配置
+    normal_activation_type: ActionActivationType = ActionActivationType.LLM_JUDGE
+
+    # 激活条件
+    activation_keywords: list[str] = ["关键词1", "关键词2"]  # 关键词激活时使用
+    keyword_case_sensitive: bool = False  # 关键词是否区分大小写
+
+    # LLM 判断激活的提示词
+    llm_judge_prompt: str = """
+判断用户是否需要执行某个特定操作。
+如果需要，返回 true，否则返回 false。
+"""
+
+    async def go_activate(self, llm_judge_model=None) -> bool:
+        """
+        自定义激活逻辑（推荐方式）
+
+        可以组合使用以下工具函数：
+        - await self._keyword_match(["关键词"])  # 关键词匹配
+        - await self._random_activation(0.3)  # 随机激活（30%概率）
+        - await self._llm_judge_activation(prompt, llm_judge_model)  # LLM判断
+
+        Returns:
+            是否激活此 Action
+        """
+        # 示例：关键词匹配
+        return await self._keyword_match(self.activation_keywords, self.keyword_case_sensitive)
+
+    async def execute(self) -> tuple[bool, str]:
+        """
+        执行 Action 的主要逻辑
+
+        可以使用以下方法：
+        - await self.send_text("文本内容")  # 发送文本消息
+        - await self.send_image(image_base64)  # 发送图片
+        - await self.send_command("command_name", args)  # 调用命令
+        - await self.call_action("action_name", data)  # 调用其他 Action
+        - await self.wait_for_new_message(timeout)  # 等待用户回复
+
+        Returns:
+            (是否成功, 结果消息)
+        """
+        try:
+            logger.info(f"执行 Action: {{self.action_name}}")
+
+            # TODO: 实现 Action 的核心逻辑
+
+            # 示例：发送消息
+            await self.send_text("Action 执行成功！")
+
+            # 存储 Action 信息到上下文
+            await self.store_action_info(
+                action_build_into_prompt=True,
+                action_prompt_display=f"执行了 {{self.action_name}}",
+                action_done=True
+            )
+
+            return True, "执行成功"
+
+        except Exception as e:
+            logger.error(f"Action 执行失败: {{e}}")
+            return False, f"执行失败: {{e}}"
+'''
+
+
+def get_action_template() -> str:
+    """获取 Action 组件模板"""
+    return ACTION_TEMPLATE

mpdt/templates/adapter_template.py

@@ -0,0 +1,129 @@
+"""
+Adapter 组件模板
+"""
+
+ADAPTER_TEMPLATE = '''"""
+{description}
+
+Created by: {author}
+Created at: {date}
+"""
+
+from typing import Any
+
+from mofox_wire import MessageEnvelope
+from src.common.logger import get_logger
+from src.plugin_system import BaseAdapter
+
+logger = get_logger(__name__)
+
+
+class {class_name}(BaseAdapter):
+    """
+    {description}
+
+    Adapter 组件用于连接不同的平台或服务。
+
+    支持的场景：
+    - QQ/微信等聊天平台
+    - Discord/Telegram 等国际平台
+    - 自定义 API 服务
+    - WebSocket/HTTP 协议适配
+    """
+
+    # Adapter 元数据
+    adapter_name: str = "{adapter_name}"
+    adapter_version: str = "1.0.0"
+    adapter_author: str = "{author}"
+    adapter_description: str = "{description}"
+
+    # 是否在子进程中运行
+    run_in_subprocess: bool = False
+    # 子进程启动脚本路径（相对于插件目录）
+    subprocess_entry: str | None = None
+
+    async def from_platform_message(self, raw: Any) -> MessageEnvelope:
+        """
+        将平台原始消息转换为标准 MessageEnvelope 格式
+
+        Args:
+            raw: 平台原始消息对象
+
+        Returns:
+            MessageEnvelope: 标准消息信封
+        """
+        try:
+            logger.debug(f"转换平台消息: {{raw}}")
+
+            # TODO: 解析平台消息并转换为 MessageEnvelope
+            # 示例：
+            # message_id = raw.get("message_id")
+            # user_id = raw.get("user_id")
+            # content = raw.get("content")
+            # timestamp = raw.get("timestamp")
+            #
+            # return MessageEnvelope(
+            #     message_id=message_id,
+            #     user_id=user_id,
+            #     content=content,
+            #     timestamp=timestamp,
+            #     platform="your_platform"
+            # )
+
+            raise NotImplementedError("需要实现 from_platform_message 方法")
+
+        except Exception as e:
+            logger.error(f"转换消息失败: {{e}}")
+            raise
+
+    async def _send_platform_message(self, envelope: MessageEnvelope) -> None:
+        """
+        发送消息到平台
+
+        Args:
+            envelope: 要发送的消息信封
+        """
+        try:
+            logger.info(f"发送消息: {{envelope.message_id}}")
+
+            # TODO: 实现发送消息逻辑
+            # 将 MessageEnvelope 转换为平台格式并发送
+            # 示例：
+            # platform_message = {{
+            #     "target_id": envelope.target_id,
+            #     "content": envelope.content,
+            #     "message_type": envelope.message_type
+            # }}
+            # await self.platform_api.send(platform_message)
+
+            raise NotImplementedError("需要实现 _send_platform_message 方法")
+
+        except Exception as e:
+            logger.error(f"发送消息失败: {{e}}")
+            raise
+
+    async def on_adapter_loaded(self) -> None:
+        """
+        适配器加载时的钩子
+        可以在这里执行初始化逻辑
+        """
+        logger.info(f"{{self.adapter_name}} 适配器加载完成")
+
+        # TODO: 初始化逻辑
+        # 例如：建立连接、加载配置、启动后台任务等
+
+    async def on_adapter_unloaded(self) -> None:
+        """
+        适配器卸载时的钩子
+        可以在这里执行清理逻辑
+        """
+        logger.info(f"{{self.adapter_name}} 适配器卸载")
+
+        # TODO: 清理逻辑
+        # 例如：关闭连接、保存状态、停止后台任务等
+'''
+
+
+def get_adapter_template() -> str:
+    """获取 Adapter 组件模板"""
+    return ADAPTER_TEMPLATE

mpdt/templates/chatter_template.py

@@ -0,0 +1,103 @@
+"""
+Chatter 组件模板
+"""
+
+CHATTER_TEMPLATE = '''"""
+{description}
+
+Created by: {author}
+Created at: {date}
+"""
+
+from src.common.data_models.message_manager_data_model import StreamContext
+from src.common.logger import get_logger
+from src.plugin_system import BaseChatter, ChatType
+
+logger = get_logger(__name__)
+
+
+class {class_name}(BaseChatter):
+    """
+    {description}
+
+    Chatter 组件用于处理聊天流程，控制对话的整体逻辑。
+
+    使用场景：
+    - 自定义对话流程
+    - 特殊聊天模式处理
+    - 对话状态管理
+    - 多轮对话控制
+    """
+
+    # Chatter 元数据
+    chatter_name: str = "{chatter_name}"
+    chatter_description: str = "{description}"
+    chat_types: list[ChatType] = [ChatType.PRIVATE, ChatType.GROUP]  # 支持的聊天类型
+
+    async def execute(self, context: StreamContext) -> dict:
+        """
+        执行聊天处理逻辑
+
+        Args:
+            context: StreamContext对象，包含聊天上下文信息
+                - context.stream_id: 聊天流ID
+                - context.user_id: 用户ID
+                - context.user_name: 用户名
+                - context.message_content: 消息内容
+                - context.chat_type: 聊天类型
+                - 等等...
+
+        Returns:
+            处理结果字典，包含：
+                - success: 是否成功
+                - response: 响应内容（可选）
+                - next_action: 下一步动作（可选）
+        """
+        try:
+            logger.info(f"执行 Chatter: {{self.chatter_name}}")
+            logger.debug(f"聊天上下文: {{context}}")
+
+            # TODO: 实现聊天处理逻辑
+
+            # 示例：根据消息内容处理
+            message = context.message_content
+            user_name = context.user_name
+
+            # 可以使用 action_manager 调用 Action
+            # result = await self.action_manager.execute_action("action_name", {{}})
+
+            # 构建响应
+            response = self._generate_response(message, user_name)
+
+            return {{
+                "success": True,
+                "response": response,
+                "next_action": None
+            }}
+
+        except Exception as e:
+            logger.error(f"Chatter 执行失败: {{e}}")
+            return {{
+                "success": False,
+                "error": str(e)
+            }}
+
+    def _generate_response(self, message: str, user_name: str) -> str:
+        """
+        生成响应内容
+
+        Args:
+            message: 用户消息
+            user_name: 用户名
+
+        Returns:
+            响应文本
+        """
+        # TODO: 实现响应生成逻辑
+        return f"收到 {{user_name}} 的消息: {{message}}"
+'''
+
+
+def get_chatter_template() -> str:
+    """获取 Chatter 组件模板"""
+    return CHATTER_TEMPLATE

mpdt/templates/event_template.py

@@ -0,0 +1,116 @@
+"""
+Event Handler 组件模板
+"""
+
+EVENT_HANDLER_TEMPLATE = '''"""
+{description}
+
+Created by: {author}
+Created at: {date}
+"""
+
+from src.common.logger import get_logger
+from src.plugin_system import BaseEventHandler, HandlerResult
+
+logger = get_logger(__name__)
+
+
+class {class_name}(BaseEventHandler):
+    """
+    {description}
+
+    Event Handler 组件用于处理系统事件。
+
+    处理的事件类型: {event_type}
+
+    使用场景：
+    - 监听消息事件
+    - 监听系统事件
+    - 实现事件驱动逻辑
+    - 在特定事件发生时执行操作
+    """
+
+    # Event Handler 元数据
+    handler_name: str = "{class_name}"
+    event_types: list[str] = ["{event_type}"]  # 监听的事件类型列表
+    weight: int = 100  # 权重：0-1000，数字越大优先级越高
+
+    async def execute(self, params: dict) -> HandlerResult:
+        """
+        处理事件
+
+        Args:
+            params: 事件参数字典，包含事件相关的所有信息
+
+        Returns:
+            HandlerResult: 处理结果
+                - success: 是否成功
+                - continue_process: 是否继续处理后续 handler
+                - message: 返回消息
+        """
+        try:
+            logger.info(f"处理事件: {{self.handler_name}}")
+            logger.debug(f"事件参数: {{params}}")
+
+            # 检查是否应该处理此事件
+            if not self._should_handle(params):
+                logger.debug("跳过此事件")
+                return HandlerResult(
+                    success=True,
+                    continue_process=True,
+                    message="已跳过",
+                    handler_name=self.handler_name
+                )
+
+            # TODO: 实现事件处理逻辑
+            result = await self._process_event(params)
+
+            logger.info("事件处理完成")
+            return HandlerResult(
+                success=True,
+                continue_process=True,  # 设为 False 可以阻止后续 handler 执行
+                message=result,
+                handler_name=self.handler_name
+            )
+
+        except Exception as e:
+            logger.error(f"事件处理失败: {{e}}")
+            return HandlerResult(
+                success=False,
+                continue_process=True,
+                message=str(e),
+                handler_name=self.handler_name
+            )
+
+    def _should_handle(self, params: dict) -> bool:
+        """
+        判断是否应该处理该事件
+
+        Args:
+            params: 事件参数
+
+        Returns:
+            是否处理
+        """
+        # TODO: 实现判断逻辑
+        # 示例: 检查事件类型、来源、条件等
+        return True
+
+    async def _process_event(self, params: dict) -> str:
+        """
+        处理事件的具体逻辑
+
+        Args:
+            params: 事件参数
+
+        Returns:
+            处理结果消息
+        """
+        # TODO: 实现具体的事件处理逻辑
+        return "处理成功"
+'''
+
+
+def get_event_handler_template() -> str:
+    """获取 Event Handler 组件模板"""
+    return EVENT_HANDLER_TEMPLATE

mpdt/templates/plus_command_template.py

@@ -0,0 +1,150 @@
+"""
+PlusCommand 组件模板
+"""
+
+PLUS_COMMAND_TEMPLATE = '''"""
+{description}
+
+Created by: {author}
+Created at: {date}
+"""
+
+from src.common.logger import get_logger
+from src.plugin_system import BasePlusCommand
+
+logger = get_logger(__name__)
+
+
+class {class_name}(BasePlusCommand):
+    """
+    {description}
+
+    PlusCommand 是增强型命令，支持：
+    - 复杂的参数解析
+    - 子命令系统
+    - 权限检查
+    - 更丰富的交互方式
+    """
+
+    # PlusCommand 元数据
+    command_name: str = "{command_name}"
+    command_description: str = "{description}"
+    command_aliases: list[str] = []  # 命令别名
+    usage: str = "{command_name} [子命令] [选项]"
+
+    async def execute(self, **kwargs) -> tuple[bool, str]:
+        """
+        执行命令
+
+        可以访问的参数：
+        - self.stream_context: 聊天流上下文
+        - self.raw_text: 原始命令文本
+        - self.command_args: 解析后的命令参数
+
+        Returns:
+            (是否成功, 结果消息)
+        """
+        try:
+            logger.info(f"执行 PlusCommand: {{self.command_name}}")
+
+            # 获取命令参数
+            args = self.command_args if hasattr(self, "command_args") else []
+
+            if not args:
+                return True, self._help_message()
+
+            subcommand = args[0]
+            subcommand_args = args[1:] if len(args) > 1 else []
+
+            # 执行子命令
+            if subcommand == "list":
+                return await self._list_command(subcommand_args)
+            elif subcommand == "add":
+                return await self._add_command(subcommand_args)
+            elif subcommand == "remove":
+                return await self._remove_command(subcommand_args)
+            elif subcommand == "help":
+                return True, self._help_message()
+            else:
+                return False, f"未知子命令: {{subcommand}}\\n{{self._help_message()}}"
+
+        except Exception as e:
+            logger.error(f"命令执行失败: {{e}}")
+            return False, f"执行失败: {{e}}"
+
+    async def _list_command(self, args: list[str]) -> tuple[bool, str]:
+        """
+        列表子命令
+
+        Args:
+            args: 参数列表
+
+        Returns:
+            (是否成功, 结果消息)
+        """
+        # TODO: 实现列表功能
+        return True, "列表功能"
+
+    async def _add_command(self, args: list[str]) -> tuple[bool, str]:
+        """
+        添加子命令
+
+        Args:
+            args: 参数列表
+
+        Returns:
+            (是否成功, 结果消息)
+        """
+        if not args:
+            return False, f"用法: {{self.command_name}} add <项目>"
+
+        item = " ".join(args)
+        # TODO: 实现添加功能
+        return True, f"已添加: {{item}}"
+
+    async def _remove_command(self, args: list[str]) -> tuple[bool, str]:
+        """
+        删除子命令
+
+        Args:
+            args: 参数列表
+
+        Returns:
+            (是否成功, 结果消息)
+        """
+        if not args:
+            return False, f"用法: {{self.command_name}} remove <项目>"
+
+        item = " ".join(args)
+        # TODO: 实现删除功能
+        return True, f"已删除: {{item}}"
+
+    def _help_message(self) -> str:
+        """
+        生成帮助信息
+
+        Returns:
+            帮助信息文本
+        """
+        return f"""
+命令: {{self.command_name}}
+描述: {{self.command_description}}
+用法: {{self.usage}}
+
+子命令:
+    list       列出所有项目
+    add        添加新项目
+    remove     删除项目
+    help       显示此帮助信息
+
+示例:
+    {{self.command_name}} list
+    {{self.command_name}} add item1
+    {{self.command_name}} remove item1
+"""
+'''
+
+
+def get_plus_command_template() -> str:
+    """获取 PlusCommand 组件模板"""
+    return PLUS_COMMAND_TEMPLATE

mpdt/templates/prompt_template.py

@@ -0,0 +1,92 @@
+"""
+Prompt 组件模板
+"""
+
+PROMPT_TEMPLATE = '''"""
+{description}
+
+Created by: {author}
+Created at: {date}
+"""
+
+from src.chat.utils.prompt_params import PromptParameters
+from src.common.logger import get_logger
+from src.plugin_system.base.component_types import InjectionRule
+logger = get_logger(__name__)
+
+
+class {class_name}(BasePrompt):
+    """
+    {description}
+
+    Prompt 组件用于向核心 Prompt 模板注入额外的上下文信息。
+
+    使用场景：
+    - 向系统提示词添加自定义指令
+    - 注入动态上下文信息
+    - 添加角色设定或行为规则
+    - 提供额外的背景知识
+    """
+
+    # Prompt 组件元数据
+    prompt_name: str = "{prompt_name}"
+    prompt_description: str = "{description}"
+
+    # 定义注入规则：指定要注入到哪个核心 Prompt，以什么方式注入
+    injection_rules = [
+        InjectionRule(
+            target_prompt="planner_prompt",  # 目标 Prompt 名称
+            injection_type=InjectionType.APPEND,  # 注入方式：APPEND(追加) 或 PREPEND(前置)
+            priority=50  # 优先级：0-100，数字越大优先级越高
+        )
+    ]
+
+    async def execute(self) -> str:
+        """
+        生成要注入的 Prompt 内容
+
+        可以访问 self.params 来获取上下文信息：
+        - self.params.user_id: 用户ID
+        - self.params.user_name: 用户名
+        - self.params.bot_name: 机器人名称
+        - self.params.recent_messages: 最近的消息列表
+        - self.params.chat_type: 聊天类型（私聊/群聊）
+        - 等等...
+
+        Returns:
+            要注入的文本内容
+        """
+        try:
+            logger.info(f"生成 Prompt: {{self.prompt_name}}")
+
+            # TODO: 根据 self.params 构建要注入的内容
+            # 示例：根据用户信息生成个性化提示词
+            user_name = self.params.user_name or "用户"
+
+            prompt_content = f"""
+# 特殊指令
+
+你正在与 {{user_name}} 对话。
+
+## 行为规则
+- 保持友好和专业的态度
+- 准确理解用户意图
+- 提供有价值的回答
+
+## 额外能力
+- 你可以执行特定的操作
+- 你有访问某些数据的权限
+"""
+
+            logger.debug(f"生成的内容: {{prompt_content[:100]}}...")
+            return prompt_content.strip()
+
+        except Exception as e:
+            logger.error(f"生成 Prompt 失败: {{e}}")
+            return ""
+'''
+
+
+def get_prompt_template() -> str:
+    """获取 Prompt 组件模板"""
+    return PROMPT_TEMPLATE