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

Fix View.wait not returning when it times out

Browse Source 
This also makes it so it returns the reason why the wait finished.
This commit is contained in:
Rapptz 2021-05-28 00:52:55 -04:00
parent 3f60997630
commit 263f45d05b
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
discord/ui/view.py
View File

@ -117,10 +117,11 @@ class View:
item._view = self item._view = self
self.children.append(item) self.children.append(item)
loop = asyncio.get_running_loop()
self.id = os.urandom(16).hex() self.id = os.urandom(16).hex()
self._cancel_callback: Optional[Callable[[View], None]] = None self._cancel_callback: Optional[Callable[[View], None]] = None
self._timeout_handler: Optional[asyncio.TimerHandle] = None self._timeout_handler: Optional[asyncio.TimerHandle] = None
self._stopped = asyncio.Event() self._stopped = loop.create_future()
def to_components(self) -> List[Dict[str, Any]]: def to_components(self) -> List[Dict[str, Any]]:
def key(item: Item) -> int: def key(item: Item) -> int:
@ -254,6 +255,7 @@ class View:
self._timeout_handler = loop.call_later(self.timeout, self.dispatch_timeout) self._timeout_handler = loop.call_later(self.timeout, self.dispatch_timeout)
def dispatch_timeout(self): def dispatch_timeout(self):
self._stopped.set_result(True)
asyncio.create_task(self.on_timeout(), name=f'discord-ui-view-timeout-{self.id}') asyncio.create_task(self.on_timeout(), name=f'discord-ui-view-timeout-{self.id}')
def dispatch(self, state: Any, item: Item, interaction: Interaction): def dispatch(self, state: Any, item: Item, interaction: Interaction):
@ -285,19 +287,26 @@ class View:
This operation cannot be undone. This operation cannot be undone.
""" """
self._stopped.set() self._stopped.set_result(False)
if self._timeout_handler: if self._timeout_handler:
self._timeout_handler.cancel() self._timeout_handler.cancel()
if self._cancel_callback: if self._cancel_callback:
self._cancel_callback(self) self._cancel_callback(self)
async def wait(self) -> None: async def wait(self) -> bool:
"""Waits until the view has finished interacting. """Waits until the view has finished interacting.
A view is considered finished when :meth:`stop` is called. A view is considered finished when :meth:`stop` is called
or it times out.
Returns
--------
:class:`bool`
If ``True``, then the view timed out. If ``False`` then
the view finished normally.
""" """
await self._stopped.wait() return await self._stopped
class ViewStore: class ViewStore: