mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-07-12 12:55:31 +00:00
Code Issues Projects Releases Wiki Activity

Forbid wait_until_ready inside setup_hook

Browse Source
This commit is contained in:
apple502j 2022-03-17 20:25:10 +09:00 committed by GitHub
parent c77bbc4dcf
commit 3e77a7b29e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
discord/client.py
View File

@ -29,6 +29,7 @@ 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,
@ -95,6 +96,8 @@ __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__)
@ -482,6 +485,11 @@ class Client:
any events are dispatched, making it a better solution than doing such any events are dispatched, making it a better solution than doing such
setup in the :func:`~discord.on_ready` event. setup in the :func:`~discord.on_ready` event.
.. warning::
Calling :meth:`wait_until_ready` inside this coroutine raises
an exception to prevent a deadlock.
.. versionadded:: 2.0 .. versionadded:: 2.0
""" """
pass pass
@ -518,7 +526,11 @@ 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|
@ -949,7 +961,14 @@ class Client:
"""|coro| """|coro|
Waits until the client's internal cache is all ready. Waits until the client's internal cache is all ready.
Raises
-------
ClientException
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()