feat & refactor: 重构事件并优化http debug log的url反馈 (#108)

* feat: 完善ws事件中Message数据的构建

* feat: 完善ws事件中User-Member数据的构建

* feat: 完善ws事件中Reaction、Audio、DirectMessage 以及 Forum（Thread类）数据的构建
feat: 去除EmbedField的value项（实际仅有name）

* feat: 完善ws事件中监听文档并优化格式
refactor: 优化forum thread的事件数据名称

* fix: forum thread的事件数据名称更变后同步数据更改到其他文件

* refactor: 优化ext下的扩展工具

* refactor: 优化ext的convert_color模块

* refactor: 优化ext下的扩展工具

* refactor: 优化ext下的扩展工具

* docs: 修改一处表述不正确的地方

* feat: 修改一处表述不正确的地方

* fix: 帖子api中route方式错误的问题

* feat: 补齐频道成员中的删除频道成员api

* feat: 更新文档并新增定时框架

* fix: 修复Member构建的部分字段取值错误的问题

* docs: 更新botpy文档

* fix: 修复删除频道成员API无法拉黑的问题

* fix: rst文件回滚

* feat: 为http请求成功添加trace_id

* feat: http总_handle_response修改原来的route.url到真实请求url
refactor: 重构事件的部分建构方式，优化部分拓展性问题
refactor: 为所有事件子参数新增默认值，避免将来数据更变下可能出现bug

* fix: 修改单元测试报错的问题

* feat: Message事件新增兼容attachments字段

* feat: 补充member字段的guild_id字段

* refactor: parser中的kwargs改为payload

* fix: 修复issue #109 中FormData报TypeError错误的问题

* feat: 去除不必要的包

Co-authored-by: 小念同学 <[email protected]>
Co-authored-by: veehou <[email protected]>

Author: 3 people

botpy/audio.py

@@ -1,5 +1,5 @@
 from .api import BotAPI
-from .types import gateway, audio
+from .types import audio
 
 
 class Audio:
@@ -12,11 +12,11 @@ class Audio:
         "text",
         "event_id")
 
-    def __init__(self, api: BotAPI, ctx: gateway.WsContext, data: audio.AudioAction):
+    def __init__(self, api: BotAPI, event_id, data: audio.AudioAction):
         self._api = api
 
-        self.channel_id = data.get("channel_id")
-        self.guild_id = data.get("guild_id")
-        self.audio_url = data.get("audio_url")
-        self.text = data.get("text")
-        self.event_id = ctx.get("id")
+        self.channel_id = data.get("channel_id", None)
+        self.guild_id = data.get("guild_id", None)
+        self.audio_url = data.get("audio_url", None)
+        self.text = data.get("text", None)
+        self.event_id = event_id

botpy/channel.py

@@ -1,5 +1,5 @@
 from .api import BotAPI
-from .types import channel, gateway
+from .types import channel
 
 
 class Channel:
@@ -19,17 +19,17 @@ class Channel:
         "event_id",
     )
 
-    def __init__(self, api: BotAPI, ctx: gateway.WsContext, data: channel.ChannelPayload):
+    def __init__(self, api: BotAPI, event_id, data: channel.ChannelPayload):
         self._api = api
 
-        self.id = data.get("id")
-        self.name = data.get("name")
-        self.type = data.get("type")
-        self.sub_type = data.get("sub_type")
-        self.position = data.get("position")
-        self.owner_id = data.get("owner_id")
-        self.private_type = data.get("private_type")
-        self.speak_permission = data.get("speak_permission")
-        self.application_id = data.get("application_id")
-        self.permissions = data.get("permissions")
-        self.event_id = ctx.get("id")
+        self.id = data.get("id", None)
+        self.name = data.get("name", None)
+        self.type = data.get("type", None)
+        self.sub_type = data.get("sub_type", None)
+        self.position = data.get("position", None)
+        self.owner_id = data.get("owner_id", None)
+        self.private_type = data.get("private_type", None)
+        self.speak_permission = data.get("speak_permission", None)
+        self.application_id = data.get("application_id", None)
+        self.permissions = data.get("permissions", None)
+        self.event_id = event_id

botpy/connection.py

@@ -14,7 +14,7 @@
 from . import logging
 from .api import BotAPI
 from .robot import Robot
-from .types import gateway, channel, guild, user, session, reaction, interaction, forum
+from .types import session
 
 _log = logging.get_logger()
 
