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

astrbot/core/message/message_event_result.py

@@ -1,15 +1,16 @@
 import enum
-
-from typing import List, Optional, Union, AsyncGenerator
+from collections.abc import AsyncGenerator
 from dataclasses import dataclass, field
+
+from typing_extensions import deprecated
+
 from astrbot.core.message.components import (
-    BaseMessageComponent,
-    Plain,
-    Image,
     At,
     AtAll,
+    BaseMessageComponent,
+    Image,
+    Plain,
 )
-from typing_extensions import deprecated
 
 
 @dataclass
@@ -20,18 +21,18 @@ class MessageChain:
     Attributes:
         `chain` (list): 用于顺序存储各个组件。
         `use_t2i_` (bool): 用于标记是否使用文本转图片服务。默认为 None，即跟随用户的设置。当设置为 True 时，将会使用文本转图片服务。
+
     """
 
-    chain: List[BaseMessageComponent] = field(default_factory=list)
-    use_t2i_: Optional[bool] = None  # None 为跟随用户设置
-    type: Optional[str] = None
+    chain: list[BaseMessageComponent] = field(default_factory=list)
+    use_t2i_: bool | None = None  # None 为跟随用户设置
+    type: str | None = None
     """消息链承载的消息的类型。可选，用于让消息平台区分不同业务场景的消息链。"""
 
     def message(self, message: str):
         """添加一条文本消息到消息链 `chain` 中。
 
         Example:
-
             CommandResult().message("Hello ").message("world!")
             # 输出 Hello world!
 
@@ -39,11 +40,10 @@ class MessageChain:
         self.chain.append(Plain(message))
         return self
 
-    def at(self, name: str, qq: Union[str, int]):
+    def at(self, name: str, qq: str | int):
         """添加一条 At 消息到消息链 `chain` 中。
 
         Example:
-
             CommandResult().at("张三", "12345678910")
             # 输出 @张三
 
@@ -55,7 +55,6 @@ class MessageChain:
         """添加一条 AtAll 消息到消息链 `chain` 中。
 
         Example:
-
             CommandResult().at_all()
             # 输出 @所有人
 
@@ -68,7 +67,6 @@ class MessageChain:
         """添加一条错误消息到消息链 `chain` 中
 
         Example:
-
             CommandResult().error("解析失败")
 
         """
@@ -82,7 +80,6 @@ class MessageChain:
             如果需要发送本地图片，请使用 `file_image` 方法。
 
         Example:
-
             CommandResult().image("https://example.com/image.jpg")
 
         """
@@ -96,6 +93,7 @@ class MessageChain:
             如果需要发送网络图片，请使用 `url_image` 方法。
 
         CommandResult().image("image.jpg")
+
         """
         self.chain.append(Image.fromFileSystem(path))
         return self
@@ -114,6 +112,7 @@ class MessageChain:
 
         Args:
             use_t2i (bool): 是否使用文本转图片服务。默认为 None，即跟随用户的设置。当设置为 True 时，将会使用文本转图片服务。
+
         """
         self.use_t2i_ = use_t2i
         return self
@@ -125,7 +124,7 @@ class MessageChain:
     def squash_plain(self):
         """将消息链中的所有 Plain 消息段聚合到第一个 Plain 消息段中。"""
         if not self.chain:
-            return
+            return None
 
         new_chain = []
         first_plain = None
@@ -153,6 +152,7 @@ class EventResultType(enum.Enum):
     Attributes:
         CONTINUE: 事件将会继续传播
         STOP: 事件将会终止传播
+
     """
 
     CONTINUE = enum.auto()
@@ -181,17 +181,18 @@ class MessageEventResult(MessageChain):
         `chain` (list): 用于顺序存储各个组件。
         `use_t2i_` (bool): 用于标记是否使用文本转图片服务。默认为 None，即跟随用户的设置。当设置为 True 时，将会使用文本转图片服务。
         `result_type` (EventResultType): 事件处理的结果类型。
