butterbot-python 3.1.0.dev1__py3-none-any.whl

butterbot/sources/napcat/data/segment_data.py

@@ -0,0 +1,432 @@
+"""
+NapCat OneBot11 消息段数据模型
+
+基于 OneBot11 协议定义的消息段类型，使用 BaseDataModel 实现自动分发构造
+"""
+
+from typing import ClassVar, TypeVar
+
+from butterbot.core.data import AutoDispatchList, BaseDataModel
+
+# ==================== 嵌套数据类 ====================
+
+
+class TextData(BaseDataModel):
+    """纯文本消息数据"""
+
+    text: str
+
+
+class FaceData(BaseDataModel):
+    """QQ表情消息数据"""
+
+    id: str
+
+
+class ImageData(BaseDataModel):
+    """图片消息数据"""
+
+    file: str
+    type: str | None = None  # 'flash' 表示闪照
+    url: str | None = None
+    cache: int | None = None  # 0 或 1
+    proxy: int | None = None  # 0 或 1
+    timeout: int | None = None
+
+
+class RecordData(BaseDataModel):
+    """语音消息数据"""
+
+    file: str
+    magic: int | None = None  # 0 或 1，变声
+    url: str | None = None
+    cache: int | None = None
+    proxy: int | None = None
+    timeout: int | None = None
+
+
+class VideoData(BaseDataModel):
+    """短视频消息数据"""
+
+    file: str
+    url: str | None = None
+    cache: int | None = None
+    proxy: int | None = None
+    timeout: int | None = None
+
+
+class AtData(BaseDataModel):
+    """@某人消息数据"""
+
+    qq: str  # QQ号 或 'all'
+    name: str | None = None
+
+
+class PokeData(BaseDataModel):
+    """戳一戳消息数据"""
+
+    type: str
+    id: str
+    name: str | None = None
+
+
+class ShareData(BaseDataModel):
+    """链接分享消息数据"""
+
+    url: str
+    title: str
+    content: str | None = None
+    image: str | None = None
+
+
+class ContactData(BaseDataModel):
+    """推荐好友/群消息数据"""
+
+    type: str  # 'qq' 或 'group'
+    id: str
+
+
+class LocationData(BaseDataModel):
+    """位置消息数据"""
+
+    lat: str  # 纬度
+    lon: str  # 经度
+    title: str | None = None
+    content: str | None = None
+
+
+class MusicData(BaseDataModel):
+    """音乐分享消息数据"""
+
+    type: str  # 'qq', '163', 'xm' 或 'custom'
+    id: str | None = None  # 非 custom 时使用
+    url: str | None = None  # custom 时使用
+    audio: str | None = None
+    title: str | None = None
+    content: str | None = None
+    image: str | None = None
+
+
+class ReplyData(BaseDataModel):
+    """回复消息数据"""
+
+    id: str | None = None  # msg_id 的短ID映射
+    seq: int | None = None  # msg_seq，优先使用
+
+
+class ForwardData(BaseDataModel):
+    """合并转发消息数据"""
+
+    id: str
+
+
+class NodeData(BaseDataModel):
+    """合并转发节点消息数据"""
+
+    id: str | None = None  # 直接引用已有消息
+    user_id: str | None = None  # 自定义节点
+    nickname: str | None = None
+    content: list | None = None  # MessageNode[]
+    prompt: str | None = None
+    summary: str | None = None
+    source: str | None = None
+
+
+class FileData(BaseDataModel):
+    """文件消息数据"""
+
+    file: str
+
+
+class AnonymousData(BaseDataModel):
+    """匿名发消息数据"""
+
+    ignore: int | None = None  # 0 或 1
+
+
+class RpsData(BaseDataModel):
+    """猜拳魔法表情数据"""
+
+    pass
+
+
+class DiceData(BaseDataModel):
+    """掷骰子魔法表情数据"""
+
+    pass
+
+
+class ShakeData(BaseDataModel):
+    """窗口抖动数据"""
+
+    pass
+
+
+class XmlData(BaseDataModel):
+    """XML消息数据"""
+
+    data: str
+
+
+class JsonData(BaseDataModel):
+    """JSON消息数据"""
+
+    data: str
+
+
+# ==================== 消息段基类与子类 ====================
+
+
+class MessageNode(BaseDataModel):
+    """OneBot11 消息段基类
+
+    使用 type 字段进行分发
+    """
+
+    discriminator_field: ClassVar[str] = "type"
+    type: str
+
+
+MessageNodeT = TypeVar("MessageNodeT", bound=MessageNode)
+
+
+class TextNode(MessageNode):
+    """纯文本消息段"""
+
+    discriminator_value: ClassVar[str] = "text"
+    type: str = "text"
+    data: TextData
+
+    @property
+    def text(self) -> str:
+        return self.data.text
+
+
+class FaceNode(MessageNode):
+    """QQ表情消息段"""
+
+    discriminator_value: ClassVar[str] = "face"
+    type: str = "face"
+    data: FaceData
+
+    @property
+    def face_id(self) -> str:
+        return self.data.id
+
+
+class ImageNode(MessageNode):
+    """图片消息段"""
+
+    discriminator_value: ClassVar[str] = "image"
+    type: str = "image"
+    data: ImageData
+
+
+class RecordNode(MessageNode):
+    """语音消息段"""
+
+    discriminator_value: ClassVar[str] = "record"
+    type: str = "record"
+    data: RecordData
+
+
+class VideoNode(MessageNode):
+    """短视频消息段"""
+
+    discriminator_value: ClassVar[str] = "video"
+    type: str = "video"
+    data: VideoData
+
+
+class AtNode(MessageNode):
+    """@某人消息段"""
+
+    discriminator_value: ClassVar[str] = "at"
+    type: str = "at"
+    data: AtData
+
+    @property
+    def qq(self) -> str:
+        return self.data.qq
+
+    @property
+    def is_all(self) -> bool:
+        return self.data.qq == "all"
+
+
+class RpsNode(MessageNode):
+    """猜拳魔法表情消息段"""
+
+    discriminator_value: ClassVar[str] = "rps"
+    type: str = "rps"
+    data: RpsData | None = None
+
+
+class DiceNode(MessageNode):
+    """掷骰子魔法表情消息段"""
+
+    discriminator_value: ClassVar[str] = "dice"
+    type: str = "dice"
+    data: DiceData | None = None
+
+
+class ShakeNode(MessageNode):
+    """窗口抖动消息段"""
+
+    discriminator_value: ClassVar[str] = "shake"
+    type: str = "shake"
+    data: ShakeData | None = None
+
+
+class PokeNode(MessageNode):
+    """戳一戳消息段"""
+
+    discriminator_value: ClassVar[str] = "poke"
+    type: str = "poke"
+    data: PokeData
+
+
+class AnonymousNode(MessageNode):
+    """匿名发消息消息段"""
+
+    discriminator_value: ClassVar[str] = "anonymous"
+    type: str = "anonymous"
+    data: AnonymousData | None = None
+
+
+class ShareNode(MessageNode):
+    """链接分享消息段"""
+
+    discriminator_value: ClassVar[str] = "share"
+    type: str = "share"
+    data: ShareData
+
+
+class ContactNode(MessageNode):
+    """推荐好友/群消息段"""
+
+    discriminator_value: ClassVar[str] = "contact"
+    type: str = "contact"
+    data: ContactData
+
+
+class LocationNode(MessageNode):
+    """位置消息段"""
+
+    discriminator_value: ClassVar[str] = "location"
+    type: str = "location"
+    data: LocationData
+
+
+class MusicNode(MessageNode):
+    """音乐分享消息段"""
+
+    discriminator_value: ClassVar[str] = "music"
+    type: str = "music"
+    data: MusicData
+
+
+class ReplyNode(MessageNode):
+    """回复消息段"""
+
+    discriminator_value: ClassVar[str] = "reply"
+    type: str = "reply"
+    data: ReplyData
+
+
+class ForwardNode(MessageNode):
+    """合并转发消息段"""
+
+    discriminator_value: ClassVar[str] = "forward"
+    type: str = "forward"
+    data: ForwardData
+
+
+class NodeNode(MessageNode):
+    """合并转发节点消息段"""
+
+    discriminator_value: ClassVar[str] = "node"
+    type: str = "node"
+    data: NodeData
+
+
+class XmlNode(MessageNode):
+    """XML消息段"""
+
+    discriminator_value: ClassVar[str] = "xml"
+    type: str = "xml"
+    data: XmlData
+
+    @property
+    def xml_data(self) -> str:
+        return self.data.data
+
+
+class JsonNode(MessageNode):
+    """JSON消息段"""
+
+    discriminator_value: ClassVar[str] = "json"
+    type: str = "json"
+    data: JsonData
+
+    @property
+    def json_data(self) -> str:
+        return self.data.data
+
+
+class FileNode(MessageNode):
+    """文件消息段"""
+
+    discriminator_value: ClassVar[str] = "file"
+    type: str = "file"
+    data: FileData
+
+
+# ==================== 消息列表领域模型 ====================
+
+
+class NapcatMessage(AutoDispatchList[MessageNode]):
+    """Napcat消息领域模型，包含一个消息段列表"""
+
+    # root: list[MessageNode]
+
+    @classmethod
+    def element_type(cls):
+        return MessageNode
+
+    # 可迭代对象
+    def __iter__(self):
+        return iter(self.root)
+
+    # ====== 便携方法 ======
+
+    @property
+    def message_list(self) -> list[MessageNode]:
+        """消息段列表"""
+        return self.root
+
+    def filter(self, node_type: type[MessageNodeT]) -> list[MessageNodeT]:
+        """过滤出指定类型的消息段"""
+        return [seg for seg in self.message_list if isinstance(seg, node_type)]
+
+    @property
+    def texts(self) -> list[str]:
+        """提取所有文本消息段的文本内容"""
+        return [seg.text for seg in self.filter(TextNode)]
+
+    @property
+    def ats(self) -> list[str]:
+        """提取所有@消息段的QQ号"""
+        return [seg.qq for seg in self.filter(AtNode)]
+
+    @property
+    def imgs(self) -> list[str]:
+        """提取所有图片消息段的URL"""
+        return [
+            seg.data.url for seg in self.filter(ImageNode) if seg.data.url is not None
+        ]
+
+    @property
+    def plain_text(self):
+        """提取纯文本内容，连接所有文本消息段的文本"""
+        return "".join(self.texts)

