feat: 新增开放论坛事件和进出音视频/直播子频道事件的数据构建以及补充相关示例和文档说明 (#122)

* refactor: 优化上次更新中，http的双重not问题
feat: 新增用户可直接通过print或log获取dict类型的事件结构

* fix: 修复DirectMessage中reply参数错误

* feat: 加入__del__控制aiohttp出现unclosed client session的问题

* feat: 调度事件日志等级调整

* fix: 重写FormData的_gen_form_data方法，以避免重试时由于已process过一次而导致的Form data has been processed already错误

* feat: 为BotHttp增加__del__方法避免出现unclosed client session的问题

* feat: ...补充

* fix: 修复RuntimeWarning问题

* fix: 改善already running的问题

* fix: 进一步改善unclosed client session的问题

* fix: http重新设置client session时调用close

* fix: 优化Cannot write to closing transport

* feat: 私信加入attachments字段

* fix: http去除超时重试，避免出现多次请求（特指因为重试而连续发送相同消息）的问题
fix: http的_handle_response中raise加入from None避免出现重试下的连锁错误（During handling of the above exception, another exception occurred）

* feat: 新增403状态码ForbiddenError

* feat: 新增开放论坛事件和进出音视频/直播子频道事件的数据构建以及补充相关示例和文档说明

Co-authored-by: GLGDLY <[email protected]>
Co-authored-by: GLGDLY <[email protected]>

Author: SaucePlum

botpy/audio.py

@@ -23,3 +23,23 @@ def __init__(self, api: BotAPI, event_id, data: audio.AudioAction):
 
     def __repr__(self):
         return str({items: str(getattr(self, items)) for items in self.__slots__ if not items.startswith('_')})
+
+
+class PublicAudio:
+    __slots__ = (
+        "_api",
+        "_ctx",
+        "guild_id",
+        "channel_id",
+        "channel_type",
+        "user_id")
+
+    def __init__(self, api: BotAPI, data: audio.AudioLive):
+        self._api = api
+        self.guild_id = data.get("guild_id", None)
+        self.channel_id = data.get("channel_id", None)
+        self.channel_type = data.get("channel_type", None)
+        self.user_id = data.get("user_id", None)
+
+    def __repr__(self):
+        return str({items: str(getattr(self, items)) for items in self.__slots__ if not items.startswith('_')})

botpy/connection.py

@@ -8,8 +8,8 @@
 from .message import Message, DirectMessage, MessageAudit
 from .user import Member
 from .reaction import Reaction
-from .audio import Audio
-from .forum import Thread
+from .audio import Audio, PublicAudio
+from .forum import Thread, OpenThread
 
 from . import logging
 from .api import BotAPI
@@ -227,3 +227,39 @@ def parse_forum_reply_delete(self, payload):
 
     def parse_forum_publish_audit_result(self, payload):
         self._dispatch("forum_publish_audit_result", payload.get('d', {}))
+
+    def parse_audio_or_live_channel_member_enter(self, payload):
+        _public_audio = PublicAudio(self.api, payload.get('d', {}))
+        self._dispatch("audio_or_live_channel_member_enter", _public_audio)
+
+    def parse_audio_or_live_channel_member_exit(self, payload):
+        _public_audio = PublicAudio(self.api, payload.get('d', {}))
+        self._dispatch("audio_or_live_channel_member_exit", _public_audio)
+
+    def parse_open_forum_thread_create(self, payload):
+        _forum = OpenThread(self.api, payload.get('d', {}))
+        self._dispatch("open_forum_thread_create", _forum)
+
+    def parse_open_forum_thread_update(self, payload):
+        _forum = OpenThread(self.api, payload.get('d', {}))
+        self._dispatch("open_forum_thread_update", _forum)
+
+    def parse_open_forum_thread_delete(self, payload):
+        _forum = OpenThread(self.api, payload.get('d', {}))
+        self._dispatch("open_forum_thread_delete", _forum)
+
+    def parse_open_forum_post_create(self, payload):
+        _forum = OpenThread(self.api, payload.get('d', {}))
+        self._dispatch("open_forum_post_create", payload.get('d', {}))
+
+    def parse_open_forum_post_delete(self, payload):
+        _forum = OpenThread(self.api, payload.get('d', {}))
+        self._dispatch("open_forum_post_delete", payload.get('d', {}))
+
+    def parse_open_forum_reply_create(self, payload):
+        _forum = OpenThread(self.api, payload.get('d', {}))
+        self._dispatch("open_forum_reply_create", payload.get('d', {}))
+
+    def parse_open_forum_reply_delete(self, payload):
+        _forum = OpenThread(self.api, payload.get('d', {}))
+        self._dispatch("open_forum_reply_delete", payload.get('d', {}))

botpy/errors.py

@@ -41,10 +41,19 @@ def __str__(self):
         return self.msgs
 
 
+class ForbiddenError(RuntimeError):
+    def __init__(self, msg):
+        self.msgs = msg
+
+    def __str__(self):
+        return self.msgs
+
+
 HttpErrorDict = {
     401: AuthenticationFailedError,
     404: NotFoundError,
     405: MethodNotAllowedError,
+    403: ForbiddenError,
     429: SequenceNumberError,
     500: ServerError,
     504: ServerError,

botpy/flags.py

@@ -284,6 +284,36 @@ def public_guild_messages(self):
         """
         return 1 << 30
 
+    @Flag
+    def audio_or_live_channel_member(self):
+        """:class:`bool`: 是否打开音视频/直播子频道成员进出事件的监听.
+
+        通过增加`client`的`on_xx`事件可以获取事件下发的数据:
+
+        - :func:`on_audio_or_live_channel_enter`            // 用户进入音视频/直播子频道时
+        - :func:`on_audio_or_live_channel_exit`        // 用户退出音视频/直播子频道时
+
+        """
+        return 1 << 19
+
+    @Flag
+    def open_forum_event(self):
+        """:class:`bool`: 开放论坛对象事件的监听.
+
+        通过增加`client`的`on_xx`事件可以获取事件下发的数据:
+
+
+        - :func:`on_open_forum_thread_create`            // 用户创建主题时
+        - :func:`on_open_forum_thread_update`            // 用户修改主题时
+        - :func:`on_open_forum_thread_delete`            // 用户删除主题时
+        - :func:`on_open_forum_post_create`            // 用户创建帖子时
+        - :func:`on_open_forum_post_delete`            // 用户删除帖子时
+        - :func:`on_open_forum_reply_create`            // 用户回复评论时
+        - :func:`on_open_forum_reply_delete`            // 用户删除评论时
+
+        """
+        return 1 << 18
+
 
 @fill_with_flags()
 class Permission(BaseFlags):

botpy/forum.py

@@ -150,3 +150,23 @@ def __init__(self, data):
 
                     def __repr__(self):
                         return str(self.__dict__)
+
+
+class OpenThread:
+    __slots__ = (
+        "_api",
+        "thread_info",
+        "channel_id",
+        "guild_id",
+        "author_id",
+        "event_id")
+
+    def __init__(self, api: BotAPI, data: forum.OpenForumEvent):
+        self._api = api
+
+        self.guild_id = data.get("guild_id", None)
+        self.channel_id = data.get("channel_id", None)
+        self.author_id = data.get("author_id", None)
+
+    def __repr__(self):
+        return str({items: str(getattr(self, items)) for items in self.__slots__ if not items.startswith('_')})

botpy/http.py

@@ -201,4 +201,4 @@ async def login(self, token: Token) -> robot.Robot:
         data = await self.request(Route("GET", "/users/@me"))
         # TODO 检查机器人token错误的raise exception @veehou
 
-        return data
+        return data

botpy/types/audio.py

@@ -10,6 +10,7 @@
 """
 AudioStatus = Literal[0, 1, 2, 3]
 
+PublicAudioType = Literal[2, 5]
 
 class AudioControl(TypedDict):
     audio_url: str
@@ -22,3 +23,10 @@ class AudioAction(TypedDict):
     channel_id: str
     audio_url: str
     text: str
+
+
+class AudioLive(TypedDict):
+    guild_id: str
+    channel_id: str
+    channel_type: PublicAudioType
+    user_id: str

botpy/types/forum.py

@@ -69,3 +69,7 @@ class PostThreadRsp(TypedDict):
     task_id: str
     create_time: str
 
+class OpenForumEvent(TypedDict):
+    guild_id: str
+    channel_id: str
+    author_id: str