Merge pull request #1270 from interactions-py/unstable

chore: Merge unstable to stable.

Author: FayeDel

.pre-commit-config.yaml

@@ -29,7 +29,7 @@ repos:
     - id: check-merge-conflict
       name: Merge Conflicts
   - repo: https://github.com/psf/black
-    rev: 22.12.0
+    rev: 23.1.0
     hooks:
     - id: black
       name: Black Formatting
@@ -45,7 +45,7 @@ repos:
       types: [file, python]
       args: [--max-line-length=100, --ignore=E203 E301 E302 E501 E402 E704 W503 W504]
   - repo: https://github.com/pycqa/isort
-    rev: 5.11.4
+    rev: 5.12.0
     hooks:
       - id: isort
         name: isort Formatting

docs/events.rst

@@ -52,6 +52,7 @@ There are several different internal events:
 
     - ``raw_socket_create``
     - ``on_start``
+    - ``on_disconnect``
     - ``on_interaction``
     - ``on_command``
     - ``on_command_error``
@@ -82,6 +83,13 @@ This function takes no arguments.
 .. attention::
     Unlike ``on_ready``, this event will never be dispatched more than once.
 
+Event: ``on_disconnect``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+This event fires whenever the connection is invalidated and will often precede an ``on_ready`` event
+
+This function takes no arguments.
+
+
 Event: ``on_interaction``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 This event fires on any interaction (commands, components, autocomplete and modals).

interactions/api/cache.py

@@ -66,7 +66,6 @@ def merge(self, item: _T, id: Optional["Key"] = None) -> None:
                 continue
                 # we can only assume that discord did not provide it, falsely deleting is worse than not deleting
             if getattr(old_item, attrib) != getattr(item, attrib):
-
                 if isinstance(getattr(item, attrib), list) and not isinstance(
                     getattr(old_item, attrib), list
                 ):  # could be None

interactions/api/dispatch.py

@@ -37,7 +37,6 @@ def dispatch(self, name: str, /, *args, **kwargs) -> None:
             if converters := getattr(event, "_converters", None):
                 _kwargs = kwargs.copy()
                 for key, value in _kwargs.items():
-
                     if key in converters.keys():
                         del kwargs[key]
                         kwargs[converters[key]] = value

interactions/api/error.py

@@ -317,7 +317,6 @@ def __init__(self, code: int = 0, message: str = None, severity: int = 0, **kwar
         self.log(self.message)
 
         if _fmt_error:
-
             _flag: bool = (
                 self.message.lower() in self.lookup(self.code).lower()
             )  # creativity is hard

interactions/api/gateway/client.py

@@ -17,7 +17,6 @@
     wait_for,
 )
 from contextlib import suppress
-from enum import IntEnum
 from sys import platform, version_info
 from time import perf_counter
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Type, Union
@@ -26,7 +25,7 @@
 from aiohttp import ClientWebSocketResponse, WSMessage, WSMsgType
 
 from ...base import __version__, get_logger
-from ...client.enums import ComponentType, InteractionType, OptionType
+from ...client.enums import ComponentType, IntEnum, InteractionType, OptionType
 from ...client.models import Option
 from ...utils.missing import MISSING
 from ..dispatch import Listener
@@ -242,7 +241,6 @@ async def _manage_heartbeat(self) -> None:
         """Manages the heartbeat loop."""
         log.debug(f"Sending heartbeat every {self.__heartbeater.delay / 1000} seconds...")
         while not self.__heartbeat_event.is_set():
-
             log.debug("Sending heartbeat...")
             if not self.__heartbeater.event.is_set():
                 log.debug("HEARTBEAT_ACK missing, reconnecting...")
@@ -404,7 +402,6 @@ def _dispatch_interaction_event(self, data: dict) -> None:
                     _option = self.__sub_command_context(option, _context)
                     __kwargs.update(_option)
 
-            self._dispatch.dispatch("on_command", _context)
         elif data["type"] == InteractionType.MESSAGE_COMPONENT:
             _name = f"component_{_context.data.custom_id}"
 
@@ -931,6 +928,12 @@ async def _reconnect(self, to_resume: bool, code: Optional[int] = 1012) -> None:
                 if self.__heartbeat_event.is_set():
                     self.__heartbeat_event.clear()  # Because we're hardresetting the process
 
+            self._dispatch.dispatch(
+                "on_disconnect"
+            )  # will be followed by the on_ready event after reconnection
+            # reconnection happens whenever it disconnects either with or without a resume prompt
+            # as this is called whenever the WS client closes
+
             if not to_resume:
                 url = self.ws_url if self.ws_url else await self._http.get_gateway()
             else:
@@ -963,7 +966,6 @@ async def __receive_packet(self, ignore_lock: bool = False) -> Optional[Dict[str
         buffer = bytearray()
 
         while True:
-
             if not ignore_lock:
                 # meaning if we're reconnecting or something because of tasks
                 await self.__closed.wait()
@@ -1003,7 +1005,6 @@ async def __receive_packet(self, ignore_lock: bool = False) -> Optional[Dict[str
                     await self._reconnect(True)
 
             elif packet.type == WSMsgType.CLOSING:
-
                 if ignore_lock:
                     raise LibraryException(
                         message="Discord unexpectedly closing on receiving by force.", severity=50
@@ -1061,7 +1062,6 @@ async def _send_packet(self, data: Dict[str, Any]) -> None:
                 await self._client.send_str(packet)
         else:
             async with self.reconnect_lock:  # needs to lock while it reconnects.
-
                 if data["op"] != OpCodeType.HEARTBEAT.value:
                     # This is because the ratelimiter limits already accounts for this.
                     await self._ratelimiter.block()

interactions/api/http/interaction.py

@@ -236,7 +236,6 @@ async def create_interaction_response(
 
         file_data = None
         if files:
-
             file_data = MultipartWriter("form-data")
             part = file_data.append_json(data)
             part.set_content_disposition("form-data", name="payload_json")
@@ -295,7 +294,6 @@ async def edit_interaction_response(
         # ^ again, I don't know if python will let me
         file_data = None
         if files:
-
             file_data = MultipartWriter("form-data")
             part = file_data.append_json(data)
             part.set_content_disposition("form-data", name="payload_json")

interactions/api/http/message.py

@@ -84,7 +84,6 @@ async def create_message(
 
         data = None
         if files is not MISSING and len(files) > 0:
-
             data = MultipartWriter("form-data")
             part = data.append_json(payload)
             part.set_content_disposition("form-data", name="payload_json")
@@ -172,7 +171,6 @@ async def edit_message(
         """
         data = None
         if files is not MISSING and len(files) > 0:
-
             data = MultipartWriter("form-data")
             part = data.append_json(payload)
             part.set_content_disposition("form-data", name="payload_json")

interactions/api/http/request.py

@@ -209,7 +209,7 @@ async def request(self, route: Route, **kwargs) -> Optional[Any]:
                             await asyncio.sleep(_limiter.reset_after)
                             continue
                     if remaining is not None and int(remaining) == 0:
-                        log.warning(
+                        log.debug(
                             f"The HTTP client has exhausted a per-route ratelimit. Locking route for {reset_after} seconds."
                         )
                         self._loop.call_later(reset_after, _limiter.release_lock)

interactions/api/http/thread.py

@@ -231,7 +231,6 @@ async def create_thread_in_forum(
 
         data = None
         if files is not MISSING and files and len(files) > 0:  # edge case `None`
-
             data = MultipartWriter("form-data")
             part = data.append_json(payload)
             part.set_content_disposition("form-data", name="payload_json")