feat: 优化gateway, api, flags, http中的部分逻辑构建与冗余代码

feat: 优化gateway, api, flags, http中的部分逻辑构建与冗余代码

Author: traveler-vee

README.md

@@ -109,6 +109,7 @@ class MyClient(botpy.Client):
     ├── demo_at_reply.py             # 机器人at被动回复async示例
     ├── demo_at_reply_ark.py         # 机器人at被动回复ark消息示例
     ├── demo_at_reply_embed.py       # 机器人at被动回复embed消息示例
+    ├── demo_at_reply_command.py     # 机器人at被动使用Command指令装饰器回复消息示例
     ├── demo_at_reply_file_data.py   # 机器人at被动回复本地图片消息示例
     ├── demo_at_reply_keyboard.py    # 机器人at被动回复md带内嵌键盘的示例
     ├── demo_at_reply_markdown.py    # 机器人at被动回复md消息示例

README.rst

@@ -139,6 +139,7 @@ botpy
    ├── demo_at_reply.py             # 机器人at被动回复async示例
    ├── demo_at_reply_ark.py         # 机器人at被动回复ark消息示例
    ├── demo_at_reply_embed.py       # 机器人at被动回复embed消息示例
+   ├── demo_at_reply_command.py     # 机器人at被动使用Command指令装饰器回复消息示例
    ├── demo_at_reply_file_data.py   # 机器人at被动回复本地图片消息示例
    ├── demo_at_reply_keyboard.py    # 机器人at被动回复md带内嵌键盘的示例
    ├── demo_at_reply_markdown.py    # 机器人at被动回复md消息示例

botpy/api.py

@@ -3,7 +3,7 @@
 # 异步api
 
 from io import BufferedReader
-from typing import Any, List, Dict, Union, BinaryIO
+from typing import Any, List, Union, BinaryIO
 
 from .flags import Permission
 from .http import BotHttp, Route
@@ -23,24 +23,6 @@
 )
 
 
-def _handle_message_parameters(
-    content: str = None,
-    embed: message.Embed = None,
-    ark: message.Ark = None,
-    message_reference: message.Reference = None,
-    image: str = None,
-    file_image: Union[bytes, BinaryIO, str] = None,
-    msg_id: str = None,
-    event_id: str = None,
-    markdown: message.MarkdownPayload = None,
-    keyboard: message.Keyboard = None,
-) -> Dict:
-    payload = {}
-    params = locals()
-    payload.update({k: v for k, v in params.items() if v})
-    return payload
-
-
 class BotAPI:
     """
     机器人相关的API接口类
@@ -101,10 +83,8 @@ async def create_guild_role(self, guild_id: str, **fields: Any) -> guild.GuildRo
         Returns:
           class:GuildRole
         """
-        valid_keys = ("name", "color", "hoist")
-        payload = {k: v for k, v in fields.items() if k in valid_keys}
         route = Route("POST", "/guilds/{guild_id}/roles", guild_id=guild_id)
-        return await self._http.request(route, json=payload)
+        return await self._http.request(route, json=fields)
 
     async def update_guild_role(self, guild_id: str, role_id: str, **fields: Any) -> guild.GuildRole:
         """
@@ -122,10 +102,8 @@ async def update_guild_role(self, guild_id: str, role_id: str, **fields: Any) ->
         Returns:
           class:GuildRole
         """
-        valid_keys = ("name", "color", "hoist")
-        payload = {k: v for k, v in fields.items() if k in valid_keys}
         route = Route("PATCH", "/guilds/{guild_id}/roles/{role_id}", guild_id=guild_id, role_id=role_id)
-        return await self._http.request(route, json=payload)
+        return await self._http.request(route, json=fields)
 
     async def delete_guild_role(self, guild_id: str, role_id: str) -> str:
         """
@@ -160,9 +138,7 @@ async def create_guild_role_member(
         Returns:
           成功执行返回`None`。
         """
