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

astrbot/core/platform/sources/wechatpadpro/xml_data_parser.py

@@ -1,10 +1,13 @@
 from defusedxml import ElementTree as eT
+
 from astrbot.api import logger
 from astrbot.api.message_components import (
-    WechatEmoji as Emoji,
-    Plain,
-    Image,
     BaseMessageComponent,
+    Image,
+    Plain,
+)
+from astrbot.api.message_components import (
+    WechatEmoji as Emoji,
 )
 
 
@@ -15,7 +18,7 @@ class GeweDataParser:
         is_private_chat: bool = False,
         cached_texts=None,
         cached_images=None,
-        raw_message: dict = None,
+        raw_message: dict | None = None,
         downloader=None,
     ):
         self._xml = None
@@ -47,9 +50,7 @@ class GeweDataParser:
             raise
 
     async def parse_mutil_49(self) -> list[BaseMessageComponent] | None:
-        """
-        处理 msg_type == 49 的多种 appmsg 类型（目前支持 type==57）
-        """
+        """处理 msg_type == 49 的多种 appmsg 类型（目前支持 type==57）"""
         try:
             appmsg_type = self._format_to_xml().findtext(".//appmsg/type")
             if appmsg_type == "57":
@@ -59,9 +60,7 @@ class GeweDataParser:
         return None
 
     async def parse_reply(self) -> list[BaseMessageComponent]:
-        """
-        处理 type == 57 的引用消息：支持文本（1）、图片（3）、嵌套49（49）
-        """
+        """处理 type == 57 的引用消息：支持文本（1）、图片（3）、嵌套49（49）"""
         components = []
 
         try:
@@ -96,7 +95,9 @@ class GeweDataParser:
                             )
                             if cdn_url and self.downloader:
                                 image_resp = await self.downloader(
-                                    self.from_user_name, self.to_user_name, self.msg_id
+                                    self.from_user_name,
+                                    self.to_user_name,
+                                    self.msg_id,
                                 )
                                 quoted_image_b64 = (
                                     image_resp.get("Data", {})
@@ -111,11 +112,11 @@ class GeweDataParser:
                             [
                                 Image.fromBase64(quoted_image_b64),
                                 Plain(f"[引用] {nickname}: [引用的图片]"),
-                            ]
+                            ],
                         )
                     else:
                         components.append(
-                            Plain(f"[引用] {nickname}: [引用的图片 - 未能获取]")
+                            Plain(f"[引用] {nickname}: [引用的图片 - 未能获取]"),
                         )
 
                 case 49:  # 嵌套引用
@@ -143,9 +144,7 @@ class GeweDataParser:
         return components
 
     def parse_emoji(self) -> Emoji | None:
-        """
-        处理 msg_type == 47 的表情消息（emoji）
-        """
+        """处理 msg_type == 47 的表情消息（emoji）"""
         try:
             emoji_element = self._format_to_xml().find(".//emoji")
             if emoji_element is not None:

astrbot/core/platform/sources/wecom/wecom_adapter.py

@@ -41,10 +41,14 @@ class WecomServer:
         self.port = int(config.get("port"))
         self.callback_server_host = config.get("callback_server_host", "0.0.0.0")
         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.event_queue = event_queue
 
@@ -94,7 +98,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,
@@ -109,21 +113,24 @@ class WecomServer:
 @register_platform_adapter("wecom", "wecom 适配器")
 class WecomPlatformAdapter(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://qyapi.weixin.qq.com/cgi-bin/"
+            "api_base_url",
+            "https://qyapi.weixin.qq.com/cgi-bin/",
         )
 
         if not self.api_base_url:
             self.api_base_url = "https://qyapi.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"
 
@@ -165,7 +172,8 @@ class WecomPlatformAdapter(Platform):
                     return None
 
                 msg_new = await asyncio.get_event_loop().run_in_executor(
-                    None, get_latest_msg_item
+                    None,
+                    get_latest_msg_item,
                 )
                 if msg_new:
                     await self.convert_wechat_kf_message(msg_new)
@@ -176,7 +184,9 @@ class WecomPlatformAdapter(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)
 
@@ -195,10 +205,11 @@ class WecomPlatformAdapter(Platform):
             try:
                 acc_list = (
                     await loop.run_in_executor(
-                        None, self.wechat_kf_api.get_account_list
+                        None,
+                        self.wechat_kf_api.get_account_list,
                     )
                 ).get("account_list", [])