+
     """
 
-    result_type: Optional[EventResultType] = field(
-        default_factory=lambda: EventResultType.CONTINUE
+    result_type: EventResultType | None = field(
+        default_factory=lambda: EventResultType.CONTINUE,
     )
 
-    result_content_type: Optional[ResultContentType] = field(
-        default_factory=lambda: ResultContentType.GENERAL_RESULT
+    result_content_type: ResultContentType | None = field(
+        default_factory=lambda: ResultContentType.GENERAL_RESULT,
     )
 
-    async_stream: Optional[AsyncGenerator] = None
+    async_stream: AsyncGenerator | None = None
     """异步流"""
 
     def stop_event(self) -> "MessageEventResult":
@@ -205,9 +206,7 @@ class MessageEventResult(MessageChain):
         return self
 
     def is_stopped(self) -> bool:
-        """
-        是否终止事件传播。
-        """
+        """是否终止事件传播。"""
         return self.result_type == EventResultType.STOP
 
     def set_async_stream(self, stream: AsyncGenerator) -> "MessageEventResult":
@@ -220,6 +219,7 @@ class MessageEventResult(MessageChain):
 
         Args:
             result_type (EventResultType): 事件处理的结果类型。
+
         """
         self.result_content_type = typ
         return self

astrbot/core/persona_mgr.py

@@ -1,8 +1,8 @@
+from astrbot import logger
+from astrbot.core.astrbot_config_mgr import AstrBotConfigManager
 from astrbot.core.db import BaseDatabase
 from astrbot.core.db.po import Persona, Personality
-from astrbot.core.astrbot_config_mgr import AstrBotConfigManager
 from astrbot.core.platform.message_session import MessageSession