@@ -36,7 +36,7 @@ def __init__(
     ):
         self.dispatch = dispatch
         self.state = ConnectionState(dispatch, api)
-        self.parser: Dict[str, Callable[[gateway.WsContext, Any], None]] = self.state.parsers
+        self.parser: Dict[str, Callable[[dict], None]] = self.state.parsers
 
         self._connect = connect
         self._max_async = max_async
@@ -89,141 +89,141 @@ def __init__(self, dispatch: Callable, api: BotAPI):
         self._dispatch = dispatch
         self.api = api
 
-    def parse_ready(self, ctx: gateway.WsContext, data: gateway.ReadyEvent):
+    def parse_ready(self, payload):
         self._dispatch("ready")
 
-    def parse_resumed(self, ctx: gateway.WsContext, data: gateway.ReadyEvent):
+    def parse_resumed(self, payload):
         self._dispatch("resumed")
 
     # botpy.flags.Intents.guilds
-    def parse_guild_create(self, ctx: gateway.WsContext, data: guild.GuildPayload):
-        _guild = Guild(self.api, ctx, data)
+    def parse_guild_create(self, payload):
+        _guild = Guild(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("guild_create", _guild)
 
-    def parse_guild_update(self, ctx: gateway.WsContext, data: guild.GuildPayload):
-        _guild = Guild(self.api, ctx, data)
+    def parse_guild_update(self, payload):
+        _guild = Guild(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("guild_update", _guild)
 
-    def parse_guild_delete(self, ctx: gateway.WsContext, data: guild.GuildPayload):
-        _guild = Guild(self.api, ctx, data)
+    def parse_guild_delete(self, payload):
+        _guild = Guild(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("guild_delete", _guild)
 
-    def parse_channel_create(self, ctx: gateway.WsContext, data: channel.ChannelPayload):
-        _channel = Channel(self.api, ctx, data)
+    def parse_channel_create(self, payload):
+        _channel = Channel(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("channel_create", _channel)
 
-    def parse_channel_update(self, ctx: gateway.WsContext, data: channel.ChannelPayload):
-        _channel = Channel(self.api, ctx, data)
+    def parse_channel_update(self, payload):
+        _channel = Channel(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("channel_update", _channel)
 
-    def parse_channel_delete(self, ctx: gateway.WsContext, data: channel.ChannelPayload):
-        _channel = Channel(self.api, ctx, data)
+    def parse_channel_delete(self, payload):
+        _channel = Channel(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("channel_delete", _channel)
 
     # botpy.flags.Intents.guild_members
-    def parse_guild_member_add(self, ctx: gateway.WsContext, data: user.GuildMemberPayload):
-        _member = Member(self.api, ctx, data)
+    def parse_guild_member_add(self, payload):
+        _member = Member(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("guild_member_add", _member)
 
-    def parse_guild_member_update(self, ctx: gateway.WsContext, data: user.GuildMemberPayload):
-        _member = Member(self.api, ctx, data)
+    def parse_guild_member_update(self, payload):
+        _member = Member(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("guild_member_update", _member)
 
-    def parse_guild_member_remove(self, ctx: gateway.WsContext, data: user.GuildMemberPayload):
-        _member = Member(self.api, ctx, data)
+    def parse_guild_member_remove(self, payload):
+        _member = Member(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("guild_member_remove", _member)
 
     # botpy.flags.Intents.guild_messages
-    def parse_message_create(self, ctx: gateway.WsContext, data: gateway.MessagePayload):
-        _message = Message(self.api, ctx, data)
+    def parse_message_create(self, payload):
+        _message = Message(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("message_create", _message)
 
-    def parse_message_delete(self, ctx: gateway.WsContext, data: gateway.MessagePayload):
-        _message = Message(self.api, ctx, data)
+    def parse_message_delete(self, payload):
+        _message = Message(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("message_delete", _message)
 
     # botpy.flags.Intents.guild_message_reactions
-    def parse_message_reaction_add(self, ctx: gateway.WsContext, data: reaction.Reaction):
-        _reaction = Reaction(self.api, ctx, data)
+    def parse_message_reaction_add(self, payload):
+        _reaction = Reaction(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("message_reaction_add", _reaction)
 
-    def parse_message_reaction_remove(self, ctx: gateway.WsContext, data: reaction.Reaction):
-        _reaction = Reaction(self.api, ctx, data)
+    def parse_message_reaction_remove(self, payload):
+        _reaction = Reaction(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("message_reaction_remove", _reaction)
 
     # botpy.flags.Intents.direct_message
-    def parse_direct_message_create(self, ctx: gateway.WsContext, data: gateway.DirectMessagePayload):
-        _message = DirectMessage(self.api, ctx, data)
+    def parse_direct_message_create(self, payload):
+        _message = DirectMessage(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("direct_message_create", _message)
 
-    def parse_direct_message_delete(self, ctx: gateway.WsContext, data: gateway.DirectMessagePayload):
-        _message = DirectMessage(self.api, ctx, data)
+    def parse_direct_message_delete(self, payload):
+        _message = DirectMessage(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("direct_message_delete", _message)
 
     # botpy.flags.Intents.interaction
-    def parse_interaction_create(self, ctx: gateway.WsContext, data: interaction.InteractionPayload):
-        _interaction = Interaction(self.api, ctx, data)
+    def parse_interaction_create(self, payload):
+        _interaction = Interaction(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("interaction_create", _interaction)
 
     # botpy.flags.Intents.message_audit
-    def parse_message_audit_pass(self, ctx: gateway.WsContext, data: gateway.MessageAuditPayload):
-        _message_audit = MessageAudit(self.api, ctx, data)
+    def parse_message_audit_pass(self, payload):
+        _message_audit = MessageAudit(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("message_audit_pass", _message_audit)
 
-    def parse_message_audit_reject(self, ctx: gateway.WsContext, data: gateway.MessageAuditPayload):
-        _message_audit = MessageAudit(self.api, ctx, data)
+    def parse_message_audit_reject(self, payload):
+        _message_audit = MessageAudit(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("message_audit_reject", _message_audit)
 
     # botpy.flags.Intents.audio_action
-    def parse_audio_start(self, ctx: gateway.WsContext, data):
-        _audio = Audio(self.api, ctx, data)
+    def parse_audio_start(self, payload):
+        _audio = Audio(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("audio_start", _audio)
 
-    def parse_audio_finish(self, ctx: gateway.WsContext, data):
-        _audio = Audio(self.api, ctx, data)
+    def parse_audio_finish(self, payload):
+        _audio = Audio(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("audio_finish", _audio)
 
-    def parse_on_mic(self, ctx: gateway.WsContext, data):
-        _audio = Audio(self.api, ctx, data)
+    def parse_on_mic(self, payload):
+        _audio = Audio(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("on_mic", _audio)
 
-    def parse_off_mic(self, ctx: gateway.WsContext, data):
-        _audio = Audio(self.api, ctx, data)
+    def parse_off_mic(self, payload):
+        _audio = Audio(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("off_mic", _audio)
 
     # botpy.flags.Intents.public_guild_messages
-    def parse_at_message_create(self, ctx: gateway.WsContext, data: gateway.MessagePayload):
-        _message = Message(self.api, ctx, data)
+    def parse_at_message_create(self, payload):
+        _message = Message(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("at_message_create", _message)
 
-    def parse_public_message_delete(self, ctx: gateway.WsContext, data: gateway.MessagePayload):
-        _message = Message(self.api, ctx, data)
+    def parse_public_message_delete(self, payload):
+        _message = Message(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("public_message_delete", _message)
 
     # botpy.flags.Intents.forums
-    def parse_forum_thread_create(self, ctx: gateway.WsContext, data: forum.Thread):
-        _forum = Thread(self.api, ctx, data)
+    def parse_forum_thread_create(self, payload):
+        _forum = Thread(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("forum_thread_create", _forum)
 
-    def parse_forum_thread_update(self, ctx: gateway.WsContext, data: forum.Thread):
-        _forum = Thread(self.api, ctx, data)
+    def parse_forum_thread_update(self, payload):
+        _forum = Thread(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("forum_thread_update", _forum)
 
-    def parse_forum_thread_delete(self, ctx: gateway.WsContext, data: forum.Thread):
-        _forum = Thread(self.api, ctx, data)
+    def parse_forum_thread_delete(self, payload):
+        _forum = Thread(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("forum_thread_delete", _forum)
 
-    def parse_forum_post_create(self, ctx: gateway.WsContext, data: forum.Post):
-        self._dispatch("forum_post_create", data)
+    def parse_forum_post_create(self, payload):
+        self._dispatch("forum_post_create", payload.get('d', {}))
 
-    def parse_forum_post_delete(self, ctx: gateway.WsContext, data: forum.Post):
-        self._dispatch("forum_post_delete", data)
+    def parse_forum_post_delete(self, payload):
+        self._dispatch("forum_post_delete", payload.get('d', {}))
 
-    def parse_forum_reply_create(self, ctx: gateway.WsContext, data: forum.Reply):
-        self._dispatch("forum_reply_create", data)
+    def parse_forum_reply_create(self, payload):
+        self._dispatch("forum_reply_create", payload.get('d', {}))
 
-    def parse_forum_reply_delete(self, ctx: gateway.WsContext, data: forum.Reply):
-        self._dispatch("forum_reply_delete", data)
+    def parse_forum_reply_delete(self, payload):
+        self._dispatch("forum_reply_delete", payload.get('d', {}))
 
-    def parse_forum_publish_audit_result(self, ctx: gateway.WsContext, data: forum.AuditResult):
-        self._dispatch("forum_publish_audit_result", data)
+    def parse_forum_publish_audit_result(self, payload):
+        self._dispatch("forum_publish_audit_result", payload.get('d', {}))

botpy/forum.py

@@ -1,7 +1,7 @@
 from json import loads
 
 from .api import BotAPI
-from .types import gateway, forum
+from .types import forum
 
 
 class _Text:
@@ -56,48 +56,48 @@ class Thread:
         "author_id",
         "event_id")
 
-    def __init__(self, api: BotAPI, ctx: gateway.WsContext, data: forum.Thread):
+    def __init__(self, api: BotAPI, event_id, data: forum.Thread):
         self._api = api
 
-        self.author_id = data.get("author_id")
-        self.channel_id = data.get("channel_id")
-        self.guild_id = data.get("guild_id")
-        self.thread_info = self._ThreadInfo(data.get("thread_info"))
-        self.event_id = ctx.get("id")
+        self.author_id = data.get("author_id", None)
+        self.channel_id = data.get("channel_id", None)
+        self.guild_id = data.get("guild_id", None)
+        self.thread_info = self._ThreadInfo(data.get("thread_info", {}))
+        self.event_id = event_id
 
     class _ThreadInfo:
         def __init__(self, data):
-            self.title = self._Title(loads(data.get("title")))
-            self.content = self._Content(loads(data.get("content")))
-            self.thread_id = data.get("thread_id")
-            self.date_time = data.get("date_time")
+            self.title = self._Title(loads(data.get("title", {})))
+            self.content = self._Content(loads(data.get("content", {})))
+            self.thread_id = data.get("thread_id", None)
+            self.date_time = data.get("date_time", None)
 
         class _Title:
             def __init__(self, data):
-                self.paragraphs = [self._Paragraphs(items) for items in data.get("paragraphs")]
+                self.paragraphs = [self._Paragraphs(items) for items in data.get("paragraphs", {})]
 
             class _Paragraphs:
                 def __init__(self, data):
-                    self.elems = [self._Elems(items) for items in data.get("elems")]
-                    self.props = data.get("props")
+                    self.elems = [self._Elems(items) for items in data.get("elems", {})]
+                    self.props = data.get("props", None)
 
                 class _Elems:
                     def __init__(self, data):
-                        self.type = data.get("type")
+                        self.type = data.get("type", None)
                         self.text = _Text(data.get("text", {}))
 
         class _Content:
             def __init__(self, data):
-                self.paragraphs = [self._Paragraphs(items) for items in data.get("paragraphs")]
+                self.paragraphs = [self._Paragraphs(items) for items in data.get("paragraphs", {})]
 
             class _Paragraphs:
                 def __init__(self, data):
-                    self.elems = [self._Elems(items) for items in data.get("elems")]
-                    self.props = data.get("props")
+                    self.elems = [self._Elems(items) for items in data.get("elems", {})]
+                    self.props = data.get("props", None)
 
                 class _Elems:
                     def __init__(self, data):
-                        self.type = data.get("type")
+                        self.type = data.get("type", None)
                         if self.type == 1:
                             self.text = _Text(data.get("text", {}))
                         elif self.type == 2:

botpy/gateway.py

@@ -91,8 +91,7 @@ async def on_message(self, ws, message):
             except KeyError:
                 _log.error("_parser unknown event %s.", event)
             else:
-                ctx = gateway.WsContext(id=msg.get("id", ""))
-                func(ctx, msg.get("d"))
+                func(msg)
 
     async def on_connected(self, ws: ClientWebSocketResponse):
         self._conn = ws