fix & feat: 修复重试本地图片报错&避免unclosed client session&增加私信图片attachments (#116)

* 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）

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

Author: GLGDLY

botpy/client.py

@@ -246,7 +246,7 @@ def ws_dispatch(self, event: str, *args: Any, **kwargs: Any) -> None:
 
         解析client类的on_event事件，进行对应的事件回调
         """
-        _log.info("[botpy] 调度事件: %s", event)
+        _log.debug("[botpy] 调度事件: %s", event)
         method = "on_" + event
 
         try:
@@ -265,7 +265,7 @@ def _schedule_event(
     ) -> asyncio.Task:
         wrapped = self._run_event(coro, event_name, *args, **kwargs)
         # Schedules the task
-        return self.loop.create_task(wrapped, name=f"botpy: {event_name}")
+        return self.loop.create_task(wrapped, name=f"[botpy] {event_name}")
 
     async def _run_event(
         self,

botpy/http.py

@@ -5,7 +5,7 @@
 from typing import Any, Optional, ClassVar, Union, Dict
 
 import aiohttp
-from aiohttp import ClientResponse, FormData, TCPConnector
+from aiohttp import ClientResponse, FormData, TCPConnector, multipart, hdrs, payload
 
 from . import logging
 from .errors import HttpErrorDict, ServerError
@@ -20,6 +20,44 @@
 HTTP_OK_STATUS = [200, 202, 204]
 
 
+class _FormData(FormData):
+    def _gen_form_data(self) -> multipart.MultipartWriter:
+        """Encode a list of fields using the multipart/form-data MIME format"""
+        if self._is_processed:
+            return self._writer   # rewrite this part of FormData object to enable retry of request
+        for dispparams, headers, value in self._fields:
+            try:
+                if hdrs.CONTENT_TYPE in headers:
+                    part = payload.get_payload(
+                        value,
+                        content_type=headers[hdrs.CONTENT_TYPE],
+                        headers=headers,
+                        encoding=self._charset,
+                    )
+                else:
+                    part = payload.get_payload(
+                        value, headers=headers, encoding=self._charset
+                    )
+            except Exception as exc:
+                print(value)
+                raise TypeError(
+                    "Can not serialize value type: %r\n "
+                    "headers: %r\n value: %r" % (type(value), headers, value)
+                ) from exc
+
+            if dispparams:
+                part.set_content_disposition(
+                    "form-data", quote_fields=self._quote_fields, **dispparams
+                )
+                assert part.headers is not None
+                part.headers.popall(hdrs.CONTENT_LENGTH, None)
+
+            self._writer.append_payload(part)
+
+        self._is_processed = True
+        return self._writer
+
+
 async def _handle_response(response: ClientResponse) -> Union[Dict[str, Any], str]:
     url = response.request_info.url
     try:
@@ -41,8 +79,8 @@ async def _handle_response(response: ClientResponse) -> Union[Dict[str, Any], st
         # type of data should be dict or str or None, so there should be a condition to check and prevent bug
         message = data["message"] if isinstance(data, dict) else str(data)
         if not error_dict_get:
-            raise ServerError(message)
-        raise error_dict_get(msg=message)
+            raise ServerError(message) from None  # adding from None to prevent chain exception being raised
+        raise error_dict_get(msg=message) from None
 
 
 class Route:
@@ -91,8 +129,13 @@ def __init__(
         self._global_over: Optional[asyncio.Event] = None
         self._headers: Optional[dict] = None
 
+    def __del__(self):
+        if self._session and not self._session.closed:
+            _loop = asyncio.get_event_loop()
+            _loop.create_task(self._session.close())
+
     async def close(self) -> None:
-        if self._session:
+        if self._session and not self._session.closed:
             await self._session.close()
 
     async def check_session(self):
@@ -104,7 +147,7 @@ async def check_session(self):
 
         if not self._session or self._session.closed:
             self._session = aiohttp.ClientSession(
-                headers=self._headers, connector=TCPConnector(limit=500, ssl=SSLContext())
+                headers=self._headers, connector=TCPConnector(limit=500, ssl=SSLContext(), force_close=True)
             )
 
     async def request(self, route: Route, retry_time: int = 0, **kwargs: Any):
@@ -115,7 +158,7 @@ async def request(self, route: Route, retry_time: int = 0, **kwargs: Any):
             json_ = kwargs["json"]
             json__get = json_.get("file_image")
             if json__get and isinstance(json__get, bytes):
-                kwargs["data"] = FormData()
+                kwargs["data"] = _FormData()
                 for k, v in kwargs.pop("json").items():
                     if v:
                         if isinstance(v, dict):
@@ -142,10 +185,9 @@ async def request(self, route: Route, retry_time: int = 0, **kwargs: Any):
                 _log.debug(response)
                 return await _handle_response(response)
         except asyncio.TimeoutError:
-            _log.debug("session timeout retry")
-            self._session = aiohttp.ClientSession(
-                headers=self._headers, connector=TCPConnector(limit=500, ssl=SSLContext())
-            )
+            _log.warning(f"请求超时，请求连接: {route.url}")
+        except ConnectionResetError:
+            _log.debug("session connection broken retry")
             await self.request(route, retry_time + 1, **kwargs)
 
     async def login(self, token: Token) -> robot.Robot:

botpy/message.py

@@ -95,6 +95,7 @@ class DirectMessage:
         "guild_id",
         "member",
         "message_reference",
+        "attachments",
         "seq",
         "seq_in_channel",
         "src_guild_id",
@@ -113,6 +114,7 @@ def __init__(self, api: BotAPI, event_id, data: gateway.DirectMessagePayload):
         self.guild_id = data.get("guild_id", None)
         self.member = self._Member(data.get("member", {}))
         self.message_reference = self._MessageRef(data.get("message_reference", {}))
+        self.attachments = [self._Attachments(items) for items in data.get("attachments", {})]
         self.seq = data.get("seq", None)  # 全局消息序号
         self.seq_in_channel = data.get("seq_in_channel", None)  # 子频道消息序号
         self.src_guild_id = data.get("src_guild_id", None)
@@ -145,6 +147,19 @@ def __init__(self, data):
         def __repr__(self):
             return str(self.__dict__)
 
+    class _Attachments:
+        def __init__(self, data):
+            self.content_type = data.get("content_type", None)
+            self.filename = data.get("filename", None)
+            self.height = data.get("height", None)
+            self.width = data.get("width", None)
+            self.id = data.get("id", None)
+            self.size = data.get("size", None)
+            self.url = data.get("url", None)
+
+        def __repr__(self):
+            return str(self.__dict__)
+
     async def reply(self, **kwargs):
         return await self._api.post_dms(guild_id=self.guild_id, msg_id=self.id, **kwargs)
 

botpy/types/gateway.py

@@ -64,6 +64,7 @@ class DirectMessagePayload(TypedDict):
     id: str
     member: Member
     message_reference: MessageRefPayload
+    attachments: List[MessageAttachPayload]
     seq: int
     seq_in_channel: str
     src_guild_id: str