mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-07-29 17:27:41 +00:00
🚧 update event models
This commit is contained in:
yanyongyu
@ -2,220 +2,230 @@ from typing import Optional
|
||||
from typing_extensions import Literal
|
||||
|
||||
from pydantic import BaseModel
|
||||
from nonebot.adapters import Event
|
||||
from nonebot.utils import escape_tag
|
||||
from nonebot.typing import overrides
|
||||
from nonebot.adapters import Event as BaseEvent
|
||||
from nonebot.exception import NoLogException
|
||||
|
||||
from .message import Message
|
||||
|
||||
# class Event(BaseEvent):
|
||||
# """
|
||||
# CQHTTP 协议 Event 适配。继承属性参考 `BaseEvent <./#class-baseevent>`_ 。
|
||||
# """
|
||||
|
||||
class Event(BaseEvent):
|
||||
"""
|
||||
CQHTTP 协议 Event 适配。继承属性参考 `BaseEvent <./#class-baseevent>`_ 。
|
||||
"""
|
||||
# def __init__(self, raw_event: dict):
|
||||
# if "message" in raw_event:
|
||||
# raw_event["message"] = Message(raw_event["message"])
|
||||
|
||||
def __init__(self, raw_event: dict):
|
||||
if "message" in raw_event:
|
||||
raw_event["message"] = Message(raw_event["message"])
|
||||
# super().__init__(raw_event)
|
||||
|
||||
super().__init__(raw_event)
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def id(self) -> Optional[int]:
|
||||
# """
|
||||
# - 类型: ``Optional[int]``
|
||||
# - 说明: 事件/消息 ID
|
||||
# """
|
||||
# return self._raw_event.get("message_id") or self._raw_event.get("flag")
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def id(self) -> Optional[int]:
|
||||
"""
|
||||
- 类型: ``Optional[int]``
|
||||
- 说明: 事件/消息 ID
|
||||
"""
|
||||
return self._raw_event.get("message_id") or self._raw_event.get("flag")
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def name(self) -> str:
|
||||
# """
|
||||
# - 类型: ``str``
|
||||
# - 说明: 事件名称，由类型与 ``.`` 组合而成
|
||||
# """
|
||||
# n = self.type + "." + self.detail_type
|
||||
# if self.sub_type:
|
||||
# n += "." + self.sub_type
|
||||
# return n
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def name(self) -> str:
|
||||
"""
|
||||
- 类型: ``str``
|
||||
- 说明: 事件名称，由类型与 ``.`` 组合而成
|
||||
"""
|
||||
n = self.type + "." + self.detail_type
|
||||
if self.sub_type:
|
||||
n += "." + self.sub_type
|
||||
return n
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def self_id(self) -> str:
|
||||
# """
|
||||
# - 类型: ``str``
|
||||
# - 说明: 机器人自身 ID
|
||||
# """
|
||||
# return str(self._raw_event["self_id"])
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def self_id(self) -> str:
|
||||
"""
|
||||
- 类型: ``str``
|
||||
- 说明: 机器人自身 ID
|
||||
"""
|
||||
return str(self._raw_event["self_id"])
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def time(self) -> int:
|
||||
# """
|
||||
# - 类型: ``int``
|
||||
# - 说明: 事件发生时间
|
||||
# """
|
||||
# return self._raw_event["time"]
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def time(self) -> int:
|
||||
"""
|
||||
- 类型: ``int``
|
||||
- 说明: 事件发生时间
|
||||
"""
|
||||
return self._raw_event["time"]
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def type(self) -> str:
|
||||
# """
|
||||
# - 类型: ``str``
|
||||
# - 说明: 事件类型
|
||||
# """
|
||||
# return self._raw_event["post_type"]
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def type(self) -> str:
|
||||
"""
|
||||
- 类型: ``str``
|
||||
- 说明: 事件类型
|
||||
"""
|
||||
return self._raw_event["post_type"]
|
||||
# @type.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def type(self, value) -> None:
|
||||
# self._raw_event["post_type"] = value
|
||||
|
||||
@type.setter
|
||||
@overrides(BaseEvent)
|
||||
def type(self, value) -> None:
|
||||
self._raw_event["post_type"] = value
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def detail_type(self) -> str:
|
||||
# """
|
||||
# - 类型: ``str``
|
||||
# - 说明: 事件详细类型
|
||||
# """
|
||||
# return self._raw_event[f"{self.type}_type"]
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def detail_type(self) -> str:
|
||||
"""
|
||||
- 类型: ``str``
|
||||
- 说明: 事件详细类型
|
||||
"""
|
||||
return self._raw_event[f"{self.type}_type"]
|
||||
# @detail_type.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def detail_type(self, value) -> None:
|
||||
# self._raw_event[f"{self.type}_type"] = value
|
||||
|
||||
@detail_type.setter
|
||||
@overrides(BaseEvent)
|
||||
def detail_type(self, value) -> None:
|
||||
self._raw_event[f"{self.type}_type"] = value
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def sub_type(self) -> Optional[str]:
|
||||
# """
|
||||
# - 类型: ``Optional[str]``
|
||||
# - 说明: 事件子类型
|
||||
# """
|
||||
# return self._raw_event.get("sub_type")
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def sub_type(self) -> Optional[str]:
|
||||
"""
|
||||
- 类型: ``Optional[str]``
|
||||
- 说明: 事件子类型
|
||||
"""
|
||||
return self._raw_event.get("sub_type")
|
||||
# @sub_type.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def sub_type(self, value) -> None:
|
||||
# self._raw_event["sub_type"] = value
|
||||
|
||||
@sub_type.setter
|
||||
@overrides(BaseEvent)
|
||||
def sub_type(self, value) -> None:
|
||||
self._raw_event["sub_type"] = value
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def user_id(self) -> Optional[int]:
|
||||
# """
|
||||
# - 类型: ``Optional[int]``
|
||||
# - 说明: 事件主体 ID
|
||||
# """
|
||||
# return self._raw_event.get("user_id")
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def user_id(self) -> Optional[int]:
|
||||
"""
|
||||
- 类型: ``Optional[int]``
|
||||
- 说明: 事件主体 ID
|
||||
"""
|
||||
return self._raw_event.get("user_id")
|
||||
# @user_id.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def user_id(self, value) -> None:
|
||||
# self._raw_event["user_id"] = value
|
||||
|
||||
@user_id.setter
|
||||
@overrides(BaseEvent)
|
||||
def user_id(self, value) -> None:
|
||||
self._raw_event["user_id"] = value
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def group_id(self) -> Optional[int]:
|
||||
# """
|
||||
# - 类型: ``Optional[int]``
|
||||
# - 说明: 事件主体群 ID
|
||||
# """
|
||||
# return self._raw_event.get("group_id")
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def group_id(self) -> Optional[int]:
|
||||
"""
|
||||
- 类型: ``Optional[int]``
|
||||
- 说明: 事件主体群 ID
|
||||
"""
|
||||
return self._raw_event.get("group_id")
|
||||
# @group_id.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def group_id(self, value) -> None:
|
||||
# self._raw_event["group_id"] = value
|
||||
|
||||
@group_id.setter
|
||||
@overrides(BaseEvent)
|
||||
def group_id(self, value) -> None:
|
||||
self._raw_event["group_id"] = value
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def to_me(self) -> Optional[bool]:
|
||||
# """
|
||||
# - 类型: ``Optional[bool]``
|
||||
# - 说明: 消息是否与机器人相关
|
||||
# """
|
||||
# return self._raw_event.get("to_me")
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def to_me(self) -> Optional[bool]:
|
||||
"""
|
||||
- 类型: ``Optional[bool]``
|
||||
- 说明: 消息是否与机器人相关
|
||||
"""
|
||||
return self._raw_event.get("to_me")
|
||||
# @to_me.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def to_me(self, value) -> None:
|
||||
# self._raw_event["to_me"] = value
|
||||
|
||||
@to_me.setter
|
||||
@overrides(BaseEvent)
|
||||
def to_me(self, value) -> None:
|
||||
self._raw_event["to_me"] = value
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def message(self) -> Optional["Message"]:
|
||||
# """
|
||||
# - 类型: ``Optional[Message]``
|
||||
# - 说明: 消息内容
|
||||
# """
|
||||
# return self._raw_event.get("message")
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def message(self) -> Optional["Message"]:
|
||||
"""
|
||||
- 类型: ``Optional[Message]``
|
||||
- 说明: 消息内容
|
||||
"""
|
||||
return self._raw_event.get("message")
|
||||
# @message.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def message(self, value) -> None:
|
||||
# self._raw_event["message"] = value
|
||||
|
||||
@message.setter
|
||||
@overrides(BaseEvent)
|
||||
def message(self, value) -> None:
|
||||
self._raw_event["message"] = value
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def reply(self) -> Optional[dict]:
|
||||
# """
|
||||
# - 类型: ``Optional[dict]``
|
||||
# - 说明: 回复消息详情
|
||||
# """
|
||||
# return self._raw_event.get("reply")
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def reply(self) -> Optional[dict]:
|
||||
"""
|
||||
- 类型: ``Optional[dict]``
|
||||
- 说明: 回复消息详情
|
||||
"""
|
||||
return self._raw_event.get("reply")
|
||||
# @reply.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def reply(self, value) -> None:
|
||||
# self._raw_event["reply"] = value
|
||||
|
||||
@reply.setter
|
||||
@overrides(BaseEvent)
|
||||
def reply(self, value) -> None:
|
||||
self._raw_event["reply"] = value
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def raw_message(self) -> Optional[str]:
|
||||
# """
|
||||
# - 类型: ``Optional[str]``
|
||||
# - 说明: 原始消息
|
||||
# """
|
||||
# return self._raw_event.get("raw_message")
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def raw_message(self) -> Optional[str]:
|
||||
"""
|
||||
- 类型: ``Optional[str]``
|
||||
- 说明: 原始消息
|
||||
"""
|
||||
return self._raw_event.get("raw_message")
|
||||
# @raw_message.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def raw_message(self, value) -> None:
|
||||
# self._raw_event["raw_message"] = value
|
||||
|
||||
@raw_message.setter
|
||||
@overrides(BaseEvent)
|
||||
def raw_message(self, value) -> None:
|
||||
self._raw_event["raw_message"] = value
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def plain_text(self) -> Optional[str]:
|
||||
# """
|
||||
# - 类型: ``Optional[str]``
|
||||
# - 说明: 纯文本消息内容
|
||||
# """
|
||||
# return self.message and self.message.extract_plain_text()
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def plain_text(self) -> Optional[str]:
|
||||
"""
|
||||
- 类型: ``Optional[str]``
|
||||
- 说明: 纯文本消息内容
|
||||
"""
|
||||
return self.message and self.message.extract_plain_text()
|
||||
# @property
|
||||
# @overrides(BaseEvent)
|
||||
# def sender(self) -> Optional[dict]:
|
||||
# """
|
||||
# - 类型: ``Optional[dict]``
|
||||
# - 说明: 消息发送者信息
|
||||
# """
|
||||
# return self._raw_event.get("sender")
|
||||
|
||||
@property
|
||||
@overrides(BaseEvent)
|
||||
def sender(self) -> Optional[dict]:
|
||||
"""
|
||||
- 类型: ``Optional[dict]``
|
||||
- 说明: 消息发送者信息
|
||||
"""
|
||||
return self._raw_event.get("sender")
|
||||
|
||||
@sender.setter
|
||||
@overrides(BaseEvent)
|
||||
def sender(self, value) -> None:
|
||||
self._raw_event["sender"] = value
|
||||
# @sender.setter
|
||||
# @overrides(BaseEvent)
|
||||
# def sender(self, value) -> None:
|
||||
# self._raw_event["sender"] = value
|
||||
|
||||
|
||||
class CQHTTPEvent(BaseModel):
|
||||
type: str
|
||||
class CQHTTPEvent(Event):
|
||||
type: Literal["message", "notice", "request", "meta_event"]
|
||||
time: int
|
||||
self_id: int
|
||||
post_type: str
|
||||
|
||||
class Config:
|
||||
extra = "allow"
|
||||
@overrides(Event)
|
||||
def get_type(self) -> Literal["message", "notice", "request", "meta_event"]:
|
||||
return self.type
|
||||
|
||||
@overrides(Event)
|
||||
def get_event_name(self) -> str:
|
||||
return self.post_type
|
||||
|
||||
@overrides(Event)
|
||||
def get_event_description(self) -> str:
|
||||
return str(self.dict())
|
||||
|
||||
|
||||
# Models
|
||||
@ -266,6 +276,12 @@ class MessageEvent(CQHTTPEvent):
|
||||
post_type: Literal["message"]
|
||||
message_type: str
|
||||
|
||||
@overrides(CQHTTPEvent)
|
||||
def get_event_name(self) -> str:
|
||||
sub_type = getattr(self, "sub_type", None)
|
||||
return f"{self.post_type}.{self.message_type}" + (f".{sub_type}"
|
||||
if sub_type else "")
|
||||
|
||||
|
||||
class PrivateMessageEvent(MessageEvent):
|
||||
message_type: Literal["private"]
|
||||
@ -277,11 +293,20 @@ class PrivateMessageEvent(MessageEvent):
|
||||
font: int
|
||||
sender: Sender
|
||||
|
||||
@overrides(CQHTTPEvent)
|
||||
def get_event_description(self) -> str:
|
||||
return (f'Message {self.message_id} from {self.user_id} "' + "".join(
|
||||
map(
|
||||
lambda x: escape_tag(str(x))
|
||||
if x.type == "text" else f"<le>{escape_tag(str(x))}</le>",
|
||||
self.message)) + '"')
|
||||
|
||||
|
||||
class GroupMessageEvent(MessageEvent):
|
||||
message_type: Literal["group"]
|
||||
sub_type: str
|
||||
user_id: int
|
||||
group_id: int
|
||||
message_id: int
|
||||
message: Message
|
||||
raw_message: str
|
||||
@ -289,12 +314,28 @@ class GroupMessageEvent(MessageEvent):
|
||||
sender: Sender
|
||||
anonymous: Anonymous
|
||||
|
||||
@overrides(CQHTTPEvent)
|
||||
def get_event_description(self) -> str:
|
||||
return (
|
||||
f'Message {self.message_id} from {self.user_id}@[群:{self.group_id}] "'
|
||||
+ "".join(
|
||||
map(
|
||||
lambda x: escape_tag(str(x))
|
||||
if x.type == "text" else f"<le>{escape_tag(str(x))}</le>",
|
||||
self.message)) + '"')
|
||||
|
||||
|
||||
# Notice Events
|
||||
class NoticeEvent(CQHTTPEvent):
|
||||
post_type: Literal["notice"]
|
||||
notice_type: str
|
||||
|
||||
@overrides(CQHTTPEvent)
|
||||
def get_event_name(self) -> str:
|
||||
sub_type = getattr(self, "sub_type", None)
|
||||
return f"{self.post_type}.{self.notice_type}" + (f".{sub_type}"
|
||||
if sub_type else "")
|
||||
|
||||
|
||||
class GroupUploadNoticeEvent(NoticeEvent):
|
||||
notice_type: Literal["group_upload"]
|
||||
@ -378,6 +419,12 @@ class RequestEvent(CQHTTPEvent):
|
||||
post_type: Literal["request"]
|
||||
request_type: str
|
||||
|
||||
@overrides(CQHTTPEvent)
|
||||
def get_event_name(self) -> str:
|
||||
sub_type = getattr(self, "sub_type", None)
|
||||
return f"{self.post_type}.{self.request_type}" + (f".{sub_type}"
|
||||
if sub_type else "")
|
||||
|
||||
|
||||
class FriendRequestEvent(RequestEvent):
|
||||
request_type: Literal["friend"]
|
||||
@ -395,10 +442,21 @@ class GroupRequestEvent(RequestEvent):
|
||||
flag: str
|
||||
|
||||
|
||||
# Meta Events
|
||||
class MetaEvent(CQHTTPEvent):
|
||||
post_type: Literal["meta_event"]
|
||||
meta_event_type: str
|
||||
|
||||
@overrides(CQHTTPEvent)
|
||||
def get_event_name(self) -> str:
|
||||
sub_type = getattr(self, "sub_type", None)
|
||||
return f"{self.post_type}.{self.meta_event_type}" + (f".{sub_type}" if
|
||||
sub_type else "")
|
||||
|
||||
@overrides(CQHTTPEvent)
|
||||
def get_log_string(self) -> str:
|
||||
raise NoLogException
|
||||
|
||||
|
||||
class LifecycleMetaEvent(MetaEvent):
|
||||
meta_event_type: Literal["lifecycle"]
|
||||
|
||||
Reference in New Issue
Block a user