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

astrbot/core/star/star_tools.py

@@ -1,5 +1,4 @@
-"""
-插件开发工具集
+"""插件开发工具集
 封装了许多常用的操作，方便插件开发者使用
 
 说明:
@@ -21,47 +20,49 @@
 import inspect
 import os
 import uuid
+from collections.abc import Awaitable, Callable
 from pathlib import Path
-from typing import Union, Awaitable, Callable, Any, List, Optional, ClassVar
+from typing import Any, ClassVar
+
+from astrbot.api.platform import AstrBotMessage, MessageMember, MessageType
 from astrbot.core.message.components import BaseMessageComponent
 from astrbot.core.message.message_event_result import MessageChain
-from astrbot.api.platform import MessageMember, AstrBotMessage, MessageType
 from astrbot.core.platform.astr_message_event import MessageSesion
-from astrbot.core.star.context import Context
-from astrbot.core.star.star import star_map
-from astrbot.core.utils.astrbot_path import get_astrbot_data_path
 from astrbot.core.platform.sources.aiocqhttp.aiocqhttp_message_event import (
     AiocqhttpMessageEvent,
 )
 from astrbot.core.platform.sources.aiocqhttp.aiocqhttp_platform_adapter import (
     AiocqhttpAdapter,
 )
+from astrbot.core.star.context import Context
+from astrbot.core.star.star import star_map
+from astrbot.core.utils.astrbot_path import get_astrbot_data_path
 
 
 class StarTools:
-    """
-    提供给插件使用的便捷工具函数集合
+    """提供给插件使用的便捷工具函数集合
     这些方法封装了一些常用操作，使插件开发更加简单便捷!
     """
 
-    _context: ClassVar[Optional[Context]] = None
+    _context: ClassVar[Context | None] = None
 
     @classmethod
     def initialize(cls, context: Context) -> None:
-        """
-        初始化StarTools，设置context引用
+        """初始化StarTools，设置context引用
 
         Args:
             context: 暴露给插件的上下文
+
         """
         cls._context = context
 
     @classmethod
     async def send_message(
-        cls, session: Union[str, MessageSesion], message_chain: MessageChain
+        cls,
+        session: str | MessageSesion,
+        message_chain: MessageChain,
     ) -> bool:
-        """
-        根据session(unified_msg_origin)主动发送消息
+        """根据session(unified_msg_origin)主动发送消息
 
         Args:
             session: 消息会话。通过event.session或者event.unified_msg_origin获取
@@ -75,6 +76,7 @@ class StarTools:
 
         Note:
             qq_official(QQ官方API平台)不支持此方法
+
         """
         if cls._context is None:
             raise ValueError("StarTools not initialized")
@@ -88,21 +90,22 @@ class StarTools:
         message_chain: MessageChain,
         platform: str = "aiocqhttp",
     ):
-        """
-        根据 id(例如qq号, 群号等) 直接, 主动地发送消息
+        """根据 id(例如qq号, 群号等) 直接, 主动地发送消息
 
         Args:
             type (str): 消息类型, 可选: PrivateMessage, GroupMessage
             id (str): 目标ID, 例如QQ号, 群号等
             message_chain (MessageChain): 消息链
             platform (str): 可选的平台名称，默认平台(aiocqhttp), 目前只支持 aiocqhttp
+
         """
         if cls._context is None:
             raise ValueError("StarTools not initialized")
         platforms = cls._context.platform_manager.get_insts()
         if platform == "aiocqhttp":
             adapter = next(
-                (p for p in platforms if isinstance(p, AiocqhttpAdapter)), None
+                (p for p in platforms if isinstance(p, AiocqhttpAdapter)),
+                None,
             )
             if adapter is None:
                 raise ValueError("未找到适配器: AiocqhttpAdapter")
@@ -122,14 +125,13 @@ class StarTools:
         self_id: str,
         session_id: str,
         sender: MessageMember,
-        message: List[BaseMessageComponent],
+        message: list[BaseMessageComponent],
         message_str: str,
         message_id: str = "",
         raw_message: object = None,
         group_id: str = "",
     ) -> AstrBotMessage:
-        """
-        创建一个AstrBot消息对象
+        """创建一个AstrBot消息对象
 
         Args:
             type (str): 消息类型, 例如 "GroupMessage" "FriendMessage" "OtherMessage"
@@ -145,6 +147,7 @@ class StarTools:
 
         Returns:
             AstrBotMessage: 创建的消息对象
