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

astrbot/cli/utils/plugin.py

@@ -1,14 +1,14 @@
 import shutil
 import tempfile
-
-import httpx
-import yaml
 from enum import Enum
 from io import BytesIO
 from pathlib import Path
 from zipfile import ZipFile
 
 import click
+import httpx
+import yaml
+
 from .version_comparator import VersionComparator
 
 
@@ -32,7 +32,8 @@ def get_git_repo(url: str, target_path: Path, proxy: str | None = None):
         release_url = f"https://api.github.com/repos/{author}/{repo}/releases"
         try:
             with httpx.Client(
-                proxy=proxy if proxy else None, follow_redirects=True
+                proxy=proxy if proxy else None,
+                follow_redirects=True,
             ) as client:
                 resp = client.get(release_url)
                 resp.raise_for_status()
@@ -55,7 +56,8 @@ def get_git_repo(url: str, target_path: Path, proxy: str | None = None):
 
         # 下载并解压
         with httpx.Client(
-            proxy=proxy if proxy else None, follow_redirects=True
+            proxy=proxy if proxy else None,
+            follow_redirects=True,
         ) as client:
             resp = client.get(download_url)
             if (
@@ -89,6 +91,7 @@ def load_yaml_metadata(plugin_dir: Path) -> dict:
 
     Returns:
         dict: 包含元数据的字典，如果读取失败则返回空字典
+
     """
     yaml_path = plugin_dir / "metadata.yaml"
     if yaml_path.exists():
@@ -107,6 +110,7 @@ def build_plug_list(plugins_dir: Path) -> list:
 
     Returns:
         list: 包含插件信息的字典列表
+
     """
     # 获取本地插件信息
     result = []
@@ -133,7 +137,7 @@ def build_plug_list(plugins_dir: Path) -> list:
                         "repo": str(metadata.get("repo", "")),
                         "status": PluginStatus.INSTALLED,
                         "local_path": str(plugin_dir),
-                    }
+                    },
                 )
 
     # 获取在线插件列表
@@ -153,7 +157,7 @@ def build_plug_list(plugins_dir: Path) -> list:
                         "repo": str(plugin_info.get("repo", "")),
                         "status": PluginStatus.NOT_INSTALLED,
                         "local_path": None,
-                    }
+                    },
                 )
     except Exception as e:
         click.echo(f"获取在线插件列表失败: {e}", err=True)
@@ -168,7 +172,8 @@ def build_plug_list(plugins_dir: Path) -> list:
             )
             if (
                 VersionComparator.compare_version(
-                    local_plugin["version"], online_plugin["version"]
+                    local_plugin["version"],
+                    online_plugin["version"],
                 )
                 < 0
             ):
@@ -186,7 +191,10 @@ def build_plug_list(plugins_dir: Path) -> list:
 
 
 def manage_plugin(
-    plugin: dict, plugins_dir: Path, is_update: bool = False, proxy: str | None = None
+    plugin: dict,
+    plugins_dir: Path,
+    is_update: bool = False,
+    proxy: str | None = None,
 ) -> None:
     """安装或更新插件
 
@@ -195,6 +203,7 @@ def manage_plugin(
         plugins_dir (Path): 插件目录
         is_update (bool, optional): 是否为更新操作. 默认为 False
         proxy (str, optional): 代理服务器地址
+
     """
     plugin_name = plugin["name"]
     repo_url = plugin["repo"]
