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

astrbot/core/star/filter/command_group.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
-from typing import List, Union
+from astrbot.core.config import AstrBotConfig
+from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
 from . import HandlerFilter
 from .command import CommandFilter
-from astrbot.core.platform.astr_message_event import AstrMessageEvent
-from astrbot.core.config import AstrBotConfig
 from .custom_filter import CustomFilter
 
 
@@ -18,25 +18,27 @@ class CommandGroupFilter(HandlerFilter):
     ):
         self.group_name = group_name
         self.alias = alias if alias else set()
-        self.sub_command_filters: List[Union[CommandFilter, CommandGroupFilter]] = []
-        self.custom_filter_list: List[CustomFilter] = []
+        self.sub_command_filters: list[CommandFilter | CommandGroupFilter] = []
+        self.custom_filter_list: list[CustomFilter] = []
         self.parent_group = parent_group
 
         # Cache for complete command names list
         self._cmpl_cmd_names: list | None = None
 
     def add_sub_command_filter(
-        self, sub_command_filter: Union[CommandFilter, CommandGroupFilter]
+        self,
+        sub_command_filter: CommandFilter | CommandGroupFilter,
     ):
         self.sub_command_filters.append(sub_command_filter)
 
     def add_custom_filter(self, custom_filter: CustomFilter):
         self.custom_filter_list.append(custom_filter)
 