+
         """
         abm = AstrBotMessage()
         abm.type = MessageType(type)
@@ -162,23 +165,27 @@ class StarTools:
 
     @classmethod
     async def create_event(
-        cls, abm: AstrBotMessage, platform: str = "aiocqhttp", is_wake: bool = True
+        cls,
+        abm: AstrBotMessage,
+        platform: str = "aiocqhttp",
+        is_wake: bool = True,
     ) -> None:
-        """
-        创建并提交事件到指定平台
+        """创建并提交事件到指定平台
         当有需要创建一个事件, 触发某些处理流程时, 使用该方法
 
         Args:
             abm (AstrBotMessage): 要提交的消息对象, 请先使用 create_message 创建
             platform (str): 可选的平台名称，默认平台(aiocqhttp), 目前只支持 aiocqhttp
             is_wake (bool): 是否标记为唤醒事件, 默认为 True, 只有唤醒事件才会被 llm 响应
+
         """
         if cls._context is None:
             raise ValueError("StarTools not initialized")
         platforms = cls._context.platform_manager.get_insts()
         if platform == "aiocqhttp":
             adapter = next(
-                (p for p in platforms if isinstance(p, AiocqhttpAdapter)), None
+                (p for p in platforms if isinstance(p, AiocqhttpAdapter)),
+                None,
             )
             if adapter is None:
                 raise ValueError("未找到适配器: AiocqhttpAdapter")
@@ -196,12 +203,12 @@ class StarTools:
 
     @classmethod
     def activate_llm_tool(cls, name: str) -> bool:
-        """
-        激活一个已经注册的函数调用工具
+        """激活一个已经注册的函数调用工具
         注册的工具默认是激活状态
 
         Args:
             name (str): 工具名称
+
         """
         if cls._context is None:
             raise ValueError("StarTools not initialized")
@@ -209,11 +216,11 @@ class StarTools:
 
     @classmethod
     def deactivate_llm_tool(cls, name: str) -> bool:
-        """
-        停用一个已经注册的函数调用工具
+        """停用一个已经注册的函数调用工具
 
         Args:
             name (str): 工具名称
+
         """
         if cls._context is None:
             raise ValueError("StarTools not initialized")
@@ -227,14 +234,14 @@ class StarTools:
         desc: str,
         func_obj: Callable[..., Awaitable[Any]],
     ) -> None:
-        """
-        为函数调用（function-calling/tools-use）添加工具
+        """为函数调用（function-calling/tools-use）添加工具
 
         Args:
             name (str): 工具名称
             func_args (list): 函数参数列表
             desc (str): 工具描述
             func_obj (Awaitable): 函数对象，必须是异步函数
+
         """
         if cls._context is None:
             raise ValueError("StarTools not initialized")
@@ -242,21 +249,20 @@ class StarTools:
 
     @classmethod
     def unregister_llm_tool(cls, name: str) -> None:
-        """
-        删除一个函数调用工具
+        """删除一个函数调用工具
         如果再要启用，需要重新注册
 
         Args:
             name (str): 工具名称
+
         """
         if cls._context is None:
             raise ValueError("StarTools not initialized")
         cls._context.unregister_llm_tool(name)
 
     @classmethod
-    def get_data_dir(cls, plugin_name: Optional[str] = None) -> Path:
-        """
-        返回插件数据目录的绝对路径。
+    def get_data_dir(cls, plugin_name: str | None = None) -> Path:
+        """返回插件数据目录的绝对路径。
 
         此方法会在 data/plugin_data 目录下为插件创建一个专属的数据目录。如果未提供插件名称，
         会自动从调用栈中获取插件信息。
@@ -272,6 +278,7 @@ class StarTools:
                 - 无法获取调用者模块信息
                 - 无法获取模块的元数据信息
                 - 创建目录失败（权限不足或其他IO错误）
