[listeners] override ListenerCanceled in pywa_async for better typing

Author: david-lev

pywa/listeners.py

@@ -17,7 +17,7 @@
 
 if TYPE_CHECKING:
     from .client import WhatsApp
-    from .types.base_update import BaseUpdate
+    from .types.base_update import BaseUpdate, BaseUserUpdate
     from .filters import Filter
 
 
@@ -85,7 +85,9 @@ class ListenerCanceled(Exception):
         update: The update that caused the listener to be canceled
     """
 
-    def __init__(self, update: BaseUpdate | None = None):
+    update: BaseUpdate | BaseUserUpdate | None
+
+    def __init__(self, update: BaseUpdate | BaseUserUpdate | None = None):
         self.update = update
 
     def __str__(self):
@@ -126,6 +128,8 @@ def __str__(self):
 
 
 class Listener:
+    _listener_canceled = ListenerCanceled
+
     def __init__(
         self,
         filters: Filter,
@@ -146,7 +150,7 @@ def set_exception(self, exception: Exception) -> None:
         self.event.set()
 
     def cancel(self, update: BaseUpdate | None = None) -> None:
-        self.set_exception(ListenerCanceled(update))
+        self.set_exception(self._listener_canceled(update))
 
     def stop(self, reason: str | None = None) -> None:
         self.set_exception(ListenerStopped(reason))

pywa_async/listeners.py

@@ -5,6 +5,7 @@
 from pywa.listeners import *  # noqa MUST BE IMPORTED FIRST
 from pywa.listeners import (
     Listener as _Listener,
+    ListenerCanceled as _ListenerCanceled,
     BaseListenerIdentifier,
 )  # noqa MUST BE IMPORTED FIRST
 
@@ -22,11 +23,43 @@
     ChatOpened,
     FlowCompletion,
 )
+from .types.base_update import BaseUserUpdateAsync
 
 if TYPE_CHECKING:
     from .client import WhatsApp
 
 
+class ListenerCanceled(_ListenerCanceled):
+    """
+    The listener was canceled by a filter
+
+    Example:
+
+        .. code-block:: python
+
+            try:
+                wa.listen(
+                    to=UserUpdateListenerIdentifier(
+                        sender="123456",
+                        recipient="654321"
+                    ),
+                    filters=filters.message & filters.text,
+                    cancelers=filters.callback_button & filters.matches("cancel")
+                )
+            except ListenerCanceled as e:
+                assert e.update.data == "cancel" # the update that caused the listener to be canceled
+                wa.send_message("123456", "You cancelled the listener by clicking the `cancel` button")
+
+    Attributes:
+        update: The update that caused the listener to be canceled
+    """
+
+    update: BaseUpdate | BaseUserUpdateAsync | None
+
+    def __init__(self, update: BaseUpdate | BaseUserUpdateAsync | None = None):
+        super().__init__(update)
+
+
 class Listener(_Listener):
     _listener_canceled = ListenerCanceled