AstrBot 4.5.1__py3-none-any.whl → 4.5.3__py3-none-any.whl

astrbot/core/platform/sources/weixin_official_account/weixin_offacc_adapter.py

@@ -1,28 +1,28 @@
+import asyncio
 import sys
 import uuid
-import asyncio
+
 import quart
+from requests import Response
+from wechatpy import WeChatClient, parse_message
+from wechatpy.crypto import WeChatCrypto
+from wechatpy.exceptions import InvalidSignatureException
+from wechatpy.messages import BaseMessage, ImageMessage, TextMessage, VoiceMessage
+from wechatpy.utils import check_signature
 
+from astrbot.api.event import MessageChain
+from astrbot.api.message_components import Image, Plain, Record
 from astrbot.api.platform import (
-    Platform,
     AstrBotMessage,
     MessageMember,
-    PlatformMetadata,
     MessageType,
+    Platform,
+    PlatformMetadata,
+    register_platform_adapter,
 )
-from astrbot.api.event import MessageChain
-from astrbot.api.message_components import Plain, Image, Record
-from astrbot.core.platform.astr_message_event import MessageSesion
-from astrbot.api.platform import register_platform_adapter
 from astrbot.core import logger
-from requests import Response
+from astrbot.core.platform.astr_message_event import MessageSesion
 
-from wechatpy.utils import check_signature
-from wechatpy.crypto import WeChatCrypto
-from wechatpy import WeChatClient
-from wechatpy.messages import TextMessage, ImageMessage, VoiceMessage, BaseMessage
-from wechatpy.exceptions import InvalidSignatureException
-from wechatpy import parse_message
 from .weixin_offacc_event import WeixinOfficialAccountPlatformEvent
 
 if sys.version_info >= (3, 12):
@@ -40,10 +40,14 @@ class WecomServer:
         self.encoding_aes_key = config.get("encoding_aes_key")
         self.appid = config.get("appid")
         self.server.add_url_rule(
-            "/callback/command", view_func=self.verify, methods=["GET"]
+            "/callback/command",
+            view_func=self.verify,
+            methods=["GET"],
         )
         self.server.add_url_rule(
-            "/callback/command", view_func=self.callback_command, methods=["POST"]
+            "/callback/command",
+            view_func=self.callback_command,
+            methods=["POST"],
         )
         self.crypto = WeChatCrypto(self.token, self.encoding_aes_key, self.appid)
 
