mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-04-18 23:15:48 +00:00
Code Issues Projects Releases Wiki Activity

Fix refs to abc.Connectable.connect

Browse Source
This commit is contained in:
Sebastian Law 2022-03-06 15:46:10 -08:00 committed by GitHub
parent 01906f37f1
commit 1dccd70b05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
discord/abc.py
View File

@ -1686,14 +1686,14 @@ class Connectable(Protocol):
*, *,
timeout: float = 60.0, timeout: float = 60.0,
reconnect: bool = True, reconnect: bool = True,
cls: Callable[[Client, Connectable], T] = VoiceClient, cls: Callable[[Client, Connectable], T] = MISSING,
) -> T: ) -> T:
"""|coro| """|coro|
Connects to voice and creates a :class:`VoiceClient` to establish Connects to voice and creates a :class:`~discord.VoiceClient` to establish
your connection to the voice server. your connection to the voice server.
This requires :attr:`Intents.voice_states`. This requires :attr:`~discord.Intents.voice_states`.
Parameters Parameters
----------- -----------
@ -1703,7 +1703,7 @@ class Connectable(Protocol):
Whether the bot should automatically attempt Whether the bot should automatically attempt
a reconnect if a part of the handshake fails a reconnect if a part of the handshake fails
or the gateway goes down. or the gateway goes down.
cls: Type[:class:`VoiceProtocol`] cls: Type[:class:`~discord.VoiceProtocol`]
A type that subclasses :class:`~discord.VoiceProtocol` to connect with. A type that subclasses :class:`~discord.VoiceProtocol` to connect with.
Defaults to :class:`~discord.VoiceClient`. Defaults to :class:`~discord.VoiceClient`.
@ -1729,6 +1729,10 @@ class Connectable(Protocol):
raise ClientException('Already connected to a voice channel.') raise ClientException('Already connected to a voice channel.')
client = state._get_client() client = state._get_client()
if cls is MISSING:
cls = VoiceClient
voice = cls(client, self) voice = cls(client, self)
if not isinstance(voice, VoiceProtocol): if not isinstance(voice, VoiceProtocol):

1
docs/api.rst
View File

@ -3368,6 +3368,7 @@ Connectable
.. attributetable:: discord.abc.Connectable .. attributetable:: discord.abc.Connectable
.. autoclass:: discord.abc.Connectable() .. autoclass:: discord.abc.Connectable()
:members:
.. _discord_api_models: .. _discord_api_models:

2
docs/whats_new.rst
View File

@ -72,7 +72,7 @@ New Features
- Add :attr:`MessageReference.jump_url` (:issue:`6318`) - Add :attr:`MessageReference.jump_url` (:issue:`6318`)
- Add :attr:`File.spoiler` (:issue:`6317`) - Add :attr:`File.spoiler` (:issue:`6317`)
- Add support for passing ``roles`` to :meth:`Guild.estimate_pruned_members` (:issue:`6538`) - Add support for passing ``roles`` to :meth:`Guild.estimate_pruned_members` (:issue:`6538`)
- Allow callable class factories to be used in :meth:`abc.Connectable.play` (:issue:`6478`) - Allow callable class factories to be used in :meth:`abc.Connectable.connect` (:issue:`6478`)
- Add a way to get mutual guilds from the client's cache via :attr:`User.mutual_guilds` (:issue:`2539`, :issue:`6444`) - Add a way to get mutual guilds from the client's cache via :attr:`User.mutual_guilds` (:issue:`2539`, :issue:`6444`)
- :meth:`PartialMessage.edit` now returns a full :class:`Message` upon success (:issue:`6309`) - :meth:`PartialMessage.edit` now returns a full :class:`Message` upon success (:issue:`6309`)
- Add :attr:`RawMessageUpdateEvent.guild_id` (:issue:`6489`) - Add :attr:`RawMessageUpdateEvent.guild_id` (:issue:`6489`)