aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRapptz <[email protected]>2021-05-28 00:52:55 -0400
committerRapptz <[email protected]>2021-05-28 00:53:28 -0400
commit263f45d05bc512f7529d15001aad495e1327f67a (patch)
tree697fef756d66c7f86c4d9ace4a32538258353464
parentAdd a timeout callback for detecting when a View times out (diff)
downloaddiscord.py-263f45d05bc512f7529d15001aad495e1327f67a.tar.xz
discord.py-263f45d05bc512f7529d15001aad495e1327f67a.zip
Fix View.wait not returning when it times out
This also makes it so it returns the reason why the wait finished.
-rw-r--r--discord/ui/view.py19
1 files changed, 14 insertions, 5 deletions
diff --git a/discord/ui/view.py b/discord/ui/view.py
index 1e79625c..a783afa7 100644
--- a/discord/ui/view.py
+++ b/discord/ui/view.py
@@ -117,10 +117,11 @@ class View:
item._view = self
self.children.append(item)
+ loop = asyncio.get_running_loop()
self.id = os.urandom(16).hex()
self._cancel_callback: Optional[Callable[[View], None]] = 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 key(item: Item) -> int:
@@ -254,6 +255,7 @@ class View:
self._timeout_handler = loop.call_later(self.timeout, self.dispatch_timeout)
def dispatch_timeout(self):
+ self._stopped.set_result(True)
asyncio.create_task(self.on_timeout(), name=f'discord-ui-view-timeout-{self.id}')
def dispatch(self, state: Any, item: Item, interaction: Interaction):
@@ -285,19 +287,26 @@ class View:
This operation cannot be undone.
"""
- self._stopped.set()
+ self._stopped.set_result(False)
if self._timeout_handler:
self._timeout_handler.cancel()
if self._cancel_callback:
self._cancel_callback(self)
- async def wait(self) -> None:
+ async def wait(self) -> bool:
"""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: