fix(voice): Voice internals rewrite to fix things

.github/workflows/docs-json-export.yml

@@ -26,7 +26,7 @@ jobs:
         id: install-deps
         run: |
           python -m pip install -U pip
-          pip install ".[docs]"
+          pip install ".[docs,voice]"
           pip install beautifulsoup4
       - name: Build Sphinx HTML docs
         id: build-sphinx

discord/__init__.py

@@ -25,6 +25,7 @@
 
 
 from . import abc, opus, sinks, ui, utils
+from ._voice_aliases import *
 from .activity import *
 from .appinfo import *
 from .application_role_connection import *
@@ -72,7 +73,6 @@
 from .template import *
 from .threads import *
 from .user import *
-from .voice_client import *
 from .webhook import *
 from .welcome_screen import *
 from .widget import *

discord/_voice_aliases.py

@@ -0,0 +1,74 @@
+"""
+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 typing import TYPE_CHECKING
+
+from .utils import deprecated
+
+"""
+since discord.voice raises an error when importing it without having the
+required package (ie davey) installed, we can't import it in __init__ because
+that would break the whole library, that is why this file is here.
+
+the error would still be raised, but at least here we have more freedom on how we are typing it
+"""
+
+__all__ = ("VoiceProtocol", "VoiceClient")
+
+
+if TYPE_CHECKING:
+    from typing_extensions import deprecated
+
+    from discord.voice import VoiceClientC, VoiceProtocolC
+
+    @deprecated(
+        "discord.VoiceClient is deprecated in favour "
+        "of discord.voice.VoiceClient since 2.7 and "
+        "will be removed in 3.0",
+    )
+    def VoiceClient(client, channel) -> VoiceClientC: ...
+
+    @deprecated(
+        "discord.VoiceProtocol is deprecated in favour "
+        "of discord.voice.VoiceProtocol since 2.7 and "
+        "will be removed in 3.0",
+    )
+    def VoiceProtocol(client, channel) -> VoiceProtocolC: ...
+
+else:
+
+    @deprecated("discord.VoiceClient", "discord.voice.VoiceClient", "2.7", "3.0")
+    def VoiceClient(client, channel):
+        from discord.voice import VoiceClient
+
+        return VoiceClient(client, channel)
+
+    @deprecated("discord.VoiceProtocol", "discord.voice.VoiceProtocol", "2.7", "3.0")
+    def VoiceProtocol(client, channel):
+        from discord.voice import VoiceProtocol
+
+        return VoiceProtocol(client, channel)

discord/abc.py

@@ -55,7 +55,7 @@
 from .role import Role
 from .scheduled_events import ScheduledEvent
 from .sticker import GuildSticker, StickerItem
-from .voice_client import VoiceClient, VoiceProtocol
+from .voice import VoiceClient, VoiceProtocol
 
 __all__ = (
     "Snowflake",
@@ -1966,6 +1966,7 @@ class Connectable(Protocol):
 
     __slots__ = ()
     _state: ConnectionState
+    id: int
 
     def _get_voice_client_key(self) -> tuple[int, str]:
         raise NotImplementedError

discord/channel.py

@@ -1624,7 +1624,7 @@ def _update(
         self, guild: Guild, data: VoiceChannelPayload | StageChannelPayload
     ) -> None:
         # This data will always exist
-        self.guild = guild
+        self.guild: Guild = guild
         self.name: str = data["name"]
         self.category_id: int | None = utils._get_as_snowflake(data, "parent_id")
 

discord/client.py

@@ -27,7 +27,6 @@
 
 import asyncio
 import logging
-import signal
 import sys
 import traceback
 from types import TracebackType
@@ -51,7 +50,7 @@
 from .invite import Invite
 from .iterators import EntitlementIterator, GuildIterator
 from .mentions import AllowedMentions
-from .monetization import SKU, Entitlement
+from .monetization import SKU
 from .object import Object
 from .soundboard import SoundboardSound
 from .stage_instance import StageInstance
@@ -62,7 +61,7 @@
 from .ui.view import View
 from .user import ClientUser, User
 from .utils import MISSING
-from .voice_client import VoiceClient
+from .voice import VoiceClient
 from .webhook import Webhook
 from .widget import Widget
 
@@ -75,7 +74,7 @@
     from .poll import Poll
     from .soundboard import SoundboardSound
     from .ui.item import Item
-    from .voice_client import VoiceProtocol
+    from .voice import VoiceProtocol
 
 __all__ = ("Client",)
 
@@ -807,7 +806,12 @@ async def start(self, token: str, *, reconnect: bool = True) -> None:
         await self.login(token)
         await self.connect(reconnect=reconnect)
 
-    def run(self, *args: Any, **kwargs: Any) -> None:
+    def run(
+        self,
+        token: str,
+        *,
+        reconnect: bool = True,
+    ) -> None:
         """A blocking call that abstracts away the event loop
         initialisation from you.
 
@@ -831,41 +835,18 @@ def run(self, *args: Any, **kwargs: Any) -> None:
             is blocking. That means that registration of events or anything being
             called after this function call will not execute until it returns.
         """
-        loop = self.loop
-
-        try:
-            loop.add_signal_handler(signal.SIGINT, loop.stop)
-            loop.add_signal_handler(signal.SIGTERM, loop.stop)
-        except (NotImplementedError, RuntimeError):
-            pass
 
         async def runner():
-            try:
-                await self.start(*args, **kwargs)
-            finally:
-                if not self.is_closed():
-                    await self.close()
+            async with self:
+                await self.start(token, reconnect=reconnect)
 
-        def stop_loop_on_completion(f):
-            loop.stop()
-
-        future = asyncio.ensure_future(runner(), loop=loop)
-        future.add_done_callback(stop_loop_on_completion)
         try:
-            loop.run_forever()
+            asyncio.run(runner())
         except KeyboardInterrupt:
-            _log.info("Received signal to terminate bot and event loop.")
-        finally:
-            future.remove_done_callback(stop_loop_on_completion)
-            _log.info("Cleaning up tasks.")
-            _cleanup_loop(loop)
-
-        if not future.cancelled():
-            try:
-                return future.result()
-            except KeyboardInterrupt:
-                # I am unsure why this gets raised here but suppress it anyway
-                return None
+            # nothing to do here
+            # `asyncio.run` handles the loop cleanup
+            # and `self.start` closes all sockets and the HTTPClient instance.
+            return
 
     # properties
 

discord/commands/context.py

@@ -48,7 +48,7 @@
     from ..permissions import Permissions
     from ..state import ConnectionState
     from ..user import User
-    from ..voice_client import VoiceClient
+    from ..voice import VoiceClient
     from ..webhook import WebhookMessage
     from .core import ApplicationCommand, Option
 

discord/ext/commands/context.py

@@ -41,7 +41,7 @@
     from discord.member import Member
     from discord.state import ConnectionState
     from discord.user import ClientUser, User
-    from discord.voice_client import VoiceProtocol
+    from discord.voice import VoiceProtocol
 
     from .bot import AutoShardedBot, Bot
     from .cog import Cog