@@ -97,7 +101,7 @@ class WecomServer:
 
     async def start_polling(self):
         logger.info(
-            f"将在 {self.callback_server_host}:{self.port} 端口启动 微信公众平台 适配器。"
+            f"将在 {self.callback_server_host}:{self.port} 端口启动 微信公众平台 适配器。",
         )
         await self.server.run_task(
             host=self.callback_server_host,
@@ -112,22 +116,25 @@ class WecomServer:
 @register_platform_adapter("weixin_official_account", "微信公众平台 适配器")
 class WeixinOfficialAccountPlatformAdapter(Platform):
     def __init__(
-        self, platform_config: dict, platform_settings: dict, event_queue: asyncio.Queue
+        self,
+        platform_config: dict,
+        platform_settings: dict,
+        event_queue: asyncio.Queue,
     ) -> None:
         super().__init__(event_queue)
         self.config = platform_config
         self.settingss = platform_settings
         self.client_self_id = uuid.uuid4().hex[:8]
         self.api_base_url = platform_config.get(
-            "api_base_url", "https://api.weixin.qq.com/cgi-bin/"
+            "api_base_url",
+            "https://api.weixin.qq.com/cgi-bin/",
         )
         self.active_send_mode = self.config.get("active_send_mode", False)
 
         if not self.api_base_url:
             self.api_base_url = "https://api.weixin.qq.com/cgi-bin/"
 
-        if self.api_base_url.endswith("/"):
-            self.api_base_url = self.api_base_url[:-1]
+        self.api_base_url = self.api_base_url.removesuffix("/")
         if not self.api_base_url.endswith("/cgi-bin"):
             self.api_base_url += "/cgi-bin"
 
@@ -161,7 +168,8 @@ class WeixinOfficialAccountPlatformAdapter(Platform):
                         await self.convert_message(msg, future)
                     # I love shield so much!
                     result = await asyncio.wait_for(
-                        asyncio.shield(future), 60
+                        asyncio.shield(future),
+                        60,
                     )  # wait for 60s
                     logger.debug(f"Got future result: {result}")
                     self.wexin_event_workers.pop(msg.id, None)
@@ -175,7 +183,9 @@ class WeixinOfficialAccountPlatformAdapter(Platform):
 
     @override
     async def send_by_session(
-        self, session: MessageSesion, message_chain: MessageChain
+        self,
+        session: MessageSesion,
+        message_chain: MessageChain,
     ):
         await super().send_by_session(session, message_chain)
 
@@ -192,7 +202,9 @@ class WeixinOfficialAccountPlatformAdapter(Platform):
         await self.server.start_polling()
 
     async def convert_message(
-        self, msg, future: asyncio.Future = None
+        self,
+        msg,
+        future: asyncio.Future = None,
     ) -> AstrBotMessage | None:
         abm = AstrBotMessage()
         if isinstance(msg, TextMessage):
@@ -224,7 +236,9 @@ class WeixinOfficialAccountPlatformAdapter(Platform):
             assert isinstance(msg, VoiceMessage)
 
             resp: Response = await asyncio.get_event_loop().run_in_executor(
-                None, self.client.media.download, msg.media_id
+                None,
+                self.client.media.download,
+                msg.media_id,
             )
             path = f"data/temp/wecom_{msg.media_id}.amr"
             with open(path, "wb") as f:
@@ -238,7 +252,7 @@ class WeixinOfficialAccountPlatformAdapter(Platform):
                 audio.export(path_wav, format="wav")
             except Exception as e:
                 logger.error(
-                    f"转换音频失败: {e}。如果没有安装 pydub 和 ffmpeg 请先安装。"
+                    f"转换音频失败: {e}。如果没有安装 pydub 和 ffmpeg 请先安装。",
                 )
                 path_wav = path
                 return

astrbot/core/platform/sources/weixin_official_account/weixin_offacc_event.py

@@ -1,21 +1,20 @@
-import uuid
 import asyncio
-from astrbot.api.event import AstrMessageEvent, MessageChain
-from astrbot.api.platform import AstrBotMessage, PlatformMetadata
-from astrbot.api.message_components import Plain, Image, Record
-from wechatpy import WeChatClient
-from wechatpy.replies import TextReply, ImageReply, VoiceReply
+import uuid
 
+from wechatpy import WeChatClient
+from wechatpy.replies import ImageReply, TextReply, VoiceReply
 
 from astrbot.api import logger
+from astrbot.api.event import AstrMessageEvent, MessageChain
+from astrbot.api.message_components import Image, Plain, Record
+from astrbot.api.platform import AstrBotMessage, PlatformMetadata
 
 try:
     import pydub
 except Exception:
     logger.warning(
-        "检测到 pydub 库未安装，微信公众平台将无法语音收发。如需使用语音，请前往管理面板 -> 控制台 -> 安装 Pip 库安装 pydub。"
+        "检测到 pydub 库未安装，微信公众平台将无法语音收发。如需使用语音，请前往管理面板 -> 控制台 -> 安装 Pip 库安装 pydub。",
     )
-    pass
 
 
 class WeixinOfficialAccountPlatformEvent(AstrMessageEvent):
@@ -32,7 +31,9 @@ class WeixinOfficialAccountPlatformEvent(AstrMessageEvent):
 
     @staticmethod
     async def send_with_client(
-        client: WeChatClient, message: MessageChain, user_name: str
+        client: WeChatClient,
+        message: MessageChain,
+        user_name: str,
     ):
         pass
 
@@ -43,44 +44,44 @@ class WeixinOfficialAccountPlatformEvent(AstrMessageEvent):
             plain (str): 要分割的长文本
         Returns:
             list[str]: 分割后的文本列表
+
         """
         if len(plain) <= 2048:
             return [plain]
-        else:
-            result = []
-            start = 0
-            while start < len(plain):
-                # 剩下的字符串长度<2048时结束
-                if start + 2048 >= len(plain):
-                    result.append(plain[start:])
+        result = []
+        start = 0
+        while start < len(plain):
+            # 剩下的字符串长度<2048时结束
+            if start + 2048 >= len(plain):
+                result.append(plain[start:])
+                break
+
+            # 向前搜索分割标点符号
+            end = min(start + 2048, len(plain))
+            cut_position = end
+            for i in range(end, start, -1):
+                if i < len(plain) and plain[i - 1] in [
+                    "。",
+                    "！",
+                    "？",
+                    ".",
+                    "!",
+                    "?",
+                    "\n",
+                    ";",
+                    "；",
+                ]:
+                    cut_position = i
                     break
 
-                # 向前搜索分割标点符号
-                end = min(start + 2048, len(plain))
+            # 没找到合适的位置分割, 直接切分
+            if cut_position == end and end < len(plain):
                 cut_position = end
-                for i in range(end, start, -1):
-                    if i < len(plain) and plain[i - 1] in [
-                        "。",
-                        "！",
-                        "？",
-                        ".",
-                        "!",
-                        "?",
-                        "\n",
-                        ";",
-                        "；",
-                    ]:
-                        cut_position = i
-                        break
-
-                # 没找到合适的位置分割, 直接切分
-                if cut_position == end and end < len(plain):
-                    cut_position = end
-
-                result.append(plain[start:cut_position])
-                start = cut_position
-
-            return result
+
+            result.append(plain[start:cut_position])
+            start = cut_position
+
+        return result
 
     async def send(self, message: MessageChain):
         message_obj = self.message_obj
@@ -111,7 +112,7 @@ class WeixinOfficialAccountPlatformEvent(AstrMessageEvent):
                     except Exception as e:
                         logger.error(f"微信公众平台上传图片失败: {e}")
                         await self.send(
-                            MessageChain().message(f"微信公众平台上传图片失败: {e}")
+                            MessageChain().message(f"微信公众平台上传图片失败: {e}"),
                         )
                         return
                     logger.debug(f"微信公众平台上传图片返回: {response}")
@@ -136,7 +137,8 @@ class WeixinOfficialAccountPlatformEvent(AstrMessageEvent):
                 # 转成amr
                 record_path_amr = f"data/temp/{uuid.uuid4()}.amr"
                 pydub.AudioSegment.from_wav(record_path).export(
-                    record_path_amr, format="amr"
+                    record_path_amr,
+                    format="amr",
                 )
 
                 with open(record_path_amr, "rb") as f:
@@ -145,7 +147,7 @@ class WeixinOfficialAccountPlatformEvent(AstrMessageEvent):
                     except Exception as e:
                         logger.error(f"微信公众平台上传语音失败: {e}")
                         await self.send(
-                            MessageChain().message(f"微信公众平台上传语音失败: {e}")
+                            MessageChain().message(f"微信公众平台上传语音失败: {e}"),
                         )
                         return
                     logger.info(f"微信公众平台上传语音返回: {response}")
@@ -178,7 +180,7 @@ class WeixinOfficialAccountPlatformEvent(AstrMessageEvent):
             else:
                 buffer.chain.extend(chain.chain)
         if not buffer:
-            return
+            return None
         buffer.squash_plain()
         await self.send(buffer)
         return await super().send_streaming(generator, use_fallback)

astrbot/core/platform_message_history_mgr.py

@@ -11,8 +11,8 @@ class PlatformMessageHistoryManager:
         platform_id: str,
         user_id: str,
         content: list[dict],  # TODO: parse from message chain
-        sender_id: str = None,
-        sender_name: str = None,
+        sender_id: str | None = None,
+        sender_name: str | None = None,
     ):
         """Insert a new platform message history record."""
         await self.db.insert_platform_message_history(
@@ -43,5 +43,7 @@ class PlatformMessageHistoryManager:
     async def delete(self, platform_id: str, user_id: str, offset_sec: int = 86400):
         """Delete platform message history records older than the specified offset."""
         await self.db.delete_platform_message_offset(
-            platform_id=platform_id, user_id=user_id, offset_sec=offset_sec
+            platform_id=platform_id,
+            user_id=user_id,
+            offset_sec=offset_sec,
         )

astrbot/core/provider/__init__.py

@@ -1,5 +1,4 @@
-from .provider import Provider, Personality, STTProvider
-
 from .entities import ProviderMetaData
+from .provider import Personality, Provider, STTProvider
 
-__all__ = ["Provider", "Personality", "ProviderMetaData", "STTProvider"]
+__all__ = ["Personality", "Provider", "ProviderMetaData", "STTProvider"]

astrbot/core/provider/entites.py

@@ -1,19 +1,19 @@
 from astrbot.core.provider.entities import (
+    AssistantMessageSegment,
+    LLMResponse,
+    ProviderMetaData,
     ProviderRequest,
     ProviderType,
-    ProviderMetaData,
-    ToolCallsResult,
-    AssistantMessageSegment,
     ToolCallMessageSegment,
-    LLMResponse,
+    ToolCallsResult,
 )
 
 __all__ = [
+    "AssistantMessageSegment",
+    "LLMResponse",
+    "ProviderMetaData",
     "ProviderRequest",
     "ProviderType",
-    "ProviderMetaData",
-    "ToolCallsResult",
-    "AssistantMessageSegment",
     "ToolCallMessageSegment",
-    "LLMResponse",
+    "ToolCallsResult",
 ]

astrbot/core/provider/entities.py

@@ -1,20 +1,24 @@
-import enum
 import base64
+import enum
 import json
-from astrbot.core.utils.io import download_image_by_url
-from astrbot import logger
 from dataclasses import dataclass, field
-from typing import List, Dict, Type, Any
-from astrbot.core.agent.tool import ToolSet
-from openai.types.chat.chat_completion import ChatCompletion
+from typing import Any
+
+from anthropic.types import Message as AnthropicMessage
 from google.genai.types import GenerateContentResponse
-from anthropic.types import Message
-from openai.types.chat.chat_completion_message_tool_call import (
-    ChatCompletionMessageToolCall,
+from openai.types.chat.chat_completion import ChatCompletion
+
+import astrbot.core.message.components as Comp
+from astrbot import logger
+from astrbot.core.agent.message import (
+    AssistantMessageSegment,
+    ToolCall,
+    ToolCallMessageSegment,
 )
+from astrbot.core.agent.tool import ToolSet
 from astrbot.core.db.po import Conversation
 from astrbot.core.message.message_event_result import MessageChain
-import astrbot.core.message.components as Comp
+from astrbot.core.utils.io import download_image_by_url
 
 
 class ProviderType(enum.Enum):
@@ -30,9 +34,9 @@ class ProviderMetaData:
     type: str
     """提供商适配器名称，如 openai, ollama"""
     desc: str = ""
-    """提供商适配器描述."""
+    """提供商适配器描述"""
     provider_type: ProviderType = ProviderType.CHAT_COMPLETION
-    cls_type: Type | None = None
+    cls_type: Any = None
 
     default_config_tmpl: dict | None = None
     """平台的默认配置模板"""
@@ -40,57 +44,19 @@ class ProviderMetaData:
     """显示在 WebUI 配置页中的提供商名称，如空则是 type"""
 
 
-@dataclass
-class ToolCallMessageSegment:
-    """OpenAI 格式的上下文中 role 为 tool 的消息段。参考: https://platform.openai.com/docs/guides/function-calling"""
-
-    tool_call_id: str
-    content: str
-    role: str = "tool"
-
-    def to_dict(self):
-        return {
-            "tool_call_id": self.tool_call_id,
-            "content": self.content,
-            "role": self.role,
-        }
-
-
-@dataclass
-class AssistantMessageSegment:
-    """OpenAI 格式的上下文中 role 为 assistant 的消息段。参考: https://platform.openai.com/docs/guides/function-calling"""
-
-    content: str | None = None
-    tool_calls: List[ChatCompletionMessageToolCall | Dict] = field(default_factory=list)
-    role: str = "assistant"
-
-    def to_dict(self):
-        ret: dict[str, str | list[dict]] = {
-            "role": self.role,
-        }
-        if self.content:
-            ret["content"] = self.content
-        if self.tool_calls:
-            tool_calls_dict = [
-                tc if isinstance(tc, dict) else tc.to_dict() for tc in self.tool_calls
-            ]
-            ret["tool_calls"] = tool_calls_dict
-        return ret
-
-
 @dataclass
 class ToolCallsResult:
     """工具调用结果"""
 
     tool_calls_info: AssistantMessageSegment
     """函数调用的信息"""
-    tool_calls_result: List[ToolCallMessageSegment]
+    tool_calls_result: list[ToolCallMessageSegment]
     """函数调用的结果"""
 
-    def to_openai_messages(self) -> List[Dict]:
+    def to_openai_messages(self) -> list[dict]:
         ret = [
-            self.tool_calls_info.to_dict(),
-            *[item.to_dict() for item in self.tool_calls_result],
+            self.tool_calls_info.model_dump(),
+            *[item.model_dump() for item in self.tool_calls_result],
         ]
         return ret
 
@@ -106,16 +72,16 @@ class ProviderRequest:
     func_tool: ToolSet | None = None
     """可用的函数工具"""
     contexts: list[dict] = field(default_factory=list)
-    """上下文。格式与 openai 的上下文格式一致：
+    """
+    OpenAI 格式上下文列表。
     参考 https://platform.openai.com/docs/api-reference/chat/create#chat-create-messages
     """
     system_prompt: str = ""
     """系统提示词"""
     conversation: Conversation | None = None
-
+    """关联的对话对象"""
     tool_calls_result: list[ToolCallsResult] | ToolCallsResult | None = None
     """附加的上次请求后工具调用的结果。参考: https://platform.openai.com/docs/guides/function-calling#handling-function-calls"""
-
     model: str | None = None
     """模型名称，为 None 时使用提供商的默认模型"""
 
@@ -175,13 +141,13 @@ class ProviderRequest:
 
         return result_parts
 
-    async def assemble_context(self) -> Dict:
+    async def assemble_context(self) -> dict:
         """将请求(prompt 和 image_urls)包装成 OpenAI 的消息格式。"""
         if self.image_urls:
             user_content = {
                 "role": "user",
                 "content": [
-                    {"type": "text", "text": self.prompt if self.prompt else "[图片]"}
+                    {"type": "text", "text": self.prompt if self.prompt else "[图片]"},
                 ],
             }
             for image_url in self.image_urls:
@@ -197,11 +163,10 @@ class ProviderRequest:
                     logger.warning(f"图片 {image_url} 得到的结果为空，将忽略。")
                     continue
                 user_content["content"].append(
-                    {"type": "image_url", "image_url": {"url": image_data}}
+                    {"type": "image_url", "image_url": {"url": image_data}},
                 )
             return user_content
-        else:
-            return {"role": "user", "content": self.prompt}
+        return {"role": "user", "content": self.prompt}
 
     async def _encode_image_bs64(self, image_url: str) -> str:
         """将图片转换为 base64"""
@@ -219,15 +184,17 @@ class LLMResponse:
     """角色, assistant, tool, err"""
     result_chain: MessageChain | None = None
     """返回的消息链"""
-    tools_call_args: List[Dict[str, Any]] = field(default_factory=list)
+    tools_call_args: list[dict[str, Any]] = field(default_factory=list)
     """工具调用参数"""
-    tools_call_name: List[str] = field(default_factory=list)
+    tools_call_name: list[str] = field(default_factory=list)
     """工具调用名称"""
-    tools_call_ids: List[str] = field(default_factory=list)
+    tools_call_ids: list[str] = field(default_factory=list)
     """工具调用 ID"""
 
-    raw_completion: ChatCompletion | GenerateContentResponse | Message | None = None
-    _new_record: Dict[str, Any] | None = None
+    raw_completion: (
+        ChatCompletion | GenerateContentResponse | AnthropicMessage | None
+    ) = None
+    _new_record: dict[str, Any] | None = None
 
     _completion_text: str = ""
 
@@ -239,11 +206,14 @@ class LLMResponse:
         role: str,
         completion_text: str = "",
         result_chain: MessageChain | None = None,
-        tools_call_args: List[Dict[str, Any]] | None = None,
-        tools_call_name: List[str] | None = None,
-        tools_call_ids: List[str] | None = None,
-        raw_completion: ChatCompletion | None = None,
-        _new_record: Dict[str, Any] | None = None,
+        tools_call_args: list[dict[str, Any]] | None = None,
+        tools_call_name: list[str] | None = None,
+        tools_call_ids: list[str] | None = None,
+        raw_completion: ChatCompletion
+        | GenerateContentResponse
+        | AnthropicMessage
+        | None = None,
+        _new_record: dict[str, Any] | None = None,
         is_chunk: bool = False,
     ):
         """初始化 LLMResponse
@@ -255,6 +225,7 @@ class LLMResponse:
             tools_call_args (List[Dict[str, any]], optional): 工具调用参数. Defaults to None.
             tools_call_name (List[str], optional): 工具调用名称. Defaults to None.
             raw_completion (ChatCompletion, optional): 原始响应, OpenAI 格式. Defaults to None.
+
         """
         if tools_call_args is None:
             tools_call_args = []
@@ -291,8 +262,8 @@ class LLMResponse:
         else:
             self._completion_text = value
 
-    def to_openai_tool_calls(self) -> List[Dict]:
-        """将工具调用信息转换为 OpenAI 格式"""
+    def to_openai_tool_calls(self) -> list[dict]:
+        """Convert to OpenAI tool calls format. Deprecated, use to_openai_to_calls_model instead."""
         ret = []
         for idx, tool_call_arg in enumerate(self.tools_call_args):
             ret.append(
@@ -303,7 +274,22 @@ class LLMResponse:
                         "arguments": json.dumps(tool_call_arg),
                     },
                     "type": "function",
-                }
+                },
+            )
+        return ret
+
+    def to_openai_to_calls_model(self) -> list[ToolCall]:
+        """The same as to_openai_tool_calls but return pydantic model."""
+        ret = []
+        for idx, tool_call_arg in enumerate(self.tools_call_args):
+            ret.append(
+                ToolCall(
+                    id=self.tools_call_ids[idx],
+                    function=ToolCall.FunctionBody(
+                        name=self.tools_call_name[idx],
+                        arguments=json.dumps(tool_call_arg),
+                    ),
+                ),
             )
         return ret