-from astrbot import logger
 
 DEFAULT_PERSONALITY = Personality(
     prompt="You are a helpful and friendly assistant.",
@@ -41,12 +41,14 @@ class PersonaManager:
         return persona
 
     async def get_default_persona_v3(
-        self, umo: str | MessageSession | None = None
+        self,
+        umo: str | MessageSession | None = None,
     ) -> Personality:
         """获取默认 persona"""
         cfg = self.acm.get_conf(umo)
         default_persona_id = cfg.get("provider_settings", {}).get(
-            "default_personality", "default"
+            "default_personality",
+            "default",
         )
         if not default_persona_id or default_persona_id == "default":
             return DEFAULT_PERSONALITY
@@ -66,16 +68,19 @@ class PersonaManager:
     async def update_persona(
         self,
         persona_id: str,
-        system_prompt: str = None,
-        begin_dialogs: list[str] = None,
-        tools: list[str] = None,
+        system_prompt: str | None = None,
+        begin_dialogs: list[str] | None = None,
+        tools: list[str] | None = None,
     ):
         """更新指定 persona 的信息。tools 参数为 None 时表示使用所有工具，空列表表示不使用任何工具"""
         existing_persona = await self.db.get_persona_by_id(persona_id)
         if not existing_persona:
             raise ValueError(f"Persona with ID {persona_id} does not exist.")
         persona = await self.db.update_persona(
-            persona_id, system_prompt, begin_dialogs, tools=tools
+            persona_id,
+            system_prompt,
+            begin_dialogs,
+            tools=tools,
         )
         if persona:
             for i, p in enumerate(self.personas):
@@ -100,7 +105,10 @@ class PersonaManager:
         if await self.db.get_persona_by_id(persona_id):
             raise ValueError(f"Persona with ID {persona_id} already exists.")
         new_persona = await self.db.insert_persona(
-            persona_id, system_prompt, begin_dialogs, tools=tools
+            persona_id,
+            system_prompt,
+            begin_dialogs,
+            tools=tools,
         )
         self.personas.append(new_persona)
         self.get_v3_persona_data()
@@ -115,6 +123,7 @@ class PersonaManager:
             - list[dict]: 包含 persona 配置的字典列表。
             - list[Personality]: 包含 Personality 对象的列表。
             - Personality: 默认选择的 Personality 对象。
+
         """
         v3_persona_config = [
             {
@@ -136,7 +145,7 @@ class PersonaManager:
             if begin_dialogs:
                 if len(begin_dialogs) % 2 != 0:
                     logger.error(
-                        f"{persona_cfg['name']} 人格情景预设对话格式不对，条数应该为偶数。"
+                        f"{persona_cfg['name']} 人格情景预设对话格式不对，条数应该为偶数。",
                     )
                     begin_dialogs = []
                 user_turn = True
@@ -146,7 +155,7 @@ class PersonaManager:
                             "role": "user" if user_turn else "assistant",
                             "content": dialog,
                             "_no_save": None,  # 不持久化到 db
-                        }
+                        },
                     )
                     user_turn = not user_turn
 

astrbot/core/pipeline/__init__.py

@@ -27,15 +27,15 @@ STAGES_ORDER = [
 ]
 
 __all__ = [
-    "WakingCheckStage",
-    "WhitelistCheckStage",
-    "SessionStatusCheckStage",
-    "RateLimitStage",
     "ContentSafetyCheckStage",
+    "EventResultType",
+    "MessageEventResult",
     "PreProcessStage",
     "ProcessStage",
-    "ResultDecorateStage",
+    "RateLimitStage",
     "RespondStage",
-    "MessageEventResult",
-    "EventResultType",
+    "ResultDecorateStage",
+    "SessionStatusCheckStage",
+    "WakingCheckStage",
+    "WhitelistCheckStage",
 ]

astrbot/core/pipeline/content_safety_check/stage.py

@@ -1,9 +1,11 @@
-from typing import Union, AsyncGenerator
-from ..stage import Stage, register_stage
-from ..context import PipelineContext
-from astrbot.core.platform.astr_message_event import AstrMessageEvent
-from astrbot.core.message.message_event_result import MessageEventResult
+from collections.abc import AsyncGenerator
+
 from astrbot.core import logger
+from astrbot.core.message.message_event_result import MessageEventResult
+from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
+from ..context import PipelineContext
+from ..stage import Stage, register_stage
 from .strategies.strategy import StrategySelector
 
 
@@ -19,8 +21,10 @@ class ContentSafetyCheckStage(Stage):
         self.strategy_selector = StrategySelector(config)
 
     async def process(
-        self, event: AstrMessageEvent, check_text: str | None = None
-    ) -> Union[None, AsyncGenerator[None, None]]:
+        self,
+        event: AstrMessageEvent,
+        check_text: str | None = None,
+    ) -> None | AsyncGenerator[None, None]:
         """检查内容安全"""
         text = check_text if check_text else event.get_message_str()
         ok, info = self.strategy_selector.check(text)
@@ -28,8 +32,8 @@ class ContentSafetyCheckStage(Stage):
             if event.is_at_or_wake_command:
                 event.set_result(
                     MessageEventResult().message(
-                        "你的消息或者大模型的响应中包含不适当的内容，已被屏蔽。"
-                    )
+                        "你的消息或者大模型的响应中包含不适当的内容，已被屏蔽。",
+                    ),
                 )
                 yield
             event.stop_event()

astrbot/core/pipeline/content_safety_check/strategies/__init__.py

@@ -1,8 +1,7 @@
 import abc
-from typing import Tuple
 
 
 class ContentSafetyStrategy(abc.ABC):
     @abc.abstractmethod
-    def check(self, content: str) -> Tuple[bool, str]:
+    def check(self, content: str) -> tuple[bool, str]:
         raise NotImplementedError

astrbot/core/pipeline/content_safety_check/strategies/baidu_aip.py

@@ -1,10 +1,9 @@
-"""
-使用此功能应该先 pip install baidu-aip
-"""
+"""使用此功能应该先 pip install baidu-aip"""
 
-from . import ContentSafetyStrategy
 from aip import AipContentCensor
 
+from . import ContentSafetyStrategy
+
 
 class BaiduAipStrategy(ContentSafetyStrategy):
     def __init__(self, appid: str, ak: str, sk: str) -> None:
@@ -19,12 +18,12 @@ class BaiduAipStrategy(ContentSafetyStrategy):
             return False, ""
         if res["conclusionType"] == 1:
             return True, ""
-        else:
-            if "data" not in res:
-                return False, ""
-            count = len(res["data"])
-            info = f"百度审核服务发现 {count} 处违规：\n"
-            for i in res["data"]:
-                info += f"{i['msg']}；\n"
-            info += "\n判断结果：" + res["conclusion"]
-            return False, info
+        if "data" not in res:
+            return False, ""
+        count = len(res["data"])
+        parts = [f"百度审核服务发现 {count} 处违规：\n"]
+        for i in res["data"]:
+            parts.append(f"{i['msg']}；\n")
+        parts.append("\n判断结果：" + res["conclusion"])
+        info = "".join(parts)
+        return False, info

astrbot/core/pipeline/content_safety_check/strategies/keywords.py

@@ -1,4 +1,5 @@
 import re
+
 from . import ContentSafetyStrategy
 
 

astrbot/core/pipeline/content_safety_check/strategies/strategy.py

@@ -1,16 +1,16 @@
-from . import ContentSafetyStrategy
-from typing import List, Tuple
 from astrbot import logger
 
+from . import ContentSafetyStrategy
+
 
 class StrategySelector:
     def __init__(self, config: dict) -> None:
-        self.enabled_strategies: List[ContentSafetyStrategy] = []
+        self.enabled_strategies: list[ContentSafetyStrategy] = []
         if config["internal_keywords"]["enable"]:
             from .keywords import KeywordsStrategy
 
             self.enabled_strategies.append(
-                KeywordsStrategy(config["internal_keywords"]["extra_keywords"])
+                KeywordsStrategy(config["internal_keywords"]["extra_keywords"]),
             )
         if config["baidu_aip"]["enable"]:
             try:
@@ -23,10 +23,10 @@ class StrategySelector:
                     config["baidu_aip"]["app_id"],
                     config["baidu_aip"]["api_key"],
                     config["baidu_aip"]["secret_key"],
-                )
+                ),
             )
 
-    def check(self, content: str) -> Tuple[bool, str]:
+    def check(self, content: str) -> tuple[bool, str]:
         for strategy in self.enabled_strategies:
             ok, info = strategy.check(content)
             if not ok:

astrbot/core/pipeline/context.py

@@ -1,7 +1,9 @@
 from dataclasses import dataclass
+
 from astrbot.core.config import AstrBotConfig
 from astrbot.core.star import PluginManager
-from .context_utils import call_handler, call_event_hook
+
+from .context_utils import call_event_hook, call_handler, call_local_llm_tool
 
 
 @dataclass
@@ -13,3 +15,4 @@ class PipelineContext:
     astrbot_config_id: str
     call_handler = call_handler
     call_event_hook = call_event_hook
+    call_local_llm_tool = call_local_llm_tool

astrbot/core/pipeline/context_utils.py

@@ -1,11 +1,14 @@
 import inspect
 import traceback
 import typing as T
+
 from astrbot import logger
-from astrbot.core.star.star_handler import star_handlers_registry, EventType
-from astrbot.core.star.star import star_map
-from astrbot.core.message.message_event_result import MessageEventResult, CommandResult
+from astrbot.core.agent.run_context import ContextWrapper
+from astrbot.core.astr_agent_context import AstrAgentContext
+from astrbot.core.message.message_event_result import CommandResult, MessageEventResult
 from astrbot.core.platform.astr_message_event import AstrMessageEvent
+from astrbot.core.star.star import star_map
+from astrbot.core.star.star_handler import EventType, star_handlers_registry
 
 
 async def call_handler(
@@ -26,6 +29,7 @@ async def call_handler(
 
     Returns:
         AsyncGenerator[None, None]: 异步生成器，用于在管道中传递控制流
+
     """
     ready_to_call = None  # 一个协程或者异步生成器
 
@@ -80,14 +84,17 @@ async def call_event_hook(
 
     Returns:
         bool: 如果事件被终止，返回 True
-    #"""
+    #
+
+    """
     handlers = star_handlers_registry.get_handlers_by_event_type(
-        hook_type, plugins_name=event.plugins_name
+        hook_type,
+        plugins_name=event.plugins_name,
     )
     for handler in handlers:
         try:
             logger.debug(
-                f"hook({hook_type.name}) -> {star_map[handler.handler_module_path].name} - {handler.handler_name}"
+                f"hook({hook_type.name}) -> {star_map[handler.handler_module_path].name} - {handler.handler_name}",
             )
             await handler.handler(event, *args, **kwargs)
         except BaseException:
@@ -95,8 +102,71 @@ async def call_event_hook(
 
         if event.is_stopped():
             logger.info(
-                f"{star_map[handler.handler_module_path].name} - {handler.handler_name} 终止了事件传播。"
+                f"{star_map[handler.handler_module_path].name} - {handler.handler_name} 终止了事件传播。",
             )
             return True
 
     return event.is_stopped()
+
+
+async def call_local_llm_tool(
+    context: ContextWrapper[AstrAgentContext],
+    handler: T.Callable[..., T.Awaitable[T.Any]],
+    method_name: str,
+    *args,
+    **kwargs,
+) -> T.AsyncGenerator[T.Any, None]:
+    """执行本地 LLM 工具的处理函数并处理其返回结果"""
+    ready_to_call = None  # 一个协程或者异步生成器
+
+    trace_ = None
+
+    event = context.context.event
+
+    try:
+        if method_name == "run" or method_name == "decorator_handler":
+            ready_to_call = handler(event, *args, **kwargs)
+        elif method_name == "call":
+            ready_to_call = handler(context, *args, **kwargs)
+        else:
+            raise ValueError(f"未知的方法名: {method_name}")
+    except ValueError as e:
+        logger.error(f"调用本地 LLM 工具时出错: {e}", exc_info=True)
+    except TypeError:
+        logger.error("处理函数参数不匹配，请检查 handler 的定义。", exc_info=True)
+    except Exception as e:
+        trace_ = traceback.format_exc()
+        logger.error(f"调用本地 LLM 工具时出错: {e}\n{trace_}")
+
+    if not ready_to_call:
+        return
+
+    if inspect.isasyncgen(ready_to_call):
+        _has_yielded = False
+        try:
+            async for ret in ready_to_call:
+                # 这里逐步执行异步生成器, 对于每个 yield 返回的 ret, 执行下面的代码
+                # 返回值只能是 MessageEventResult 或者 None（无返回值）
+                _has_yielded = True
+                if isinstance(ret, (MessageEventResult, CommandResult)):
+                    # 如果返回值是 MessageEventResult, 设置结果并继续
+                    event.set_result(ret)
+                    yield
+                else:
+                    # 如果返回值是 None, 则不设置结果并继续
+                    # 继续执行后续阶段
+                    yield ret
+            if not _has_yielded:
+                # 如果这个异步生成器没有执行到 yield 分支
+                yield
+        except Exception as e:
+            logger.error(f"Previous Error: {trace_}")
+            raise e
+    elif inspect.iscoroutine(ready_to_call):
+        # 如果只是一个协程, 直接执行
+        ret = await ready_to_call
+        if isinstance(ret, (MessageEventResult, CommandResult)):
+            event.set_result(ret)
+            yield
+        else:
+            yield ret

astrbot/core/pipeline/preprocess_stage/stage.py

@@ -1,12 +1,14 @@
-import traceback
 import asyncio
 import random
-from typing import Union, AsyncGenerator
-from ..stage import Stage, register_stage
-from ..context import PipelineContext
-from astrbot.core.platform.astr_message_event import AstrMessageEvent
+import traceback
+from collections.abc import AsyncGenerator
+
 from astrbot.core import logger
-from astrbot.core.message.components import Plain, Record, Image
+from astrbot.core.message.components import Image, Plain, Record
+from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
+from ..context import PipelineContext
+from ..stage import Stage, register_stage
 
 
 @register_stage
@@ -20,8 +22,9 @@ class PreProcessStage(Stage):
         self.platform_settings: dict = self.config.get("platform_settings", {})
 
     async def process(
-        self, event: AstrMessageEvent
-    ) -> Union[None, AsyncGenerator[None, None]]:
+        self,
+        event: AstrMessageEvent,
+    ) -> None | AsyncGenerator[None, None]:
         """在处理事件之前的预处理"""
         # 平台特异配置：platform_specific.<platform>.pre_ack_emoji
         supported = {"telegram", "lark"}
@@ -68,7 +71,7 @@ class PreProcessStage(Stage):
             stt_provider = ctx.get_using_stt_provider(event.unified_msg_origin)
             if not stt_provider:
                 logger.warning(
-                    f"会话 {event.unified_msg_origin} 未配置语音转文本模型。"
+                    f"会话 {event.unified_msg_origin} 未配置语音转文本模型。",
                 )
                 return
             message_chain = event.get_messages()