fix(typing): proper VoiceClient.play() return value (Pycord-Development#2324)

* fix(typing): proper VoiceClient.play() return value

* style(pre-commit): auto fixes from pre-commit.com hooks

* fix(typing): mark after as optional

Co-authored-by: Dorukyum <[email protected]>
Signed-off-by: Krutyi-4el <[email protected]>

* fix(typing): mark after as optional

Co-authored-by: Dorukyum <[email protected]>
Signed-off-by: Krutyi-4el <[email protected]>

* fix(typing): mark after as optional

Co-authored-by: Dorukyum <[email protected]>
Signed-off-by: Krutyi-4el <[email protected]>

---------

Signed-off-by: Krutyi-4el <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Dorukyum <[email protected]>

Author: 3 people

discord/voice_client.py

@@ -46,7 +46,7 @@
 import struct
 import threading
 import time
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Callable, Literal, overload
 
 from . import opus, utils
 from .backoff import ExponentialBackoff
@@ -623,13 +623,33 @@ def get_ssrc(self, user_id):
             user_id
         ]
 
+    @overload
     def play(
         self,
         source: AudioSource,
         *,
-        after: Callable[[Exception | None], Any] = None,
-        wait_finish: bool = False,
+        after: Callable[[Exception | None], Any] | None = None,
+        wait_finish: Literal[False] = False,
     ) -> None:
+        ...
+
+    @overload
+    def play(
+        self,
+        source: AudioSource,
+        *,
+        after: Callable[[Exception | None], Any] | None = None,
+        wait_finish: Literal[True],
+    ) -> asyncio.Future:
+        ...
+
+    def play(
+        self,
+        source: AudioSource,
+        *,
+        after: Callable[[Exception | None], Any] | None = None,
+        wait_finish: bool = False,
+    ) -> None | asyncio.Future:
         """Plays an :class:`AudioSource`.
 
         The finalizer, ``after`` is called after the source has been exhausted