-        payload = {}
-        if channel_id:
-            payload = {"channel": {"id": channel_id}}
+        payload = {"channel": {"id": channel_id}}
 
         route = Route(
             "PUT",
@@ -187,9 +163,7 @@ async def delete_guild_role_member(self, guild_id: str, role_id: str, user_id: s
         Returns:
           成功执行返回`None`。
         """
-        payload = {}
-        if channel_id:
-            payload = {"channel": {"id": channel_id}}
+        payload = {"channel": {"id": channel_id}}
 
         route = Route(
             "DELETE",
@@ -234,12 +208,7 @@ async def get_guild_members(self, guild_id: str, after: str = "0", limit: int =
         Returns:
           user.Member 对象的列表。
         """
-        params: Dict[str, Any] = {}
-
-        if after is not None:
-            params["after"] = after
-        if limit is not None:
-            params["limit"] = limit
+        params = {"after": after, "limit": limit}
 
         route = Route(
             "GET",
@@ -346,10 +315,8 @@ async def update_channel(self, channel_id: str, **fields) -> channel.ChannelPayl
         Returns:Dict:
           channel.Channel
         """
-        valid_keys = ("name", "position", "parent_id", "private_type", "speak_permission")
-        payload = {k: v for k, v in fields.items() if k in valid_keys and v}
         route = Route("PATCH", "/channels/{channel_id}", channel_id=channel_id)
-        return await self._http.request(route, json=payload)
+        return await self._http.request(route, json=fields)
 
     async def delete_channel(self, channel_id: str) -> channel.ChannelPayload:
         """
@@ -396,11 +363,7 @@ async def update_channel_user_permissions(
         Returns:
           成功执行返回`None`。
         """
-        payload = {}
-        if add is not None:
-            payload.update({"add": str(add.value)})
-        if remove is not None:
-            payload.update({"remove": str(remove.value)})
+        payload = {"add": str(add.value) if add else None, "remove": str(remove.value) if remove else None}
 
         route = Route(
             "PUT", "/channels/{channel_id}/members/{user_id}/permissions", channel_id=channel_id, user_id=user_id
@@ -438,11 +401,7 @@ async def update_channel_role_permissions(
         Returns:
           成功执行返回`None`。
         """
-        payload = {}
-        if add is not None:
-            payload.update({"add": str(add.value)})
-        if remove is not None:
-            payload.update({"remove": str(remove.value)})
+        payload = {"add": str(add.value)  if add else None, "remove": str(remove.value)  if remove else None}
 
         route = Route(
             "PUT", "/channels/{channel_id}/roles/{role_id}/permissions", channel_id=channel_id, role_id=role_id
@@ -511,9 +470,9 @@ async def post_message(
         elif isinstance(file_image, str):
             with open(file_image, "rb") as img:
                 file_image = img.read()
-        payload = _handle_message_parameters(
-            content, embed, ark, message_reference, image, file_image, msg_id, event_id, markdown, keyboard
-        )
+        payload = locals()
+        payload.pop("self", None)
+        payload.pop("img", None)
         route = Route("POST", "/channels/{channel_id}/messages", channel_id=channel_id)
         return await self._http.request(route, json=payload)
 
@@ -533,7 +492,7 @@ async def recall_message(self, channel_id: str, message_id: str, hidetip: bool =
         Returns:
           成功执行返回`None`。
         """
-        params = {"hidetip": "true" if hidetip else "false"}
+        params = {"hidetip": str(hidetip).lower()}
 
         route = Route(
             "DELETE",
@@ -631,11 +590,11 @@ async def post_dms(
         elif isinstance(file_image, str):
             with open(file_image, "rb") as img:
                 file_image = img.read()
-        send_payload = _handle_message_parameters(
-            content, embed, ark, message_reference, image, file_image, msg_id, event_id, markdown, keyboard
-        )
+        payload = locals()
+        payload.pop("self", None)
+        payload.pop("img", None)
         route = Route("POST", "/dms/{guild_id}/messages", guild_id=guild_id)
-        return await self._http.request(route, json=send_payload)
+        return await self._http.request(route, json=payload)
 
     # 音频接口
     async def update_audio(self, channel_id: str, audio_control: audio.AudioControl) -> str:
@@ -714,9 +673,9 @@ async def me_guilds(self, guild_id: str = None, limit: int = 100, desc: bool = F
         """
         params = {"limit": limit}
         if desc and guild_id:
-            params.update({"before": guild_id})
+            params["before"] = guild_id
         elif guild_id:
-            params.update({"after": guild_id})
+            params["after"] = guild_id
 
         route = Route("GET", "/users/@me/guilds")
         return await self._http.request(route, params=params)
@@ -748,7 +707,10 @@ async def mute_all(self, guild_id: str, mute_end_timestamp: str = None, mute_sec
         Returns:
           成功执行返回`None`。
         """
-        payload = {k: v for k, v in locals().items() if k in ["mute_end_timestamp", "mute_seconds"] and v}
+        payload = {
+            "mute_end_timestamp": mute_end_timestamp,
+            "mute_seconds": mute_seconds
+        }
         route = Route("PATCH", "/guilds/{guild_id}/mute", guild_id=guild_id)
         return await self._http.request(route, json=payload)
 
@@ -787,7 +749,10 @@ async def mute_member(
         Returns:
           成功执行返回`None`。
         """
-        payload = {k: v for k, v in locals().items() if k in ["mute_end_timestamp", "mute_seconds"] and v}
+        payload = {
+            "mute_end_timestamp": mute_end_timestamp,
+            "mute_seconds": mute_seconds
+        }
         route = Route("PATCH", "/guilds/{guild_id}/members/{user_id}/mute", guild_id=guild_id, user_id=user_id)
         return await self._http.request(route, json=payload)
 
@@ -806,8 +771,11 @@ async def mute_multi_member(
         Returns:
           成功执行返回`None`。
         """
-        payload = {k: v for k, v in locals().items() if k in ["mute_end_timestamp", "mute_seconds"] and v}
-        payload.update({"user_ids": user_ids})
+        payload = {
+            "mute_end_timestamp": mute_end_timestamp,
+            "mute_seconds": mute_seconds,
+            "user_ids": user_ids
+        }
         route = Route("PATCH", "/guilds/{guild_id}/mute", guild_id=guild_id)
         return await self._http.request(route, json=payload)
 
@@ -938,9 +906,7 @@ async def get_schedules(self, channel_id: str, since: str = None) -> List[schedu
         Returns:
           列表[schedule.Schedule]
         """
-        payload = {}
-        if since:
-            payload = {"since": since}
+        payload = {"since": since}
         route = Route("GET", "/channels/{channel_id}/schedules", channel_id=channel_id)
         return await self._http.request(route, json=payload)
 
@@ -1147,10 +1113,8 @@ async def get_reaction_users(
             type=emoji_type,
             id=emoji_id,
         )
-        path = {"limit": limit}
-        if cookie:
-            path.update({"cookie": cookie})
-        return await self._http.request(route, params=path)
+        params = {"limit": limit, "cookie": cookie} if cookie else {"limit": limit}
+        return await self._http.request(route, params=params)
 
     # 精华消息API
     async def put_pin(self, channel_id: str, message_id: str) -> pins_message.PinsMessage:

botpy/flags.py

@@ -128,8 +128,7 @@ def __init__(self, **kwargs: bool) -> None:
     @classmethod
     def all(cls):
         """打开所有事件的监听"""
-        bits = max(cls.VALID_FLAGS.values()).bit_length()
-        value = (1 << bits) - 1
+        value = max(cls.VALID_FLAGS.values()) * 2 - 1
         self = cls.__new__(cls)
         self.value = value
         return self

botpy/gateway.py

@@ -4,8 +4,7 @@
 import traceback
 from typing import Optional
 
-import aiohttp
-from aiohttp import WSMessage, ClientWebSocketResponse, TCPConnector
+from aiohttp import WSMessage, ClientWebSocketResponse, TCPConnector, ClientSession, WSMsgType
 from ssl import SSLContext
 
 from . import logging
@@ -99,7 +98,7 @@ async def on_connected(self, ws: ClientWebSocketResponse):
         self._conn = ws
         if self._conn is None:
             raise Exception("[botpy] websocket连接失败")
-        if self._session["session_id"] != "":
+        if self._session["session_id"]:
             await self.ws_resume()
         else:
             await self.ws_identify()
@@ -111,28 +110,28 @@ async def ws_connect(self):
 
         _log.info("[botpy] 启动中...")
         ws_url = self._session["url"]
-        if ws_url == "":
+        if not ws_url:
             raise Exception("[botpy] 会话url为空")
 
         # adding SSLContext-containing connector to prevent SSL certificate verify failed error
-        async with aiohttp.ClientSession(connector=TCPConnector(limit=10, ssl=SSLContext())) as session:
+        async with ClientSession(connector=TCPConnector(limit=10, ssl=SSLContext())) as session:
             async with session.ws_connect(self._session["url"]) as ws_conn:
                 while True:
                     msg: WSMessage
                     msg = await ws_conn.receive()
-                    if msg.type == aiohttp.WSMsgType.TEXT:
+                    if msg.type == WSMsgType.TEXT:
                         await self.on_message(ws_conn, msg.data)
-                    elif msg.type == aiohttp.WSMsgType.ERROR:
+                    elif msg.type == WSMsgType.ERROR:
                         await self.on_error(ws_conn.exception())
-                    elif msg.type == aiohttp.WSMsgType.CLOSED or msg.type == aiohttp.WSMsgType.CLOSE:
+                    elif msg.type == WSMsgType.CLOSED or msg.type == WSMsgType.CLOSE:
                         await self.on_closed(ws_conn.close_code, msg.extra)
                     if ws_conn.closed:
                         _log.debug("[botpy] ws关闭, 停止接收消息!")
                         break
 
     async def ws_identify(self):
         """websocket鉴权"""
-        if self._session["intent"] == 0:
+        if not self._session["intent"]:
             self._session["intent"] = 1
 
         _log.info("[botpy] 鉴权中...")
@@ -230,5 +229,5 @@ async def _send_heart(self, interval):
                 _log.debug("[botpy] ws连接已关闭, 心跳检测停止，ws对象: %s" % self._conn)
                 return
 
-            await asyncio.sleep(interval)
             await self.send_msg(json.dumps(payload))
+            await asyncio.sleep(interval)