@@ -212,26 +221,26 @@ def manage_plugin(
         raise click.ClickException(f"插件 {plugin_name} 未安装，无法更新")
 
     # 备份现有插件
-    if is_update and backup_path.exists():
+    if is_update and backup_path is not None and backup_path.exists():
         shutil.rmtree(backup_path)
-    if is_update:
+    if is_update and backup_path is not None:
         shutil.copytree(target_path, backup_path)
 
     try:
         click.echo(
-            f"正在从 {repo_url} {'更新' if is_update else '下载'}插件 {plugin_name}..."
+            f"正在从 {repo_url} {'更新' if is_update else '下载'}插件 {plugin_name}...",
         )
         get_git_repo(repo_url, target_path, proxy)
 
         # 更新成功，删除备份
-        if is_update and backup_path.exists():
+        if is_update and backup_path is not None and backup_path.exists():
             shutil.rmtree(backup_path)
         click.echo(f"插件 {plugin_name} {'更新' if is_update else '安装'}成功")
     except Exception as e:
         if target_path.exists():
             shutil.rmtree(target_path, ignore_errors=True)
-        if is_update and backup_path.exists():
+        if is_update and backup_path is not None and backup_path.exists():
             shutil.move(backup_path, target_path)
         raise click.ClickException(
-            f"{'更新' if is_update else '安装'}插件 {plugin_name} 时出错: {e}"
+            f"{'更新' if is_update else '安装'}插件 {plugin_name} 时出错: {e}",
         )

astrbot/cli/utils/version_comparator.py

@@ -1,6 +1,4 @@
-"""
-拷贝自 astrbot.core.utils.version_comparator
-"""
+"""拷贝自 astrbot.core.utils.version_comparator"""
 
 import re
 
@@ -42,15 +40,15 @@ class VersionComparator:
         for i in range(length):
             if v1_parts[i] > v2_parts[i]:
                 return 1
-            elif v1_parts[i] < v2_parts[i]:
+            if v1_parts[i] < v2_parts[i]:
                 return -1
 
         # 比较预发布标签
         if v1_prerelease is None and v2_prerelease is not None:
             return 1  # 没有预发布标签的版本高于有预发布标签的版本
-        elif v1_prerelease is not None and v2_prerelease is None:
+        if v1_prerelease is not None and v2_prerelease is None:
             return -1  # 有预发布标签的版本低于没有预发布标签的版本
-        elif v1_prerelease is not None and v2_prerelease is not None:
+        if v1_prerelease is not None and v2_prerelease is not None:
             len_pre = max(len(v1_prerelease), len(v2_prerelease))
             for i in range(len_pre):
                 p1 = v1_prerelease[i] if i < len(v1_prerelease) else None
@@ -58,21 +56,21 @@ class VersionComparator:
 
                 if p1 is None and p2 is not None:
                     return -1
-                elif p1 is not None and p2 is None:
+                if p1 is not None and p2 is None:
                     return 1
-                elif isinstance(p1, int) and isinstance(p2, str):
+                if isinstance(p1, int) and isinstance(p2, str):
                     return -1
-                elif isinstance(p1, str) and isinstance(p2, int):
+                if isinstance(p1, str) and isinstance(p2, int):
                     return 1
-                elif isinstance(p1, int) and isinstance(p2, int):
+                if isinstance(p1, int) and isinstance(p2, int):
                     if p1 > p2:
                         return 1
-                    elif p1 < p2:
+                    if p1 < p2:
                         return -1
                 elif isinstance(p1, str) and isinstance(p2, str):
                     if p1 > p2:
                         return 1
-                    elif p1 < p2:
+                    if p1 < p2:
                         return -1
             return 0  # 预发布标签完全相同
 

astrbot/core/__init__.py

@@ -1,12 +1,14 @@
 import os
-from .log import LogManager, LogBroker  # noqa
-from astrbot.core.utils.t2i.renderer import HtmlRenderer
-from astrbot.core.utils.shared_preferences import SharedPreferences
-from astrbot.core.utils.pip_installer import PipInstaller
-from astrbot.core.db.sqlite import SQLiteDatabase
-from astrbot.core.config.default import DB_PATH
+
 from astrbot.core.config import AstrBotConfig
+from astrbot.core.config.default import DB_PATH
+from astrbot.core.db.sqlite import SQLiteDatabase
 from astrbot.core.file_token_service import FileTokenService
+from astrbot.core.utils.pip_installer import PipInstaller
+from astrbot.core.utils.shared_preferences import SharedPreferences
+from astrbot.core.utils.t2i.renderer import HtmlRenderer
+
+from .log import LogBroker, LogManager  # noqa
 from .utils.astrbot_path import get_astrbot_data_path
 
 # 初始化数据存储文件夹

astrbot/core/agent/agent.py

@@ -1,8 +1,9 @@
 from dataclasses import dataclass
-from .tool import FunctionTool
 from typing import Generic
-from .run_context import TContext
+
 from .hooks import BaseAgentRunHooks
+from .run_context import TContext
+from .tool import FunctionTool
 
 
 @dataclass

astrbot/core/agent/handoff.py

@@ -1,14 +1,18 @@
 from typing import Generic
-from .tool import FunctionTool
+
 from .agent import Agent
 from .run_context import TContext
+from .tool import FunctionTool
 
 
 class HandoffTool(FunctionTool, Generic[TContext]):
     """Handoff tool for delegating tasks to another agent."""
 
     def __init__(
-        self, agent: Agent[TContext], parameters: dict | None = None, **kwargs
+        self,
+        agent: Agent[TContext],
+        parameters: dict | None = None,
+        **kwargs,
     ):
         self.agent = agent
         super().__init__(

astrbot/core/agent/hooks.py

@@ -1,12 +1,13 @@
-import mcp
-from dataclasses import dataclass
-from .run_context import ContextWrapper, TContext
 from typing import Generic
-from astrbot.core.provider.entities import LLMResponse
+
+import mcp
+
 from astrbot.core.agent.tool import FunctionTool
+from astrbot.core.provider.entities import LLMResponse
+
+from .run_context import ContextWrapper, TContext
 
 
-@dataclass
 class BaseAgentRunHooks(Generic[TContext]):
     async def on_agent_begin(self, run_context: ContextWrapper[TContext]): ...
     async def on_tool_start(
@@ -23,5 +24,7 @@ class BaseAgentRunHooks(Generic[TContext]):
         tool_result: mcp.types.CallToolResult | None,
     ): ...
     async def on_agent_done(
-        self, run_context: ContextWrapper[TContext], llm_response: LLMResponse
+        self,
+        run_context: ContextWrapper[TContext],
+        llm_response: LLMResponse,
     ): ...

astrbot/core/agent/mcp_client.py

@@ -1,11 +1,16 @@
 import asyncio
 import logging
-from datetime import timedelta
-from typing import Optional
 from contextlib import AsyncExitStack
+from datetime import timedelta
+from typing import Generic
+
 from astrbot import logger
+from astrbot.core.agent.run_context import ContextWrapper
 from astrbot.core.utils.log_pipe import LogPipe
 
+from .run_context import TContext
+from .tool import FunctionTool
+
 try:
     import mcp
     from mcp.client.sse import sse_client
@@ -16,13 +21,13 @@ try:
     from mcp.client.streamable_http import streamablehttp_client
 except (ModuleNotFoundError, ImportError):
     logger.warning(
-        "警告: 缺少依赖库 'mcp' 或者 mcp 库版本过低，无法使用 Streamable HTTP 连接方式。"
+        "警告: 缺少依赖库 'mcp' 或者 mcp 库版本过低，无法使用 Streamable HTTP 连接方式。",
     )
 
 
 def _prepare_config(config: dict) -> dict:
     """准备配置，处理嵌套格式"""
-    if "mcpServers" in config and config["mcpServers"]:
+    if config.get("mcpServers"):
         first_key = next(iter(config["mcpServers"]))
         config = config["mcpServers"][first_key]
     config.pop("active", None)
@@ -71,8 +76,7 @@ async def _quick_test_mcp_connection(config: dict) -> tuple[bool, str]:
                 ) as response:
                     if response.status == 200:
                         return True, ""
-                    else:
-                        return False, f"HTTP {response.status}: {response.reason}"
+                    return False, f"HTTP {response.status}: {response.reason}"
             else:
                 async with session.get(
                     url,
@@ -84,8 +88,7 @@ async def _quick_test_mcp_connection(config: dict) -> tuple[bool, str]:
                 ) as response:
                     if response.status == 200:
                         return True, ""
-                    else:
-                        return False, f"HTTP {response.status}: {response.reason}"
+                    return False, f"HTTP {response.status}: {response.reason}"
 
     except asyncio.TimeoutError:
         return False, f"连接超时: {timeout}秒"
@@ -96,7 +99,7 @@ async def _quick_test_mcp_connection(config: dict) -> tuple[bool, str]:
 class MCPClient:
     def __init__(self):
         # Initialize session and client objects
-        self.session: Optional[mcp.ClientSession] = None
+        self.session: mcp.ClientSession | None = None
         self.exit_stack = AsyncExitStack()
 
         self.name: str | None = None
@@ -115,6 +118,7 @@ class MCPClient:
 
         Args:
             mcp_server_config (dict): Configuration for the MCP server. See https://modelcontextprotocol.io/quickstart/server
+
         """
         cfg = _prepare_config(mcp_server_config.copy())
 
@@ -144,7 +148,7 @@ class MCPClient:
                     sse_read_timeout=cfg.get("sse_read_timeout", 60 * 5),
                 )
                 streams = await self.exit_stack.enter_async_context(
-                    self._streams_context
+                    self._streams_context,
                 )
 
                 # Create a new client session
@@ -154,12 +158,12 @@ class MCPClient:
                         *streams,
                         read_timeout_seconds=read_timeout,
                         logging_callback=logging_callback,  # type: ignore
-                    )
+                    ),
                 )
             else:
                 timeout = timedelta(seconds=cfg.get("timeout", 30))
                 sse_read_timeout = timedelta(
-                    seconds=cfg.get("sse_read_timeout", 60 * 5)
+                    seconds=cfg.get("sse_read_timeout", 60 * 5),
                 )
                 self._streams_context = streamablehttp_client(
                     url=cfg["url"],
@@ -169,7 +173,7 @@ class MCPClient:
                     terminate_on_close=cfg.get("terminate_on_close", True),
                 )
                 read_s, write_s, _ = await self.exit_stack.enter_async_context(
-                    self._streams_context
+                    self._streams_context,
                 )
 
                 # Create a new client session
@@ -180,7 +184,7 @@ class MCPClient:
                         write_stream=write_s,
                         read_timeout_seconds=read_timeout,
                         logging_callback=logging_callback,  # type: ignore
-                    )
+                    ),
                 )
 
         else:
@@ -206,7 +210,7 @@ class MCPClient:
 
             # Create a new client session
             self.session = await self.exit_stack.enter_async_context(
-                mcp.ClientSession(*stdio_transport)
+                mcp.ClientSession(*stdio_transport),
             )
         await self.session.initialize()
 
@@ -222,3 +226,34 @@ class MCPClient:
         """Clean up resources"""
         await self.exit_stack.aclose()
         self.running_event.set()  # Set the running event to indicate cleanup is done
+
+
+class MCPTool(FunctionTool, Generic[TContext]):
+    """A function tool that calls an MCP service."""
+
+    def __init__(
+        self, mcp_tool: mcp.Tool, mcp_client: MCPClient, mcp_server_name: str, **kwargs
+    ):
+        super().__init__(
+            name=mcp_tool.name,
+            description=mcp_tool.description or "",
+            parameters=mcp_tool.inputSchema,
+        )
+        self.mcp_tool = mcp_tool
+        self.mcp_client = mcp_client
+        self.mcp_server_name = mcp_server_name
+
+    async def call(
+        self, context: ContextWrapper[TContext], **kwargs
+    ) -> mcp.types.CallToolResult:
+        session = self.mcp_client.session
+        if not session:
+            raise ValueError("MCP session is not available for MCP function tools.")
+        res = await session.call_tool(
+            name=self.mcp_tool.name,
+            arguments=kwargs,
+            read_timeout_seconds=timedelta(
+                seconds=context.tool_call_timeout,
+            ),
+        )
+        return res

astrbot/core/agent/message.py

@@ -0,0 +1,168 @@
+# Inspired by MoonshotAI/kosong, credits to MoonshotAI/kosong authors for the original implementation.
+# License: Apache License 2.0
+
+from typing import Any, ClassVar, Literal, cast
+
+from pydantic import BaseModel, GetCoreSchemaHandler
+from pydantic_core import core_schema
+
+
+class ContentPart(BaseModel):
+    """A part of the content in a message."""
+
+    __content_part_registry: ClassVar[dict[str, type["ContentPart"]]] = {}
+
+    type: str
+
+    def __init_subclass__(cls, **kwargs: Any) -> None:
+        super().__init_subclass__(**kwargs)
+
+        invalid_subclass_error_msg = f"ContentPart subclass {cls.__name__} must have a `type` field of type `str`"
+
+        type_value = getattr(cls, "type", None)
+        if type_value is None or not isinstance(type_value, str):
+            raise ValueError(invalid_subclass_error_msg)
+
+        cls.__content_part_registry[type_value] = cls
+
+    @classmethod
+    def __get_pydantic_core_schema__(
+        cls, source_type: Any, handler: GetCoreSchemaHandler
+    ) -> core_schema.CoreSchema:
+        # If we're dealing with the base ContentPart class, use custom validation
+        if cls.__name__ == "ContentPart":
+
+            def validate_content_part(value: Any) -> Any:
+                # if it's already an instance of a ContentPart subclass, return it
+                if hasattr(value, "__class__") and issubclass(value.__class__, cls):
+                    return value
+
+                # if it's a dict with a type field, dispatch to the appropriate subclass
+                if isinstance(value, dict) and "type" in value:
+                    type_value: Any | None = cast(dict[str, Any], value).get("type")
+                    if not isinstance(type_value, str):
+                        raise ValueError(f"Cannot validate {value} as ContentPart")
+                    target_class = cls.__content_part_registry[type_value]
+                    return target_class.model_validate(value)
+
+                raise ValueError(f"Cannot validate {value} as ContentPart")
+
+            return core_schema.no_info_plain_validator_function(validate_content_part)
+
+        # for subclasses, use the default schema
+        return handler(source_type)
+
+
+class TextPart(ContentPart):
+    """
+    >>> TextPart(text="Hello, world!").model_dump()
+    {'type': 'text', 'text': 'Hello, world!'}
+    """
+
+    type: str = "text"
+    text: str
+
+
+class ImageURLPart(ContentPart):
+    """
+    >>> ImageURLPart(image_url="http://example.com/image.jpg").model_dump()
+    {'type': 'image_url', 'image_url': 'http://example.com/image.jpg'}
+    """
+
+    class ImageURL(BaseModel):
+        url: str
+        """The URL of the image, can be data URI scheme like `data:image/png;base64,...`."""
+        id: str | None = None
+        """The ID of the image, to allow LLMs to distinguish different images."""
+
+    type: str = "image_url"
+    image_url: str
+
+
+class AudioURLPart(ContentPart):
+    """
+    >>> AudioURLPart(audio_url=AudioURLPart.AudioURL(url="https://example.com/audio.mp3")).model_dump()
+    {'type': 'audio_url', 'audio_url': {'url': 'https://example.com/audio.mp3', 'id': None}}
+    """
+
+    class AudioURL(BaseModel):
+        url: str
+        """The URL of the audio, can be data URI scheme like `data:audio/aac;base64,...`."""
+        id: str | None = None
+        """The ID of the audio, to allow LLMs to distinguish different audios."""
+
+    type: str = "audio_url"
+    audio_url: AudioURL
+
+
+class ToolCall(BaseModel):
+    """
+    A tool call requested by the assistant.
+
+    >>> ToolCall(
+    ...     id="123",
+    ...     function=ToolCall.FunctionBody(
+    ...         name="function",
+    ...         arguments="{}"
+    ...     ),
+    ... ).model_dump()
+    {'type': 'function', 'id': '123', 'function': {'name': 'function', 'arguments': '{}'}}
+    """
+
+    class FunctionBody(BaseModel):
+        name: str
+        arguments: str | None
+
+    type: Literal["function"] = "function"
+
+    id: str
+    """The ID of the tool call."""
+    function: FunctionBody
+    """The function body of the tool call."""
+
+
+class ToolCallPart(BaseModel):
+    """A part of the tool call."""
+
+    arguments_part: str | None = None
+    """A part of the arguments of the tool call."""
+
+
+class Message(BaseModel):
+    """A message in a conversation."""
+
+    role: Literal[
+        "system",
+        "user",
+        "assistant",
+        "tool",
+    ]
+
+    content: str | list[ContentPart]
+    """The content of the message."""
+
+
+class AssistantMessageSegment(Message):
+    """A message segment from the assistant."""
+
+    role: Literal["assistant"] = "assistant"
+    tool_calls: list[ToolCall] | list[dict] | None = None
+
+
+class ToolCallMessageSegment(Message):
+    """A message segment representing a tool call."""
+
+    role: Literal["tool"] = "tool"
+    tool_call_id: str
+
+
+class UserMessageSegment(Message):
+    """A message segment from the user."""
+
+    role: Literal["user"] = "user"
+
+
+class SystemMessageSegment(Message):
+    """A message segment from the system."""
+
+    role: Literal["system"] = "system"

astrbot/core/agent/response.py

@@ -1,5 +1,6 @@
-from dataclasses import dataclass
 import typing as T
+from dataclasses import dataclass
+
 from astrbot.core.message.message_event_result import MessageChain
 
 

astrbot/core/agent/run_context.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass
 from typing import Any, Generic
-from typing_extensions import TypeVar
 
-from astrbot.core.platform.astr_message_event import AstrMessageEvent
+from typing_extensions import TypeVar
 
 TContext = TypeVar("TContext", default=Any)
 
@@ -12,7 +11,7 @@ class ContextWrapper(Generic[TContext]):
     """A context for running an agent, which can be used to pass additional data or state."""
 
     context: TContext
-    event: AstrMessageEvent
+    tool_call_timeout: int = 60  # Default tool call timeout in seconds
 
 
 NoContext = ContextWrapper[None]

astrbot/core/agent/runners/base.py

@@ -1,13 +1,15 @@
 import abc
 import typing as T
 from enum import Enum, auto
-from ..run_context import ContextWrapper, TContext
-from ..response import AgentResponse
-from ..hooks import BaseAgentRunHooks
-from ..tool_executor import BaseFunctionToolExecutor
+
 from astrbot.core.provider import Provider
 from astrbot.core.provider.entities import LLMResponse
 
+from ..hooks import BaseAgentRunHooks
+from ..response import AgentResponse
+from ..run_context import ContextWrapper, TContext
+from ..tool_executor import BaseFunctionToolExecutor
+
 
 class AgentState(Enum):
     """Defines the state of the agent."""
@@ -28,31 +30,26 @@ class BaseAgentRunner(T.Generic[TContext]):
         agent_hooks: BaseAgentRunHooks[TContext],
         **kwargs: T.Any,
     ) -> None:
-        """
-        Reset the agent to its initial state.
+        """Reset the agent to its initial state.
         This method should be called before starting a new run.
         """
         ...
 
     @abc.abstractmethod
     async def step(self) -> T.AsyncGenerator[AgentResponse, None]:
-        """
-        Process a single step of the agent.
-        """
+        """Process a single step of the agent."""
         ...
 
     @abc.abstractmethod
     def done(self) -> bool:
-        """
-        Check if the agent has completed its task.
+        """Check if the agent has completed its task.
         Returns True if the agent is done, False otherwise.
         """
         ...
 
     @abc.abstractmethod
     def get_final_llm_resp(self) -> LLMResponse | None:
-        """
-        Get the final observation from the agent.
+        """Get the final observation from the agent.
         This method should be called after the agent is done.
         """
         ...