-    def get_complete_command_names(self) -> List[str]:
+    def get_complete_command_names(self) -> list[str]:
         """遍历父节点获取完整的指令名。
 
-        新版本 v3.4.29 采用预编译指令，不再从指令组递归遍历子指令，因此这个方法是返回包括别名在内的整个指令名列表。"""
+        新版本 v3.4.29 采用预编译指令，不再从指令组递归遍历子指令，因此这个方法是返回包括别名在内的整个指令名列表。
+        """
         if self._cmpl_cmd_names is not None:
             return self._cmpl_cmd_names
 
@@ -59,12 +61,12 @@ class CommandGroupFilter(HandlerFilter):
     # 以树的形式打印出来
     def print_cmd_tree(
         self,
-        sub_command_filters: List[Union[CommandFilter, CommandGroupFilter]],
+        sub_command_filters: list[CommandFilter | CommandGroupFilter],
         prefix: str = "",
         event: AstrMessageEvent | None = None,
         cfg: AstrBotConfig | None = None,
     ) -> str:
-        result = ""
+        parts = []
         for sub_filter in sub_command_filters:
             if isinstance(sub_filter, CommandFilter):
                 custom_filter_pass = True
@@ -72,31 +74,32 @@ class CommandGroupFilter(HandlerFilter):
                     custom_filter_pass = sub_filter.custom_filter_ok(event, cfg)
                 if custom_filter_pass:
                     cmd_th = sub_filter.print_types()
-                    result += f"{prefix}├── {sub_filter.command_name}"
+                    line = f"{prefix}├── {sub_filter.command_name}"
                     if cmd_th:
-                        result += f" ({cmd_th})"
+                        line += f" ({cmd_th})"
                     else:
-                        result += " (无参数指令)"
+                        line += " (无参数指令)"
 
                     if sub_filter.handler_md and sub_filter.handler_md.desc:
-                        result += f": {sub_filter.handler_md.desc}"
+                        line += f": {sub_filter.handler_md.desc}"
 
-                    result += "\n"
+                    parts.append(line + "\n")
             elif isinstance(sub_filter, CommandGroupFilter):
                 custom_filter_pass = True
                 if event and cfg:
                     custom_filter_pass = sub_filter.custom_filter_ok(event, cfg)
                 if custom_filter_pass:
-                    result += f"{prefix}├── {sub_filter.group_name}"
-                    result += "\n"
-                    result += sub_filter.print_cmd_tree(
-                        sub_filter.sub_command_filters,
-                        prefix + "│   ",
-                        event=event,
-                        cfg=cfg,
+                    parts.append(f"{prefix}├── {sub_filter.group_name}\n")
+                    parts.append(
+                        sub_filter.print_cmd_tree(
+                            sub_filter.sub_command_filters,
+                            prefix + "│   ",
+                            event=event,
+                            cfg=cfg,
+                        )
                     )
 
-        return result
+        return "".join(parts)
 
     def custom_filter_ok(self, event: AstrMessageEvent, cfg: AstrBotConfig) -> bool:
         for custom_filter in self.custom_filter_list:
@@ -125,7 +128,7 @@ class CommandGroupFilter(HandlerFilter):
                 + self.print_cmd_tree(self.sub_command_filters, event=event, cfg=cfg)
             )
             raise ValueError(
-                f"参数不足。{self.group_name} 指令组下有如下指令，请参考：\n" + tree
+                f"参数不足。{self.group_name} 指令组下有如下指令，请参考：\n" + tree,
             )
 
         return self.startswith(event.message_str)

astrbot/core/star/filter/custom_filter.py

@@ -1,8 +1,9 @@
-from abc import abstractmethod, ABCMeta
+from abc import ABCMeta, abstractmethod
 
-from . import HandlerFilter
-from astrbot.core.platform.astr_message_event import AstrMessageEvent
 from astrbot.core.config import AstrBotConfig
+from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
+from . import HandlerFilter
 
 
 class CustomFilterMeta(ABCMeta):
@@ -38,7 +39,7 @@ class CustomFilterOr(CustomFilter):
         super().__init__()
         if not isinstance(filter1, (CustomFilter, CustomFilterAnd, CustomFilterOr)):
             raise ValueError(
-                "CustomFilter lass can only operate with other CustomFilter."
+                "CustomFilter lass can only operate with other CustomFilter.",
             )
         self.filter1 = filter1
         self.filter2 = filter2
@@ -52,7 +53,7 @@ class CustomFilterAnd(CustomFilter):
         super().__init__()
         if not isinstance(filter1, (CustomFilter, CustomFilterAnd, CustomFilterOr)):
             raise ValueError(
-                "CustomFilter lass can only operate with other CustomFilter."
+                "CustomFilter lass can only operate with other CustomFilter.",
             )
         self.filter1 = filter1
         self.filter2 = filter2

astrbot/core/star/filter/event_message_type.py

@@ -1,9 +1,11 @@
 import enum
-from . import HandlerFilter
-from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
 from astrbot.core.config import AstrBotConfig
+from astrbot.core.platform.astr_message_event import AstrMessageEvent
 from astrbot.core.platform.message_type import MessageType
 
+from . import HandlerFilter
+
 
 class EventMessageType(enum.Flag):
     GROUP_MESSAGE = enum.auto()

astrbot/core/star/filter/permission.py

@@ -1,7 +1,9 @@
 import enum
-from . import HandlerFilter
-from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
 from astrbot.core.config import AstrBotConfig
+from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
+from . import HandlerFilter
 
 
 class PermissionType(enum.Flag):

astrbot/core/star/filter/platform_adapter_type.py

@@ -1,7 +1,9 @@
 import enum
-from . import HandlerFilter
-from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
 from astrbot.core.config import AstrBotConfig
+from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
+from . import HandlerFilter
 
 
 class PlatformAdapterType(enum.Flag):

astrbot/core/star/filter/regex.py

@@ -1,7 +1,9 @@
 import re
-from . import HandlerFilter
-from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
 from astrbot.core.config import AstrBotConfig
+from astrbot.core.platform.astr_message_event import AstrMessageEvent
+
+from . import HandlerFilter
 
 
 # 正则表达式过滤器不会受到 wake_prefix 的制约。

astrbot/core/star/register/__init__.py

@@ -1,37 +1,37 @@
 from .star import register_star
 from .star_handler import (
+    register_after_message_sent,
+    register_agent,
     register_command,
     register_command_group,
-    register_event_message_type,
-    register_platform_adapter_type,
-    register_regex,
-    register_permission_type,
     register_custom_filter,
+    register_event_message_type,
+    register_llm_tool,
     register_on_astrbot_loaded,
-    register_on_platform_loaded,
+    register_on_decorating_result,
     register_on_llm_request,
     register_on_llm_response,
-    register_llm_tool,
-    register_agent,
-    register_on_decorating_result,
-    register_after_message_sent,
+    register_on_platform_loaded,
+    register_permission_type,
+    register_platform_adapter_type,
+    register_regex,
 )
 
 __all__ = [
-    "register_star",
+    "register_after_message_sent",
+    "register_agent",
     "register_command",
     "register_command_group",
-    "register_event_message_type",
-    "register_platform_adapter_type",
-    "register_regex",
-    "register_permission_type",
     "register_custom_filter",
+    "register_event_message_type",
+    "register_llm_tool",
     "register_on_astrbot_loaded",
-    "register_on_platform_loaded",
+    "register_on_decorating_result",
     "register_on_llm_request",
     "register_on_llm_response",
-    "register_llm_tool",
-    "register_agent",
-    "register_on_decorating_result",
-    "register_after_message_sent",
+    "register_on_platform_loaded",
+    "register_permission_type",
+    "register_platform_adapter_type",
+    "register_regex",
+    "register_star",
 ]

astrbot/core/star/register/star.py

@@ -6,7 +6,11 @@ _warned_register_star = False
 
 
 def register_star(
-    name: str, author: str, desc: str, version: str, repo: str | None = None
+    name: str,
+    author: str,
+    desc: str,
+    version: str,
+    repo: str | None = None,
 ):
     """注册一个插件(Star)。
 
