mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-16 01:40:15 +08:00
新增模块: - api/basic/: AstrBotConfig, BaseConversationManager, Conversation - api/event/: AstrMessageEvent, AstrBotMessage, EventType, MessageType, MessageSession, EventResult 等核心事件类型 - api/message/: MessageChain 及所有消息组件 (Plain, At, Image, File 等) - api/platform/: PlatformMetadata 平台元数据类型 - api/provider/: LLMResponse 提供者响应实体 - api/star/star.py: StarMetadata 插件元数据类型 更新模块: - api/__init__.py: 导出所有子模块 - api/components/: 扩展 Command 兼容性 - api/event/filter.py: 增强 filter 装饰器兼容性 - context.py, decorators.py, events.py: 顶层兼容入口 测试更新: - test_api_event_filter.py: 验证 filter 兼容性 - test_api_modules.py: 验证新模块可导入 - test_handler_dispatcher.py: 验证处理器分发 文档更新: - AGENTS.md/CLAUDE.md: 添加兼容层设计说明,避免重复造轮子 设计原则: - 兼容层通过 thin re-export 方式暴露旧版 API - 不复制独立运行时逻辑,保持架构清晰 - 新版推荐使用顶层模块导入路径
107 lines
2.8 KiB
Python
107 lines
2.8 KiB
Python
"""v4 原生装饰器。
|
|
|
|
旧版 ``astrbot_sdk.api.event.filter`` 的兼容与降级边界由 compat 模块处理,
|
|
这里仅保留 v4 原生 trigger/permission 元数据建模。
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass, field
|
|
from typing import Any, Callable
|
|
|
|
from .protocol.descriptors import (
|
|
CommandTrigger,
|
|
EventTrigger,
|
|
MessageTrigger,
|
|
Permissions,
|
|
ScheduleTrigger,
|
|
)
|
|
|
|
HandlerCallable = Callable[..., Any]
|
|
HANDLER_META_ATTR = "__astrbot_handler_meta__"
|
|
|
|
|
|
@dataclass(slots=True)
|
|
class HandlerMeta:
|
|
trigger: CommandTrigger | MessageTrigger | EventTrigger | ScheduleTrigger | None = (
|
|
None
|
|
)
|
|
priority: int = 0
|
|
permissions: Permissions = field(default_factory=Permissions)
|
|
|
|
|
|
def _get_or_create_meta(func: HandlerCallable) -> HandlerMeta:
|
|
meta = getattr(func, HANDLER_META_ATTR, None)
|
|
if meta is None:
|
|
meta = HandlerMeta()
|
|
setattr(func, HANDLER_META_ATTR, meta)
|
|
return meta
|
|
|
|
|
|
def get_handler_meta(func: HandlerCallable) -> HandlerMeta | None:
|
|
return getattr(func, HANDLER_META_ATTR, None)
|
|
|
|
|
|
def on_command(
|
|
command: str,
|
|
*,
|
|
aliases: list[str] | None = None,
|
|
description: str | None = None,
|
|
) -> Callable[[HandlerCallable], HandlerCallable]:
|
|
def decorator(func: HandlerCallable) -> HandlerCallable:
|
|
meta = _get_or_create_meta(func)
|
|
meta.trigger = CommandTrigger(
|
|
command=command,
|
|
aliases=aliases or [],
|
|
description=description,
|
|
)
|
|
return func
|
|
|
|
return decorator
|
|
|
|
|
|
def on_message(
|
|
*,
|
|
regex: str | None = None,
|
|
keywords: list[str] | None = None,
|
|
platforms: list[str] | None = None,
|
|
) -> Callable[[HandlerCallable], HandlerCallable]:
|
|
def decorator(func: HandlerCallable) -> HandlerCallable:
|
|
meta = _get_or_create_meta(func)
|
|
meta.trigger = MessageTrigger(
|
|
regex=regex,
|
|
keywords=keywords or [],
|
|
platforms=platforms or [],
|
|
)
|
|
return func
|
|
|
|
return decorator
|
|
|
|
|
|
def on_event(event_type: str) -> Callable[[HandlerCallable], HandlerCallable]:
|
|
def decorator(func: HandlerCallable) -> HandlerCallable:
|
|
meta = _get_or_create_meta(func)
|
|
meta.trigger = EventTrigger(event_type=event_type)
|
|
return func
|
|
|
|
return decorator
|
|
|
|
|
|
def on_schedule(
|
|
*,
|
|
cron: str | None = None,
|
|
interval_seconds: int | None = None,
|
|
) -> Callable[[HandlerCallable], HandlerCallable]:
|
|
def decorator(func: HandlerCallable) -> HandlerCallable:
|
|
meta = _get_or_create_meta(func)
|
|
meta.trigger = ScheduleTrigger(cron=cron, interval_seconds=interval_seconds)
|
|
return func
|
|
|
|
return decorator
|
|
|
|
|
|
def require_admin(func: HandlerCallable) -> HandlerCallable:
|
|
meta = _get_or_create_meta(func)
|
|
meta.permissions.require_admin = True
|
|
return func
|