💬 💡 rename some dataclass, add comments for events in mirai adapter

nonebot/adapters/mirai/event/notice.py

@@ -2,61 +2,74 @@ from typing import Any, Optional
 
 from pydantic import Field
 
-from .base import Event, SenderGroup, SenderInfo, SenderPermission
+from .base import Event, GroupChatInfo, GroupInfo, UserPermission
 
 
 class NoticeEvent(Event):
+    """通知事件基类"""
     pass
 
 
 class MuteEvent(NoticeEvent):
-    operator: SenderInfo
+    """禁言类事件基类"""
+    operator: GroupChatInfo
 
 
 class BotMuteEvent(MuteEvent):
+    """Bot被禁言"""
     pass
 
 
 class BotUnmuteEvent(MuteEvent):
+    """Bot被取消禁言"""
     pass
 
 
 class MemberMuteEvent(MuteEvent):
+    """群成员被禁言事件（该成员不是Bot）"""
     duration_seconds: int = Field(alias='durationSeconds')
-    member: SenderInfo
-    operator: Optional[SenderInfo] = None
+    member: GroupChatInfo
+    operator: Optional[GroupChatInfo] = None
 
 
 class MemberUnmuteEvent(MuteEvent):
-    member: SenderInfo
-    operator: Optional[SenderInfo] = None
+    """群成员被取消禁言事件（该成员不是Bot）"""
+    member: GroupChatInfo
+    operator: Optional[GroupChatInfo] = None
 
 
 class BotJoinGroupEvent(NoticeEvent):
-    group: SenderGroup
+    """Bot加入了一个新群"""
+    group: GroupInfo
 
 
 class BotLeaveEventActive(BotJoinGroupEvent):
+    """Bot主动退出一个群"""
     pass
 
 
 class BotLeaveEventKick(BotJoinGroupEvent):
+    """Bot被踢出一个群"""
     pass
 
 
 class MemberJoinEvent(NoticeEvent):
-    member: SenderInfo
-
-
-class MemberLeaveEventQuit(MemberJoinEvent):
-    pass
+    """新人入群的事件"""
+    member: GroupChatInfo
 
 
 class MemberLeaveEventKick(MemberJoinEvent):
-    operator: Optional[SenderInfo] = None
+    """成员被踢出群（该成员不是Bot）"""
+    operator: Optional[GroupChatInfo] = None
+
+
+class MemberLeaveEventQuit(MemberJoinEvent):
+    """成员主动离群（该成员不是Bot）"""
+    pass
 
 
 class FriendRecallEvent(NoticeEvent):
+    """好友消息撤回"""
     author_id: int = Field(alias='authorId')
     message_id: int = Field(alias='messageId')
     time: int
@@ -64,67 +77,80 @@ class FriendRecallEvent(NoticeEvent):
 
 
 class GroupRecallEvent(FriendRecallEvent):
-    group: SenderGroup
-    operator: Optional[SenderInfo] = None
+    """群消息撤回"""
+    group: GroupInfo
+    operator: Optional[GroupChatInfo] = None
 
 
 class GroupStateChangeEvent(NoticeEvent):
+    """群变化事件基类"""
     origin: Any
     current: Any
-    group: SenderGroup
-    operator: Optional[SenderInfo] = None
+    group: GroupInfo
+    operator: Optional[GroupChatInfo] = None
 
 
 class GroupNameChangeEvent(GroupStateChangeEvent):
+    """某个群名改变"""
     origin: str
     current: str
 
 
 class GroupEntranceAnnouncementChangeEvent(GroupStateChangeEvent):
+    """某群入群公告改变"""
     origin: str
     current: str
 
 
 class GroupMuteAllEvent(GroupStateChangeEvent):
+    """全员禁言"""
     origin: bool
     current: bool
 
 
 class GroupAllowAnonymousChatEvent(GroupStateChangeEvent):
+    """匿名聊天"""
     origin: bool
     current: bool
 
 
 class GroupAllowConfessTalkEvent(GroupStateChangeEvent):
+    """坦白说"""
     origin: bool
     current: bool
 
 
 class GroupAllowMemberInviteEvent(GroupStateChangeEvent):
+    """允许群员邀请好友加群"""
     origin: bool
     current: bool
 
 
 class MemberStateChangeEvent(NoticeEvent):
-    member: SenderInfo
-    operator: Optional[SenderInfo] = None
+    """群成员变化事件基类"""
+    member: GroupChatInfo
+    operator: Optional[GroupChatInfo] = None
 
 
 class MemberCardChangeEvent(MemberStateChangeEvent):
+    """群名片改动"""
     origin: str
     current: str
 
 
 class MemberSpecialTitleChangeEvent(MemberStateChangeEvent):
+    """群头衔改动（只有群主有操作限权）"""
     origin: str
     current: str
 
 
 class BotGroupPermissionChangeEvent(MemberStateChangeEvent):
-    origin: SenderPermission
-    current: SenderPermission
+    """Bot在群里的权限被改变"""
+    origin: UserPermission
+    current: UserPermission
 
 
 class MemberPermissionChangeEvent(MemberStateChangeEvent):
-    origin: SenderPermission
-    current: SenderPermission
+    """成员权限改变的事件（该成员不是Bot）"""
+    origin: UserPermission
+    current: UserPermission