refactor(voice): Rewrite Voice Internals & DAVE Support (recieve)

.github/workflows/docs-checks.yml

@@ -47,7 +47,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install -U pip
-          pip install ".[docs]"
+          pip install ".[docs,voice]"
       - name: "Check Links"
         if: ${{ github.event_name == 'schedule' || inputs.with_linkcheck }}
         run: |

.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

.github/workflows/lib-checks.yml

@@ -157,6 +157,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install . --group dev
+          pip install .[voice]
 
       - name: "Run tests"
         run: tox

.readthedocs.yml

@@ -17,3 +17,4 @@ python:
       path: .
       extra_requirements:
         - docs
+        - voice

discord/__init__.py

@@ -24,7 +24,8 @@
 # isort: on
 
 
-from . import abc, opus, sinks, ui, utils
+from . import abc, opus, sinks, ui, utils, voice
+from ._voice_aliases import *
 from .activity import *
 from .appinfo import *
 from .application_role_connection import *
@@ -74,7 +75,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,75 @@
+"""
+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 VoiceClient as VoiceClientC
+    from discord.voice import VoiceProtocol as 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 as VoiceClientC
+
+        return VoiceClientC(client, channel)
+
+    @deprecated("discord.VoiceProtocol", "discord.voice.VoiceProtocol", "2.7", "3.0")
+    def VoiceProtocol(client, channel):
+        from discord.voice import VoiceProtocol as VoiceProtocolC
+
+        return VoiceProtocolC(client, channel)

discord/abc.py

@@ -57,7 +57,6 @@
 from .scheduled_events import ScheduledEvent
 from .sticker import GuildSticker, StickerItem
 from .utils import warn_deprecated
-from .voice_client import VoiceClient, VoiceProtocol
 
 __all__ = (
     "Snowflake",
@@ -69,8 +68,6 @@
     "Mentionable",
 )
 
-T = TypeVar("T", bound=VoiceProtocol)
-
 if TYPE_CHECKING:
     from datetime import datetime
 
@@ -106,6 +103,10 @@
     MessageableChannel = Union[PartialMessageableChannel, GroupChannel]
     SnowflakeTime = Union["Snowflake", datetime]
 
+    from .voice import VoiceClient, VoiceProtocol
+
+    T = TypeVar("T", bound=VoiceProtocol)
+
 MISSING = utils.MISSING
 
 
@@ -2003,6 +2004,7 @@ class Connectable(Protocol):
 
     __slots__ = ()
     _state: ConnectionState
+    id: int
 
     def _get_voice_client_key(self) -> tuple[int, str]:
         raise NotImplementedError
@@ -2015,7 +2017,7 @@ async def connect(
         *,
         timeout: float = 60.0,
         reconnect: bool = True,
-        cls: Callable[[Client, Connectable], T] = VoiceClient,
+        cls: Callable[[Client, Connectable], T] = MISSING,
     ) -> T:
         """|coro|
 
@@ -2051,6 +2053,16 @@ async def connect(
             The opus library has not been loaded.
         """
 
+        # import directly from _types so if the user does not have davey
+        # it won't error here
+        from .voice._types import VoiceProtocol
+
+        if cls is MISSING:
+            # if the user passes no cls, then actually import VoiceClient
+            from .voice import VoiceClient
+
+            cls = VoiceClient  # pyright: ignore[reportAssignmentType]
+
         key_id, _ = self._get_voice_client_key()
         state = self._state
 

discord/channel.py

@@ -1626,7 +1626,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
@@ -71,23 +70,20 @@
 from .ui.view import BaseView
 from .user import ClientUser, User
 from .utils import _D, _FETCHABLE, MISSING
-from .voice_client import VoiceClient
+from .voice import VoiceClient, VoiceProtocol
 from .webhook import Webhook
 from .widget import Widget
 
 if TYPE_CHECKING:
     from .abc import GuildChannel, PrivateChannel, Snowflake, SnowflakeTime
-    from .channel import (
-        DMChannel,
-    )
+    from .channel import DMChannel
     from .interactions import Interaction
     from .member import Member
     from .message import Message
     from .poll import Poll
     from .soundboard import SoundboardSound
     from .threads import Thread
     from .ui.item import ViewItem
-    from .voice_client import VoiceProtocol
 
 __all__ = ("Client",)
 
@@ -285,6 +281,9 @@ def __init__(
         if VoiceClient.warn_nacl:
             VoiceClient.warn_nacl = False
             _log.warning("PyNaCl is not installed, voice will NOT be supported")
+        if VoiceClient.warn_davey:
+            VoiceClient.warn_davey = False
+            _log.warning("davey is not installed, voice will NOT be supported")
 
         # Used to hard-reference tasks so they don't get garbage collected (discarded with done_callbacks)
         self._tasks = set()
@@ -823,7 +822,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.
 
@@ -847,41 +851,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

@@ -52,7 +52,7 @@
     from ..state import ConnectionState
     from ..ui import BaseView
     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