mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-08-18 17:10:32 +00:00
Code Issues Projects Releases Wiki Activity

Document cases where setup_hook can deadlock rather than raising

Browse Source
This commit is contained in:
Rapptz 2022-03-17 09:56:25 -04:00
parent 202b993da3
commit f5341a1cfa
1 changed files with 7 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
discord/client.py
View File

@ -29,7 +29,6 @@ import datetime
import logging import logging
import sys import sys
import traceback import traceback
from contextvars import ContextVar
from typing import ( from typing import (
Any, Any,
AsyncIterator, AsyncIterator,
@ -96,9 +95,6 @@ __all__ = (
Coro = TypeVar('Coro', bound=Callable[..., Coroutine[Any, Any, Any]]) Coro = TypeVar('Coro', bound=Callable[..., Coroutine[Any, Any, Any]])
_inside_setup_hook: ContextVar[bool] = ContextVar('_inside_setup_hook', default=False)
_log = logging.getLogger(__name__) _log = logging.getLogger(__name__)
@ -487,8 +483,9 @@ class Client:
.. warning:: .. warning::
Calling :meth:`wait_until_ready` inside this coroutine raises Since this is called *before* the websocket connection is made therefore
an exception to prevent a deadlock. anything that waits for the websocket will deadlock, this includes things
like :meth:`wait_for` and :meth:`wait_until_ready`.
.. versionadded:: 2.0 .. versionadded:: 2.0
""" """
@ -525,12 +522,7 @@ class Client:
data = await self.http.static_login(token.strip()) data = await self.http.static_login(token.strip())
self._connection.user = ClientUser(state=self._connection, data=data) self._connection.user = ClientUser(state=self._connection, data=data)
await self.setup_hook()
try:
ctx_token = _inside_setup_hook.set(True)
await self.setup_hook()
finally:
_inside_setup_hook.reset(ctx_token)
async def connect(self, *, reconnect: bool = True) -> None: async def connect(self, *, reconnect: bool = True) -> None:
"""|coro| """|coro|
@ -962,13 +954,10 @@ class Client:
Waits until the client's internal cache is all ready. Waits until the client's internal cache is all ready.
Raises .. warning::
-------
ClientException Calling this inside :meth:`setup_hook` can lead to a deadlock.
If this coroutine was called inside :meth:`setup_hook`.
""" """
if _inside_setup_hook.get():
raise ClientException('wait_until_ready cannot be called inside setup_hook.')
if self._ready is not MISSING: if self._ready is not MISSING:
await self._ready.wait() await self._ready.wait()