@@ -29,8 +33,8 @@ def register_star(
         ...
 
     帮助信息会被自动提取。使用 `/plugin <插件名> 可以查看帮助信息。`
-    """
 
+    """
     global _warned_register_star
     if not _warned_register_star:
         _warned_register_star = True

astrbot/core/star/register/star_handler.py

@@ -1,26 +1,30 @@
 from __future__ import annotations
+
+from collections.abc import Awaitable, Callable
+from typing import Any
+
 import docstring_parser
 
-from ..star_handler import star_handlers_registry, StarHandlerMetadata, EventType
+from astrbot.core import logger
+from astrbot.core.agent.agent import Agent
+from astrbot.core.agent.handoff import HandoffTool
+from astrbot.core.agent.hooks import BaseAgentRunHooks
+from astrbot.core.agent.tool import FunctionTool
+from astrbot.core.astr_agent_context import AstrAgentContext
+from astrbot.core.provider.func_tool_manager import SUPPORTED_TYPES
+from astrbot.core.provider.register import llm_tools
+
 from ..filter.command import CommandFilter
 from ..filter.command_group import CommandGroupFilter
-from ..filter.event_message_type import EventMessageTypeFilter, EventMessageType
+from ..filter.custom_filter import CustomFilterAnd, CustomFilterOr
+from ..filter.event_message_type import EventMessageType, EventMessageTypeFilter
+from ..filter.permission import PermissionType, PermissionTypeFilter
 from ..filter.platform_adapter_type import (
-    PlatformAdapterTypeFilter,
     PlatformAdapterType,
+    PlatformAdapterTypeFilter,
 )
-from ..filter.permission import PermissionTypeFilter, PermissionType
-from ..filter.custom_filter import CustomFilterAnd, CustomFilterOr
 from ..filter.regex import RegexFilter
-from typing import Awaitable, Any, Callable
-from astrbot.core.provider.func_tool_manager import SUPPORTED_TYPES
-from astrbot.core.provider.register import llm_tools
-from astrbot.core.agent.agent import Agent
-from astrbot.core.agent.tool import FunctionTool
-from astrbot.core.agent.handoff import HandoffTool
-from astrbot.core.agent.hooks import BaseAgentRunHooks
-from astrbot.core.astr_agent_context import AstrAgentContext
-from astrbot.core import logger
+from ..star_handler import EventType, StarHandlerMetadata, star_handlers_registry
 
 
 def get_handler_full_name(awaitable: Callable[..., Awaitable[Any]]) -> str:
@@ -39,27 +43,26 @@ def get_handler_or_create(
     md = star_handlers_registry.get_handler_by_full_name(handler_full_name)
     if md:
         return md
-    else:
-        md = StarHandlerMetadata(
-            event_type=event_type,
-            handler_full_name=handler_full_name,
-            handler_name=handler.__name__,
-            handler_module_path=handler.__module__,
-            handler=handler,
-            event_filters=[],
-        )
+    md = StarHandlerMetadata(
+        event_type=event_type,
+        handler_full_name=handler_full_name,
+        handler_name=handler.__name__,
+        handler_module_path=handler.__module__,
+        handler=handler,
+        event_filters=[],
+    )
 
-        # 插件handler的附加额外信息
-        if handler.__doc__:
-            md.desc = handler.__doc__.strip()
-        if "desc" in kwargs:
-            md.desc = kwargs["desc"]
-            del kwargs["desc"]
-        md.extras_configs = kwargs
+    # 插件handler的附加额外信息
+    if handler.__doc__:
+        md.desc = handler.__doc__.strip()
+    if "desc" in kwargs:
+        md.desc = kwargs["desc"]
+        del kwargs["desc"]
+    md.extras_configs = kwargs
 
-        if not dont_add:
-            star_handlers_registry.append(md)
-        return md
+    if not dont_add:
+        star_handlers_registry.append(md)
+    return md
 
 
 def register_command(
@@ -78,20 +81,22 @@ def register_command(
                 command_name.parent_group.get_complete_command_names()
             )
             new_command = CommandFilter(
-                sub_command, alias, None, parent_command_names=parent_command_names
+                sub_command,
+                alias,
+                None,
+                parent_command_names=parent_command_names,
             )
             command_name.parent_group.add_sub_command_filter(new_command)
         else:
             logger.warning(
-                f"注册指令{command_name} 的子指令时未提供 sub_command 参数。"
+                f"注册指令{command_name} 的子指令时未提供 sub_command 参数。",
             )
+    # 裸指令
+    elif command_name is None:
+        logger.warning("注册裸指令时未提供 command_name 参数。")
     else:
-        # 裸指令
-        if command_name is None:
-            logger.warning("注册裸指令时未提供 command_name 参数。")
-        else:
-            new_command = CommandFilter(command_name, alias, None)
-            add_to_event_filters = True
+        new_command = CommandFilter(command_name, alias, None)
+        add_to_event_filters = True
 
     def decorator(awaitable):
         if not add_to_event_filters:
@@ -99,7 +104,9 @@ def register_command(
                 True  # 打一个标记，表示这是一个子指令，再 wakingstage 阶段这个 handler 将会直接被跳过（其父指令会接管）
             )
         handler_md = get_handler_or_create(
-            awaitable, EventType.AdapterMessageEvent, **kwargs
+            awaitable,
+            EventType.AdapterMessageEvent,
+            **kwargs,
         )
         if new_command:
             new_command.init_handler_md(handler_md)
@@ -116,6 +123,7 @@ def register_custom_filter(custom_type_filter, *args, **kwargs):
         custom_type_filter: 在裸指令时为CustomFilter对象
                                         在指令组时为父指令的RegisteringCommandable对象，即self或者command_group的返回
         raise_error: 如果没有权限，是否抛出错误到消息平台，并且停止事件传播。默认为 True
+
     """
     add_to_event_filters = False
     raise_error = True
@@ -140,19 +148,20 @@ def register_custom_filter(custom_type_filter, *args, **kwargs):
     def decorator(awaitable):
         # 裸指令，子指令与指令组的区分，指令组会因为标记跳过wake。
         if (
-            not add_to_event_filters
-            and isinstance(awaitable, RegisteringCommandable)
-            or (add_to_event_filters and isinstance(awaitable, RegisteringCommandable))
-        ):
+            not add_to_event_filters and isinstance(awaitable, RegisteringCommandable)
+        ) or (add_to_event_filters and isinstance(awaitable, RegisteringCommandable)):
             # 指令组 与 根指令组，添加到本层的grouphandle中一起判断
             awaitable.parent_group.add_custom_filter(custom_filter)
         else:
             handler_md = get_handler_or_create(
-                awaitable, EventType.AdapterMessageEvent, **kwargs
+                awaitable,
+                EventType.AdapterMessageEvent,
+                **kwargs,
             )
 
             if not add_to_event_filters and not isinstance(
-                awaitable, RegisteringCommandable
+                awaitable,
+                RegisteringCommandable,
             ):
                 # 底层子指令
                 handle_full_name = get_handler_full_name(awaitable)
@@ -171,7 +180,9 @@ def register_custom_filter(custom_type_filter, *args, **kwargs):
             else:
                 # 裸指令
                 handler_md = get_handler_or_create(
-                    awaitable, EventType.AdapterMessageEvent, **kwargs
+                    awaitable,
+                    EventType.AdapterMessageEvent,
+                    **kwargs,
                 )
                 handler_md.event_filters.append(custom_filter)
 
@@ -194,20 +205,23 @@ def register_command_group(
             logger.warning(f"{command_group_name} 指令组的子指令组 sub_command 未指定")
         else:
             new_group = CommandGroupFilter(
-                sub_command, alias, parent_group=command_group_name.parent_group
+                sub_command,
+                alias,
+                parent_group=command_group_name.parent_group,
             )
             command_group_name.parent_group.add_sub_command_filter(new_group)
+    # 根指令组
+    elif command_group_name is None:
+        logger.warning("根指令组的名称未指定")
     else:
-        # 根指令组
-        if command_group_name is None:
-            logger.warning("根指令组的名称未指定")
-        else:
-            new_group = CommandGroupFilter(command_group_name, alias)
+        new_group = CommandGroupFilter(command_group_name, alias)
 
     def decorator(obj):
         if new_group:
             handler_md = get_handler_or_create(
-                obj, EventType.AdapterMessageEvent, **kwargs
+                obj,
+                EventType.AdapterMessageEvent,
+                **kwargs,
             )
             handler_md.event_filters.append(new_group)
 
@@ -220,9 +234,7 @@ def register_command_group(
 class RegisteringCommandable:
     """用于指令组级联注册"""
 
-    group: Callable[..., Callable[..., "RegisteringCommandable"]] = (
-        register_command_group
-    )
+    group: Callable[..., Callable[..., RegisteringCommandable]] = register_command_group
     command: Callable[..., Callable[..., None]] = register_command
     custom_filter: Callable[..., Callable[..., None]] = register_custom_filter
 
@@ -235,7 +247,9 @@ def register_event_message_type(event_message_type: EventMessageType, **kwargs):
 
     def decorator(awaitable):
         handler_md = get_handler_or_create(
-            awaitable, EventType.AdapterMessageEvent, **kwargs
+            awaitable,
+            EventType.AdapterMessageEvent,
+            **kwargs,
         )
         handler_md.event_filters.append(EventMessageTypeFilter(event_message_type))
         return awaitable
@@ -244,14 +258,15 @@ def register_event_message_type(event_message_type: EventMessageType, **kwargs):
 
 
 def register_platform_adapter_type(
-    platform_adapter_type: PlatformAdapterType, **kwargs
+    platform_adapter_type: PlatformAdapterType,
+    **kwargs,
 ):
     """注册一个 PlatformAdapterType"""
 
     def decorator(awaitable):
         handler_md = get_handler_or_create(awaitable, EventType.AdapterMessageEvent)
         handler_md.event_filters.append(
-            PlatformAdapterTypeFilter(platform_adapter_type)
+            PlatformAdapterTypeFilter(platform_adapter_type),
         )
         return awaitable
 
@@ -263,7 +278,9 @@ def register_regex(regex: str, **kwargs):
 
     def decorator(awaitable):
         handler_md = get_handler_or_create(
-            awaitable, EventType.AdapterMessageEvent, **kwargs
+            awaitable,
+            EventType.AdapterMessageEvent,
+            **kwargs,
         )
         handler_md.event_filters.append(RegexFilter(regex))
         return awaitable
@@ -277,12 +294,13 @@ def register_permission_type(permission_type: PermissionType, raise_error: bool
     Args:
         permission_type: PermissionType
         raise_error: 如果没有权限，是否抛出错误到消息平台，并且停止事件传播。默认为 True
+
     """
 
     def decorator(awaitable):
         handler_md = get_handler_or_create(awaitable, EventType.AdapterMessageEvent)
         handler_md.event_filters.append(
-            PermissionTypeFilter(permission_type, raise_error)
+            PermissionTypeFilter(permission_type, raise_error),
         )
         return awaitable
 
@@ -300,9 +318,7 @@ def register_on_astrbot_loaded(**kwargs):
 
 
 def register_on_platform_loaded(**kwargs):
-    """
-    当平台加载完成时
-    """
+    """当平台加载完成时"""
 
     def decorator(awaitable):
         _ = get_handler_or_create(awaitable, EventType.OnPlatformLoadedEvent, **kwargs)
@@ -324,6 +340,7 @@ def register_on_llm_request(**kwargs):
     ```
 
     请务必接收两个参数：event, request
+
     """
 
     def decorator(awaitable):
@@ -346,6 +363,7 @@ def register_on_llm_response(**kwargs):
     ```
 
     请务必接收两个参数：event, request
+
     """
 
     def decorator(awaitable):
@@ -365,7 +383,7 @@ def register_llm_tool(name: str | None = None, **kwargs):
     async def get_weather(event: AstrMessageEvent, location: str):
         \'\'\'获取天气信息。
 
-        Args:
+    Args:
             location(string): 地点
         \'\'\'
         # 处理逻辑
@@ -386,8 +404,8 @@ def register_llm_tool(name: str | None = None, **kwargs):
     event.stop_event()
     yield
     ```
-    """
 
+    """
     name_ = name
     registering_agent = None
     if kwargs.get("registering_agent"):
@@ -401,14 +419,14 @@ def register_llm_tool(name: str | None = None, **kwargs):
         for arg in docstring.params:
             if arg.type_name not in SUPPORTED_TYPES:
                 raise ValueError(
-                    f"LLM 函数工具 {awaitable.__module__}_{llm_tool_name} 不支持的参数类型：{arg.type_name}"
+                    f"LLM 函数工具 {awaitable.__module__}_{llm_tool_name} 不支持的参数类型：{arg.type_name}",
                 )
             args.append(
                 {
                     "type": arg.type_name,
                     "name": arg.arg_name,
                     "description": arg.description,
-                }
+                },
             )
         # print(llm_tool_name, registering_agent)
         if not registering_agent:
@@ -454,6 +472,7 @@ def register_agent(
         instruction: Agent 的指令
         tools: Agent 使用的工具列表
         run_hooks: Agent 运行时的钩子函数
+
     """
     tools_ = tools or []
 
@@ -478,7 +497,9 @@ def register_on_decorating_result(**kwargs):
 
     def decorator(awaitable):
         _ = get_handler_or_create(
-            awaitable, EventType.OnDecoratingResultEvent, **kwargs
+            awaitable,
+            EventType.OnDecoratingResultEvent,
+            **kwargs,
         )
         return awaitable
 
@@ -490,7 +511,9 @@ def register_after_message_sent(**kwargs):
 
     def decorator(awaitable):
         _ = get_handler_or_create(
-            awaitable, EventType.OnAfterMessageSentEvent, **kwargs
+            awaitable,
+            EventType.OnAfterMessageSentEvent,
+            **kwargs,
         )
         return awaitable