-                logger.debug(f"获取到微信客服列表: {str(acc_list)}")
+                logger.debug(f"获取到微信客服列表: {acc_list!s}")
                 for acc in acc_list:
                     name = acc.get("name", None)
                     if name != self.kf_name:
@@ -206,7 +217,7 @@ class WecomPlatformAdapter(Platform):
                     open_kfid = acc.get("open_kfid", None)
                     if not open_kfid:
                         logger.error("获取微信客服失败，open_kfid 为空。")
-                    logger.debug(f"Found open_kfid: {str(open_kfid)}")
+                    logger.debug(f"Found open_kfid: {open_kfid!s}")
                     kf_url = (
                         await loop.run_in_executor(
                             None,
@@ -216,7 +227,7 @@ class WecomPlatformAdapter(Platform):
                         )
                     ).get("url", "")
                     logger.info(
-                        f"请打开以下链接，在微信扫码以获取客服微信: https://api.cl2wm.cn/api/qrcode/code?text={kf_url}"
+                        f"请打开以下链接，在微信扫码以获取客服微信: https://api.cl2wm.cn/api/qrcode/code?text={kf_url}",
                     )
             except Exception as e:
                 logger.error(e)
@@ -256,7 +267,9 @@ class WecomPlatformAdapter(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,
             )
             temp_dir = os.path.join(get_astrbot_data_path(), "temp")
             path = os.path.join(temp_dir, f"wecom_{msg.media_id}.amr")
@@ -294,8 +307,8 @@ class WecomPlatformAdapter(Platform):
         await self.handle_msg(abm)
 
     async def convert_wechat_kf_message(self, msg: dict) -> AstrBotMessage | None:
-        msgtype = msg.get("msgtype", None)
-        external_userid = msg.get("external_userid", None)
+        msgtype = msg.get("msgtype")
+        external_userid = msg.get("external_userid")
         abm = AstrBotMessage()
         abm.raw_message = msg
         abm.raw_message["_wechat_kf_flag"] = None  # 方便处理
@@ -312,7 +325,9 @@ class WecomPlatformAdapter(Platform):
         elif msgtype == "image":
             media_id = msg.get("image", {}).get("media_id", "")
             resp: Response = await asyncio.get_event_loop().run_in_executor(
-                None, self.client.media.download, media_id
+                None,
+                self.client.media.download,
+                media_id,
             )
             path = f"data/temp/wechat_kf_{media_id}.jpg"
             with open(path, "wb") as f:
@@ -321,7 +336,9 @@ class WecomPlatformAdapter(Platform):
         elif msgtype == "voice":
             media_id = msg.get("voice", {}).get("media_id", "")
             resp: Response = await asyncio.get_event_loop().run_in_executor(
-                None, self.client.media.download, media_id
+                None,
+                self.client.media.download,
+                media_id,
             )
 
             temp_dir = os.path.join(get_astrbot_data_path(), "temp")

astrbot/core/platform/sources/wecom/wecom_event.py

@@ -1,22 +1,23 @@
+import asyncio
 import os
 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.enterprise import WeChatClient
-from .wecom_kf_message import WeChatKFMessage
 
 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
 from astrbot.core.utils.astrbot_path import get_astrbot_data_path
 
+from .wecom_kf_message import WeChatKFMessage
+
 try:
     import pydub
 except Exception:
     logger.warning(
-        "检测到 pydub 库未安装，企业微信将无法语音收发。如需使用语音，请前往管理面板 -> 控制台 -> 安装 Pip 库安装 pydub。"
+        "检测到 pydub 库未安装，企业微信将无法语音收发。如需使用语音，请前往管理面板 -> 控制台 -> 安装 Pip 库安装 pydub。",
     )
-    pass
 
 
 class WecomPlatformEvent(AstrMessageEvent):
@@ -33,7 +34,9 @@ class WecomPlatformEvent(AstrMessageEvent):
 
     @staticmethod
     async def send_with_client(
-        client: WeChatClient, message: MessageChain, user_name: str
+        client: WeChatClient,
+        message: MessageChain,
+        user_name: str,
     ):
         pass
 