+
         """
         if not plugin_name:
             frame = inspect.currentframe()
@@ -294,7 +301,7 @@ class StarTools:
             raise ValueError("无法获取插件名称")
 
         data_dir = Path(
-            os.path.join(get_astrbot_data_path(), "plugin_data", plugin_name)
+            os.path.join(get_astrbot_data_path(), "plugin_data", plugin_name),
         )
 
         try:

astrbot/core/star/updator.py

@@ -1,12 +1,13 @@
 import os
-import zipfile
 import shutil
+import zipfile
 
-from ..updator import RepoZipUpdator
-from astrbot.core.utils.io import remove_dir, on_error
-from ..star.star import StarMetadata
 from astrbot.core import logger
 from astrbot.core.utils.astrbot_path import get_astrbot_plugin_path
+from astrbot.core.utils.io import on_error, remove_dir
+
+from ..star.star import StarMetadata
+from ..updator import RepoZipUpdator
 
 
 class PluginUpdator(RepoZipUpdator):
@@ -44,7 +45,7 @@ class PluginUpdator(RepoZipUpdator):
             remove_dir(plugin_path)
         except BaseException as e:
             logger.error(
-                f"删除旧版本插件 {plugin_path} 文件夹失败: {str(e)}，使用覆盖安装。"
+                f"删除旧版本插件 {plugin_path} 文件夹失败: {e!s}，使用覆盖安装。",
             )
 
         self.unzip_file(plugin_path + ".zip", plugin_path)
@@ -64,18 +65,17 @@ class PluginUpdator(RepoZipUpdator):
             if os.path.isdir(os.path.join(target_dir, update_dir, f)):
                 if os.path.exists(os.path.join(target_dir, f)):
                     shutil.rmtree(os.path.join(target_dir, f), onerror=on_error)
-            else:
-                if os.path.exists(os.path.join(target_dir, f)):
-                    os.remove(os.path.join(target_dir, f))
+            elif os.path.exists(os.path.join(target_dir, f)):
+                os.remove(os.path.join(target_dir, f))
             shutil.move(os.path.join(target_dir, update_dir, f), target_dir)
 
         try:
             logger.info(
-                f"删除临时文件: {zip_path} 和 {os.path.join(target_dir, update_dir)}"
+                f"删除临时文件: {zip_path} 和 {os.path.join(target_dir, update_dir)}",
             )
             shutil.rmtree(os.path.join(target_dir, update_dir), onerror=on_error)
             os.remove(zip_path)
         except BaseException:
             logger.warning(
-                f"删除更新文件失败，可以手动删除 {zip_path} 和 {os.path.join(target_dir, update_dir)}"
+                f"删除更新文件失败，可以手动删除 {zip_path} 和 {os.path.join(target_dir, update_dir)}",
             )

astrbot/core/umop_config_router.py

@@ -15,7 +15,10 @@ class UmopConfigRouter:
         """加载路由表"""
         # 从 SharedPreferences 中加载 umop_to_conf_id 映射
         sp_data = self.sp.get(
-            "umop_config_routing", {}, scope="global", scope_id="global"
+            "umop_config_routing",
+            {},
+            scope="global",
+            scope_id="global",
         )
         self.umop_to_conf_id = sp_data
 
@@ -37,6 +40,7 @@ class UmopConfigRouter:
 
         Returns:
             str | None: 配置文件 ID，如果没有找到则返回 None
+
         """
         for pattern, conf_id in self.umop_to_conf_id.items():
             if self._is_umo_match(pattern, umo):
@@ -52,11 +56,12 @@ class UmopConfigRouter:
 
         Raises:
             ValueError: 如果 new_routing 中的 key 格式不正确
+
         """
-        for part in new_routing.keys():
+        for part in new_routing:
             if not isinstance(part, str) or len(part.split(":")) != 3:
                 raise ValueError(
-                    "umop keys must be strings in the format [platform_id]:[message_type]:[session_id], with optional wildcards * or empty for all"
+                    "umop keys must be strings in the format [platform_id]:[message_type]:[session_id], with optional wildcards * or empty for all",
                 )
 
         self.umop_to_conf_id = new_routing
@@ -71,10 +76,11 @@ class UmopConfigRouter:
 
         Raises:
             ValueError: 如果 umo 格式不正确
+
         """
         if not isinstance(umo, str) or len(umo.split(":")) != 3:
             raise ValueError(
-                "umop must be a string in the format [platform_id]:[message_type]:[session_id], with optional wildcards * or empty for all"
+                "umop must be a string in the format [platform_id]:[message_type]:[session_id], with optional wildcards * or empty for all",
             )
 
         self.umop_to_conf_id[umo] = conf_id

astrbot/core/updator.py

@@ -1,12 +1,15 @@
 import os
-import psutil
 import sys
 import time
-from .zip_updator import ReleaseInfo, RepoZipUpdator
+
+import psutil
+
 from astrbot.core import logger
 from astrbot.core.config.default import VERSION
-from astrbot.core.utils.io import download_file
 from astrbot.core.utils.astrbot_path import get_astrbot_path
+from astrbot.core.utils.io import download_file
+
+from .zip_updator import ReleaseInfo, RepoZipUpdator
 
 
 class AstrBotUpdator(RepoZipUpdator):
@@ -67,11 +70,16 @@ class AstrBotUpdator(RepoZipUpdator):
             raise e
 
     async def check_update(
-        self, url: str, current_version: str, consider_prerelease: bool = True
+        self,
+        url: str,
+        current_version: str,
+        consider_prerelease: bool = True,
     ) -> ReleaseInfo:
         """检查更新"""
         return await super().check_update(
-            self.ASTRBOT_RELEASE_API, VERSION, consider_prerelease
+            self.ASTRBOT_RELEASE_API,
+            VERSION,
+            consider_prerelease,
         )
 
     async def get_releases(self) -> list:

astrbot/core/utils/astrbot_path.py