butterbot/sources/napcat/events.py

@@ -0,0 +1,91 @@
+"""Napcat 事件类型别名.
+
+将 ``Event[*Data]`` 包装为 ``*Event`` 类型别名，用户可直接用作类型注解：
+
+.. code:: python
+
+    from butterbot.sources.napcat.events import NapcatGroupMessageEvent
+
+    @app.subscribe(source.uuid, NapcatType.GROUP_MESSAGE)
+    async def handler(event: NapcatGroupMessageEvent):
+        print(event.data.group_id)
+"""
+
+from typing import TypeAlias
+
+from butterbot.core.event import Event
+
+from .data import (
+    NapcatData,
+    NapcatFriendAddNoticeData,
+    NapcatFriendRecallNoticeData,
+    NapcatFriendRequestData,
+    NapcatGroupAdminNoticeData,
+    NapcatGroupBanNoticeData,
+    NapcatGroupCardNoticeData,
+    NapcatGroupDecreaseNoticeData,
+    NapcatGroupEssenceNoticeData,
+    NapcatGroupIncreaseNoticeData,
+    NapcatGroupMessageData,
+    NapcatGroupMessageSentData,
+    NapcatGroupMsgEmojiLikeNoticeData,
+    NapcatGroupRecallNoticeData,
+    NapcatGroupRequestData,
+    NapcatGroupUploadNoticeData,
+    NapcatHeartbeatMetaData,
+    NapcatHonorNotifyData,
+    NapcatLifecycleMetaData,
+    NapcatLuckyKingNotifyData,
+    NapcatMessageData,
+    NapcatMessageSentData,
+    NapcatMetaData,
+    NapcatNoticeData,
+    NapcatNotifyData,
+    NapcatPokeNotifyData,
+    NapcatPrivateMessageData,
+    NapcatPrivateMessageSentData,
+    NapcatReactionNoticeData,
+    NapcatRequestData,
+)
+
+# ── 通配 ──
+NapcatEvent: TypeAlias = Event[NapcatData]
+
+# ── 消息事件 ──
+NapcatMessageEvent: TypeAlias = Event[NapcatMessageData]
+NapcatPrivateMessageEvent: TypeAlias = Event[NapcatPrivateMessageData]
+NapcatGroupMessageEvent: TypeAlias = Event[NapcatGroupMessageData]
+
+# ── 消息发送事件 ──
+NapcatMessageSentEvent: TypeAlias = Event[NapcatMessageSentData]
+NapcatPrivateMessageSentEvent: TypeAlias = Event[NapcatPrivateMessageSentData]
+NapcatGroupMessageSentEvent: TypeAlias = Event[NapcatGroupMessageSentData]
+
+# ── 通知事件 ──
+NapcatNoticeEvent: TypeAlias = Event[NapcatNoticeData]
+NapcatGroupUploadNoticeEvent: TypeAlias = Event[NapcatGroupUploadNoticeData]
+NapcatGroupAdminNoticeEvent: TypeAlias = Event[NapcatGroupAdminNoticeData]
+NapcatGroupDecreaseNoticeEvent: TypeAlias = Event[NapcatGroupDecreaseNoticeData]
+NapcatGroupIncreaseNoticeEvent: TypeAlias = Event[NapcatGroupIncreaseNoticeData]
+NapcatGroupBanNoticeEvent: TypeAlias = Event[NapcatGroupBanNoticeData]
+NapcatFriendAddNoticeEvent: TypeAlias = Event[NapcatFriendAddNoticeData]
+NapcatGroupRecallNoticeEvent: TypeAlias = Event[NapcatGroupRecallNoticeData]
+NapcatFriendRecallNoticeEvent: TypeAlias = Event[NapcatFriendRecallNoticeData]
+NapcatNotifyEvent: TypeAlias = Event[NapcatNotifyData]
+NapcatPokeNotifyEvent: TypeAlias = Event[NapcatPokeNotifyData]
+NapcatLuckyKingNotifyEvent: TypeAlias = Event[NapcatLuckyKingNotifyData]
+NapcatHonorNotifyEvent: TypeAlias = Event[NapcatHonorNotifyData]
+NapcatGroupMsgEmojiLikeNoticeEvent: TypeAlias = Event[NapcatGroupMsgEmojiLikeNoticeData]
+NapcatReactionNoticeEvent: TypeAlias = Event[NapcatReactionNoticeData]
+NapcatGroupEssenceNoticeEvent: TypeAlias = Event[NapcatGroupEssenceNoticeData]
+NapcatGroupCardNoticeEvent: TypeAlias = Event[NapcatGroupCardNoticeData]
+
+# ── 请求事件 ──
+NapcatRequestEvent: TypeAlias = Event[NapcatRequestData]
+NapcatFriendRequestEvent: TypeAlias = Event[NapcatFriendRequestData]
+NapcatGroupRequestEvent: TypeAlias = Event[NapcatGroupRequestData]
+
+# ── 元事件 ──
+NapcatMetaEvent: TypeAlias = Event[NapcatMetaData]
+NapcatLifecycleMetaEvent: TypeAlias = Event[NapcatLifecycleMetaData]
+NapcatHeartbeatMetaEvent: TypeAlias = Event[NapcatHeartbeatMetaData]

butterbot/sources/napcat/filters/__init__.py

@@ -0,0 +1,19 @@
+"""Napcat 预置过滤器包."""
+
+from .filters import (
+    CommandFilter,
+    GroupFilter,
+    PrefixFilter,
+    SenderRoleFilter,
+    TextFilter,
+    UserFilter,
+)
+
+__all__ = [
+    "CommandFilter",
+    "GroupFilter",
+    "PrefixFilter",
+    "SenderRoleFilter",
+    "TextFilter",
+    "UserFilter",
+]