@@ -44,44 +47,44 @@ class WecomPlatformEvent(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 +114,7 @@ class WecomPlatformEvent(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}")
@@ -126,7 +129,8 @@ class WecomPlatformEvent(AstrMessageEvent):
                     temp_dir = os.path.join(get_astrbot_data_path(), "temp")
                     record_path_amr = os.path.join(temp_dir, f"{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:
@@ -135,7 +139,7 @@ class WecomPlatformEvent(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}")
@@ -154,7 +158,9 @@ class WecomPlatformEvent(AstrMessageEvent):
                     plain_chunks = await self.split_plain(comp.text)
                     for chunk in plain_chunks:
                         self.client.message.send_text(
-                            message_obj.self_id, message_obj.session_id, chunk
+                            message_obj.self_id,
+                            message_obj.session_id,
+                            chunk,
                         )
                         await asyncio.sleep(0.5)  # Avoid sending too fast
                 elif isinstance(comp, Image):
@@ -166,7 +172,7 @@ class WecomPlatformEvent(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}")
@@ -181,7 +187,8 @@ class WecomPlatformEvent(AstrMessageEvent):
                     temp_dir = os.path.join(get_astrbot_data_path(), "temp")
                     record_path_amr = os.path.join(temp_dir, f"{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:
@@ -190,7 +197,7 @@ class WecomPlatformEvent(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}")
@@ -212,7 +219,7 @@ class WecomPlatformEvent(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/sources/wecom/wecom_kf.py

@@ -1,7 +1,4 @@
-# -*- coding: utf-8 -*-
-
-"""
-The MIT License (MIT)
+"""The MIT License (MIT)
 
 Copyright (c) 2014-2020 messense
 
@@ -28,15 +25,13 @@ from wechatpy.client.api.base import BaseWeChatAPI
 
 
 class WeChatKF(BaseWeChatAPI):
-    """
-    微信客服接口
+    """微信客服接口
 
     https://work.weixin.qq.com/api/doc/90000/90135/94670
     """
 
     def sync_msg(self, token, open_kfid, cursor="", limit=1000):
-        """
-        微信客户发送的消息、接待人员在企业微信回复的消息、发送消息接口发送失败事件（如被用户拒收）
+        """微信客户发送的消息、接待人员在企业微信回复的消息、发送消息接口发送失败事件（如被用户拒收）
         、客户点击菜单消息的回复消息，可以通过该接口获取具体的消息内容和事件。不支持读取通过发送消息接口发送的消息。
         支持的消息类型：文本、图片、语音、视频、文件、位置、链接、名片、小程序、事件。
 
@@ -57,8 +52,7 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/sync_msg", data=data)
 
     def get_service_state(self, open_kfid, external_userid):
-        """
-        获取会话状态
+        """获取会话状态
 
         ID	状态	说明
         0	未处理	新会话接入。可选择：1.直接用API自动回复消息。2.放进待接入池等待接待人员接待。3.指定接待人员进行接待
@@ -78,10 +72,13 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/service_state/get", data=data)
 
     def trans_service_state(
-        self, open_kfid, external_userid, service_state, servicer_userid=""
+        self,
+        open_kfid,
+        external_userid,
+        service_state,
+        servicer_userid="",
     ):
-        """
-        变更会话状态
+        """变更会话状态
 
         :param open_kfid: 客服帐号ID
         :param external_userid: 微信客户的external_userid
@@ -98,8 +95,7 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/service_state/trans", data=data)
 
     def get_servicer_list(self, open_kfid):
-        """
-        获取接待人员列表
+        """获取接待人员列表
 
         :param open_kfid: 客服帐号ID
         :return: 接口调用结果
@@ -110,8 +106,7 @@ class WeChatKF(BaseWeChatAPI):
         return self._get("kf/servicer/list", params=data)
 
     def add_servicer(self, open_kfid, userid_list):
-        """
-        添加接待人员
+        """添加接待人员
         添加指定客服帐号的接待人员。
 
         :param open_kfid: 客服帐号ID
@@ -128,8 +123,7 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/servicer/add", data=data)
 
     def del_servicer(self, open_kfid, userid_list):
-        """
-        删除接待人员
+        """删除接待人员
         从客服帐号删除接待人员
 
         :param open_kfid: 客服帐号ID
@@ -146,8 +140,7 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/servicer/del", data=data)
 
     def batchget_customer(self, external_userid_list):
-        """
-        客户基本信息获取
+        """客户基本信息获取
 
         :param external_userid_list: external_userid列表
         :return: 接口调用结果
@@ -161,16 +154,14 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/customer/batchget", data=data)
 
     def get_account_list(self):
-        """
-        获取客服帐号列表
+        """获取客服帐号列表
 
         :return: 接口调用结果
         """
         return self._get("kf/account/list")
 
     def add_contact_way(self, open_kfid, scene):
-        """
-        获取客服帐号链接
+        """获取客服帐号链接
 
         :param open_kfid: 	客服帐号ID
         :param scene: 场景值，字符串类型，由开发者自定义。不多于32字节;字符串取值范围(正则表达式)：[0-9a-zA-Z_-]*
@@ -180,18 +171,21 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/add_contact_way", data=data)
 
     def get_upgrade_service_config(self):
-        """
-        获取配置的专员与客户群
+        """获取配置的专员与客户群
 
         :return: 接口调用结果
         """
         return self._get("kf/customer/get_upgrade_service_config")
 
     def upgrade_service(
-        self, open_kfid, external_userid, service_type, member=None, groupchat=None
+        self,
+        open_kfid,
+        external_userid,
+        service_type,
+        member=None,
+        groupchat=None,
     ):
-        """
-        为客户升级为专员或客户群服务
+        """为客户升级为专员或客户群服务
 
         :param open_kfid: 	客服帐号ID
         :param external_userid: 微信客户的external_userid
@@ -200,7 +194,6 @@ class WeChatKF(BaseWeChatAPI):
         :param groupchat: 推荐的客户群，type等于2时有效
         :return: 接口调用结果
         """
-
         data = {
             "open_kfid": open_kfid,
             "external_userid": external_userid,
@@ -213,20 +206,17 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/customer/upgrade_service", data=data)
 
     def cancel_upgrade_service(self, open_kfid, external_userid):
-        """
-        为客户取消推荐
+        """为客户取消推荐
 
         :param open_kfid: 	客服帐号ID
         :param external_userid: 微信客户的external_userid
         :return: 接口调用结果
         """
-
         data = {"open_kfid": open_kfid, "external_userid": external_userid}
         return self._post("kf/customer/cancel_upgrade_service", data=data)
 
     def send_msg_on_event(self, code, msgtype, msg_content, msgid=None):
-        """
-        当特定的事件回调消息包含code字段，可以此code为凭证，调用该接口给用户发送相应事件场景下的消息，如客服欢迎语。
+        """当特定的事件回调消息包含code字段，可以此code为凭证，调用该接口给用户发送相应事件场景下的消息，如客服欢迎语。
         支持发送消息类型：文本、菜单消息。
 
         :param code: 事件响应消息对应的code。通过事件回调下发，仅可使用一次。
@@ -236,7 +226,6 @@ class WeChatKF(BaseWeChatAPI):
                       字符串取值范围(正则表达式)：[0-9a-zA-Z_-]*
         :return: 接口调用结果
         """
-
         data = {"code": code, "msgtype": msgtype}
         if msgid:
             data["msgid"] = msgid
@@ -244,8 +233,7 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/send_msg_on_event", data=data)
 
     def get_corp_statistic(self, start_time, end_time, open_kfid=None):
-        """
-        获取「客户数据统计」企业汇总数据
+        """获取「客户数据统计」企业汇总数据
 
         :param start_time: 开始时间
         :param end_time: 结束时间
@@ -256,10 +244,13 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/get_corp_statistic", data=data)
 
     def get_servicer_statistic(
-        self, start_time, end_time, open_kfid=None, servicer_userid=None
+        self,
+        start_time,
+        end_time,
+        open_kfid=None,
+        servicer_userid=None,
     ):
-        """
-        获取「客户数据统计」接待人员明细数据
+        """获取「客户数据统计」接待人员明细数据
 
         :param start_time: 开始时间
         :param end_time: 结束时间
@@ -276,8 +267,7 @@ class WeChatKF(BaseWeChatAPI):
         return self._post("kf/get_servicer_statistic", data=data)
 
     def account_update(self, open_kfid, name, media_id):
-        """
-        修改客服账号
+        """修改客服账号
 
         :param open_kfid: 客服帐号ID
         :param name: 客服名称