@@ -1,5 +1,4 @@
-"""
-Astrbot统一路径获取
+"""Astrbot统一路径获取
 
 项目路径：固定为源码所在路径
 根目录路径：默认为当前工作目录，可通过环境变量 ASTRBOT_ROOT 指定
@@ -14,7 +13,7 @@ import os
 def get_astrbot_path() -> str:
     """获取Astrbot项目路径"""
     return os.path.realpath(
-        os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../../")
+        os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../../"),
     )
 
 
@@ -22,8 +21,7 @@ def get_astrbot_root() -> str:
     """获取Astrbot根目录路径"""
     if path := os.environ.get("ASTRBOT_ROOT"):
         return os.path.realpath(path)
-    else:
-        return os.path.realpath(os.getcwd())
+    return os.path.realpath(os.getcwd())
 
 
 def get_astrbot_data_path() -> str:

astrbot/core/utils/dify_api_client.py

@@ -1,8 +1,11 @@
 import codecs
 import json
+from collections.abc import AsyncGenerator
+from typing import Any
+
+from aiohttp import ClientResponse, ClientSession
+
 from astrbot.core import logger
-from aiohttp import ClientSession, ClientResponse
-from typing import Dict, List, Any, AsyncGenerator
 
 
 async def _stream_sse(resp: ClientResponse) -> AsyncGenerator[dict, None]:
@@ -25,7 +28,6 @@ async def _stream_sse(resp: ClientResponse) -> AsyncGenerator[dict, None]:
             yield json.loads(buffer[5:])
         except json.JSONDecodeError:
             logger.warning(f"Drop invalid dify json data: {buffer[5:]}")
-            pass
 
 
 class DifyAPIClient:
@@ -39,50 +41,60 @@ class DifyAPIClient:
 
     async def chat_messages(
         self,
-        inputs: Dict,
+        inputs: dict,
         query: str,
         user: str,
         response_mode: str = "streaming",
         conversation_id: str = "",
-        files: List[Dict[str, Any]] = [],
+        files: list[dict[str, Any]] | None = None,
         timeout: float = 60,
-    ) -> AsyncGenerator[Dict[str, Any], None]:
+    ) -> AsyncGenerator[dict[str, Any], None]:
+        if files is None:
+            files = []
         url = f"{self.api_base}/chat-messages"
         payload = locals()
         payload.pop("self")
         payload.pop("timeout")
         logger.info(f"chat_messages payload: {payload}")
         async with self.session.post(
-            url, json=payload, headers=self.headers, timeout=timeout
+            url,
+            json=payload,
+            headers=self.headers,
+            timeout=timeout,
         ) as resp:
             if resp.status != 200:
                 text = await resp.text()
                 raise Exception(
-                    f"Dify /chat-messages 接口请求失败：{resp.status}. {text}"
+                    f"Dify /chat-messages 接口请求失败：{resp.status}. {text}",
                 )
             async for event in _stream_sse(resp):
                 yield event
 
     async def workflow_run(
         self,
-        inputs: Dict,
+        inputs: dict,
         user: str,
         response_mode: str = "streaming",
-        files: List[Dict[str, Any]] = [],
+        files: list[dict[str, Any]] | None = None,
         timeout: float = 60,
     ):
+        if files is None:
+            files = []
         url = f"{self.api_base}/workflows/run"
         payload = locals()
         payload.pop("self")
         payload.pop("timeout")
         logger.info(f"workflow_run payload: {payload}")
         async with self.session.post(
-            url, json=payload, headers=self.headers, timeout=timeout
+            url,
+            json=payload,
+            headers=self.headers,
+            timeout=timeout,
         ) as resp:
             if resp.status != 200:
                 text = await resp.text()
                 raise Exception(
-                    f"Dify /workflows/run 接口请求失败：{resp.status}. {text}"
+                    f"Dify /workflows/run 接口请求失败：{resp.status}. {text}",
                 )
             async for event in _stream_sse(resp):
                 yield event
@@ -91,7 +103,7 @@ class DifyAPIClient:
         self,
         file_path: str,
         user: str,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         url = f"{self.api_base}/files/upload"
         with open(file_path, "rb") as f:
             payload = {
@@ -99,7 +111,9 @@ class DifyAPIClient:
                 "file": f,
             }
             async with self.session.post(
-                url, data=payload, headers=self.headers
+                url,
+                data=payload,
+                headers=self.headers,
             ) as resp:
                 return await resp.json()  # {"id": "xxx", ...}
 
@@ -126,7 +140,11 @@ class DifyAPIClient:
             return await resp.json()
 
     async def rename(
-        self, conversation_id: str, name: str, user: str, auto_generate: bool = False
+        self,
+        conversation_id: str,
+        name: str,
+        user: str,
+        auto_generate: bool = False,
     ):
         # /conversations/:conversation_id/name
         url = f"{self.api_base}/conversations/{conversation_id}/name"