merge upstream

Author: DA-344

discord/gateway.py

@@ -26,7 +26,6 @@
 from __future__ import annotations
 
 import asyncio
-from collections.abc import Callable
 import concurrent.futures
 import logging
 import struct
@@ -36,6 +35,7 @@
 import traceback
 import zlib
 from collections import deque
+from collections.abc import Callable
 from typing import TYPE_CHECKING, Any, NamedTuple
 
 import aiohttp
@@ -324,7 +324,12 @@ class DiscordWebSocket:
         shard_count: int | None
         _max_heartbeat_timeout: float
 
-    def __init__(self, socket: aiohttp.ClientWebSocketResponse, *, loop: asyncio.AbstractEventLoop) -> None:
+    def __init__(
+        self,
+        socket: aiohttp.ClientWebSocketResponse,
+        *,
+        loop: asyncio.AbstractEventLoop,
+    ) -> None:
         self.socket: aiohttp.ClientWebSocketResponse = socket
         self.loop: asyncio.AbstractEventLoop = loop
 
@@ -658,7 +663,7 @@ async def poll_event(self) -> None:
             elif msg.type is aiohttp.WSMsgType.BINARY:
                 await self.received_message(msg.data)
             elif msg.type is aiohttp.WSMsgType.ERROR:
-                _log.debug('Received an error %s', msg)
+                _log.debug("Received an error %s", msg)
             elif msg.type in (
                 aiohttp.WSMsgType.CLOSED,
                 aiohttp.WSMsgType.CLOSING,

discord/raw_models.py

@@ -25,16 +25,16 @@
 
 from __future__ import annotations
 
-from collections.abc import ItemsView, KeysView, ValuesView
 import datetime
+from collections.abc import ItemsView, KeysView, ValuesView
 from typing import TYPE_CHECKING, Any
 
+from . import utils
 from .automod import AutoModAction, AutoModTriggerType
 from .enums import AuditLogAction, ChannelType, ReactionType, try_enum
-from . import utils
 
 if TYPE_CHECKING:
-    from .abc import MessageableChannel, GuildChannel
+    from .abc import GuildChannel, MessageableChannel
     from .guild import Guild
     from .member import Member
     from .message import Message
@@ -94,7 +94,11 @@ class _RawReprMixin:
     __slots__: tuple[str, ...]
 
     def __repr__(self) -> str:
-        value = " ".join(f"{attr}={getattr(self, attr)!r}" for attr in self.__slots__ if not attr.startswith('_'))
+        value = " ".join(
+            f"{attr}={getattr(self, attr)!r}"
+            for attr in self.__slots__
+            if not attr.startswith("_")
+        )
         return f"<{self.__class__.__name__} {value}>"
 
 
@@ -850,23 +854,24 @@ def __init__(self, data: MessagePollVoteEvent, added: bool) -> None:
         except KeyError:
             self.guild_id: int | None = None
 
+
 # this is for backwards compatibility because VoiceProtocol.on_voice_..._update
 # passed the raw payload instead of a raw object. Emit deprecation warning.
 class _PayloadLike(_RawReprMixin):
     _raw_data: dict[str, Any]
 
     @utils.deprecated(
-        'the attributes',
-        '2.7',
-        '3.0',
+        "the attributes",
+        "2.7",
+        "3.0",
     )
     def __getitem__(self, key: str) -> Any:
         return self._raw_data[key]
 
     @utils.deprecated(
-        'the attributes',
-        '2.7',
-        '3.0',
+        "the attributes",
+        "2.7",
+        "3.0",
     )
     def get(self, key: str, default: Any = None) -> Any:
         """Gets an item from this raw event, and returns its value or ``default``.
@@ -877,9 +882,9 @@ def get(self, key: str, default: Any = None) -> Any:
         return self._raw_data.get(key, default)
 
     @utils.deprecated(
-        'the attributes',
-        '2.7',
-        '3.0',
+        "the attributes",
+        "2.7",
+        "3.0",
     )
     def items(self) -> ItemsView:
         """Returns the (key, value) pairs of this raw event.
@@ -890,9 +895,9 @@ def items(self) -> ItemsView:
         return self._raw_data.items()
 
     @utils.deprecated(
-        'the attributes',
-        '2.7',
-        '3.0',
+        "the attributes",
+        "2.7",
+        "3.0",
     )
     def values(self) -> ValuesView:
         """Returns the values of this raw event.
@@ -903,9 +908,9 @@ def values(self) -> ValuesView:
         return self._raw_data.values()
 
     @utils.deprecated(
-        'the attributes',
-        '2.7',
-        '3.0',
+        "the attributes",
+        "2.7",
+        "3.0",
     )
     def keys(self) -> KeysView:
         """Returns the keys of this raw event.
@@ -957,37 +962,37 @@ class RawVoiceStateUpdateEvent(_PayloadLike):
     """
 
     __slots__ = (
-        'session_id',
-        'mute',
-        'deaf',
-        'self_mute',
-        'self_deaf',
-        'self_stream',
-        'self_video',
-        'suppress',
-        'requested_to_speak_at',
-        'afk',
-        'channel',
-        'guild_id',
-        'channel_id',
-        '_state',
-        '_raw_data',
+        "session_id",
+        "mute",
+        "deaf",
+        "self_mute",
+        "self_deaf",
+        "self_stream",
+        "self_video",
+        "suppress",
+        "requested_to_speak_at",
+        "afk",
+        "channel",
+        "guild_id",
+        "channel_id",
+        "_state",
+        "_raw_data",
     )
 
     def __init__(self, *, data: VoiceStateEvent, state: ConnectionState) -> None:
-        self.session_id: str = data['session_id']
+        self.session_id: str = data["session_id"]
         self._state: ConnectionState = state
 
-        self.self_mute: bool = data.get('self_mute', False)
-        self.self_deaf: bool = data.get('self_deaf', False)
-        self.mute: bool = data.get('mute', False)
-        self.deaf: bool = data.get('deaf', False)
-        self.suppress: bool = data.get('suppress', False)
+        self.self_mute: bool = data.get("self_mute", False)
+        self.self_deaf: bool = data.get("self_deaf", False)
+        self.mute: bool = data.get("mute", False)
+        self.deaf: bool = data.get("deaf", False)
+        self.suppress: bool = data.get("suppress", False)
         self.requested_to_speak_at: datetime.datetime | None = utils.parse_time(
-            data.get('request_to_speak_timestamp')
+            data.get("request_to_speak_timestamp")
         )
-        self.guild_id: int | None = utils._get_as_snowflake(data, 'guild_id')
-        self.channel_id: int | None = utils._get_as_snowflake(data, 'channel_id')
+        self.guild_id: int | None = utils._get_as_snowflake(data, "guild_id")
+        self.channel_id: int | None = utils._get_as_snowflake(data, "channel_id")
         self._raw_data: VoiceStateEvent = data
 
     @property
@@ -1017,18 +1022,18 @@ class RawVoiceServerUpdateEvent(_PayloadLike):
     """
 
     __slots__ = (
-        'token',
-        'guild_id',
-        'endpoint',
-        '_raw_data',
-        '_state',
+        "token",
+        "guild_id",
+        "endpoint",
+        "_raw_data",
+        "_state",
     )
 
     def __init__(self, *, data: VoiceServerUpdateEvent, state: ConnectionState) -> None:
         self._state: ConnectionState = state
-        self.guild_id: int = int(data['guild_id'])
-        self.token: str = data['token']
-        self.endpoint: str | None = data['endpoint']
+        self.guild_id: int = int(data["guild_id"])
+        self.token: str = data["token"]
+        self.endpoint: str | None = data["endpoint"]
 
     @property
     def guild(self) -> Guild | None:

discord/types/raw_models.py

@@ -33,10 +33,8 @@
 from .snowflake import Snowflake
 from .threads import Thread, ThreadMember
 from .user import User
-from .voice import (
-    VoiceState as VoiceStateEvent,
-    VoiceServerUpdate as VoiceServerUpdateEvent,
-)
+from .voice import VoiceServerUpdate as VoiceServerUpdateEvent
+from .voice import VoiceState as VoiceStateEvent
 
 
 class _MessageEventOptional(TypedDict, total=False):

discord/voice/__init__.py

@@ -8,10 +8,10 @@
 :license: MIT, see LICENSE for more details.
 """
 
-from .client import VoiceClient
 from ._types import VoiceProtocol
+from .client import VoiceClient
 
 __all__ = (
-    'VoiceClient',
-    'VoiceProtocol',
+    "VoiceClient",
+    "VoiceProtocol",
 )

discord/voice/_types.py

@@ -22,6 +22,7 @@
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 """
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Generic, TypeVar
@@ -30,11 +31,11 @@
     from discord import abc
     from discord.client import Client
     from discord.raw_models import (
-        RawVoiceStateUpdateEvent,
         RawVoiceServerUpdateEvent,
+        RawVoiceStateUpdateEvent,
     )
 
-ClientT = TypeVar('ClientT', bound='Client', covariant=True)
+ClientT = TypeVar("ClientT", bound="Client", covariant=True)
 
 
 class VoiceProtocol(Generic[ClientT]):

discord/voice/client.py

@@ -22,6 +22,7 @@
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 """
+
 from __future__ import annotations
 
 # rn this is for typing, will be moved here in some point in the future

discord/voice/errors.py

@@ -0,0 +1,93 @@
+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-2021 Rapptz
+Copyright (c) 2021-present Pycord Development
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+"""
+
+from __future__ import annotations
+
+from aiohttp import ClientWebSocketResponse
+
+from discord.errors import ClientException
+
+
+class VoiceConnectionClosed(ClientException):
+    """Exception that's raised when a voice websocket connection
+    is closed for reasons that could not be handled internally.
+
+    Attributes
+    ----------
+    code: :class:`int`
+        The close code of the websocket.
+    reason: :class:`str`
+        The reason provided for the closure.
+    guild_id: :class:`int`
+        The guild ID the client was connected to.
+    channel_id: :class:`int`
+        The channel ID the client was connected to.
+    """
+
+    __slots__ = (
+        "code",
+        "reason",
+        "channel_id",
+        "guild_id",
+    )
+
+    def __init__(
+        self,
+        socket: ClientWebSocketResponse,
+        channel_id: int,
+        guild_id: int,
+        *,
+        reason: str | None = None,
+        code: int | None = None,
+    ) -> None:
+        self.code: int = code or socket.close_code or -1
+        self.reason: str = reason if reason is not None else ""
+        self.channel_id: int = channel_id
+        self.guild_id: int = guild_id
+        super().__init__(
+            f"The voice connection on {self.channel_id} (guild {self.guild_id}) was closed with {self.code}",
+        )
+
+
+class VoiceGuildMismatch(ClientException):
+    """Exception that's raised when, while connecting to a voice channel, the data
+    the library has differs from the one discord sends.
+
+    Attributes
+    ----------
+    expected: :class:`int`
+        The expected guild ID. This is the one the library has.
+    received: :class:`int`
+        The received guild ID. This is the one sent by discord.
+    """
+
+    __slots__ = (
+        "expected",
+        "received",
+    )
+
+    def __init__(self, expt: int, recv: int) -> None:
+        self.expected: int = expt
+        self.received: int = recv

discord/voice/gateway.py

@@ -22,6 +22,7 @@
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 """
+
 from __future__ import annotations
 
 import asyncio

discord/voice/state.py

@@ -22,6 +22,7 @@
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 """
+
 from __future__ import annotations
 
 import asyncio