feat: pass event object based on listeners signature (#1367)

* feat: pass event object based on listeners signature

* Moved inspection to Listener.create, added warnings

* ci: correct from checks.

* fixed listeners in cogs

* feat: defer param processing until after binding

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: artem30801 <artem3080@gmail.com>
Co-authored-by: LordOfPolls <dev@lordofpolls.com>

Author: 4 people

interactions/client/client.py

@@ -571,11 +571,17 @@ async def _async_wrap(_coro: Listener, _event: BaseEvent, *_args, **_kwargs) ->
                 ):
                     await self.wait_until_ready()
 
-                if len(_event.__attrs_attrs__) == 2 and coro.event != "event":
-                    # override_name & bot & logging
-                    await _coro()
-                else:
+                # don't pass event object if listener doesn't expect it
+                if _coro.pass_event_object:
                     await _coro(_event, *_args, **_kwargs)
+                else:
+                    if not _coro.warned_no_event_arg and len(_event.__attrs_attrs__) > 2 and _coro.event != "event":
+                        self.logger.warning(
+                            f"{_coro} is listening to {_coro.event} event which contains event data. "
+                            f"Add an event argument to this listener to receive the event data object."
+                        )
+                        _coro.warned_no_event_arg = True
+                    await _coro()
             except asyncio.CancelledError:
                 pass
             except Exception as e:
@@ -1202,6 +1208,8 @@ def add_listener(self, listener: Listener) -> None:
             self.logger.debug(f"Listener {listener} has already been hooked, not re-hooking it again")
             return
 
+        listener.lazy_parse_params()
+
         if listener.event not in self.listeners:
             self.listeners[listener.event] = []
         self.listeners[listener.event].append(listener)

interactions/models/internal/extension.py

@@ -101,7 +101,7 @@ def __new__(cls, bot: "Client", *args, **kwargs) -> "Extension":
         for _name, val in callables:
             if isinstance(val, models.BaseCommand):
                 val.extension = instance
-                val = wrap_partial(val, instance)
+                val = val.copy_with_binding(instance)
                 bot.add_command(val)
                 instance._commands.append(val)
 
@@ -110,12 +110,12 @@ def __new__(cls, bot: "Client", *args, **kwargs) -> "Extension":
 
             elif isinstance(val, models.Listener):
                 val.extension = instance
-                val = wrap_partial(val, instance)
+                val = val.copy_with_binding(instance)
                 bot.add_listener(val)  # type: ignore
                 instance._listeners.append(val)
             elif isinstance(val, models.GlobalAutoComplete):
                 val.extension = instance
-                val = wrap_partial(val, instance)
+                val = val.copy_with_binding(instance)
                 bot.add_global_autocomplete(val)
         bot.dispatch(events.ExtensionCommandParse(extension=instance, callables=callables))
 

interactions/models/internal/listener.py

@@ -30,6 +30,7 @@ def __init__(
         delay_until_ready: bool = False,
         is_default_listener: bool = False,
         disable_default_listeners: bool = False,
+        pass_event_object: Absent[bool] = MISSING,
     ) -> None:
         super().__init__()
 
@@ -42,6 +43,10 @@ def __init__(
         self.is_default_listener = is_default_listener
         self.disable_default_listeners = disable_default_listeners
 
+        self._params = inspect.signature(func).parameters.copy()
+        self.pass_event_object = pass_event_object
+        self.warned_no_event_arg = False
+
     def __repr__(self) -> str:
         return f"<Listener event={self.event!r} callback={self.callback!r}>"
 
@@ -98,6 +103,17 @@ def wrapper(coro: AsyncCallable) -> "Listener":
 
         return wrapper
 
+    def lazy_parse_params(self):
+        """Process the parameters of this listener."""
+        if self.pass_event_object is not MISSING:
+            return
+
+        if self.has_binding:
+            # discard the first parameter, which is the class instance
+            self._params = list(self._params.values())[1:]
+
+        self.pass_event_object = len(self._params) != 0
+
 
 def listen(
     event_name: Absent[str | BaseEvent] = MISSING,