Allow passing multiple callbacks to some add methods (#646)

Author: FasterSpeeding

CHANGELOG.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Support for passing multiple callbacks to `add_check`, `add_client_callback`, `add_listener`,
+  `add_on_close` and `add_on_open`.
+
 ## [2.10.1a1] - 2022-12-02
 ### Added
 - Slash command specific [tanjun.annotations.InteractionChannel][] and

tanjun/abc.py

@@ -2419,13 +2419,13 @@ def set_hooks(self, hooks: typing.Optional[Hooks[_ContextT_co]], /) -> Self:
         """
 
     @abc.abstractmethod
-    def add_check(self, check: CheckSig, /) -> Self:  # TODO: remove or add with_check?
+    def add_check(self, *checks: CheckSig) -> Self:  # TODO: remove or add with_check?
         """Add a check to the command.
 
         Parameters
         ----------
-        check
-            The check to add.
+        *checks
+            The checks to add.
 
         Returns
         -------
@@ -3343,15 +3343,15 @@ def with_message_command(
         """
 
     @abc.abstractmethod
-    def add_listener(self, event: type[hikari.Event], listener: ListenerCallbackSig, /) -> Self:
+    def add_listener(self, event: type[hikari.Event], /, *callbacks: ListenerCallbackSig) -> Self:
         """Add a listener to this component.
 
         Parameters
         ----------
         event
             The event to listen for.
-        listener
-            The listener to add.
+        *callbacks
+            The callbacks to add.
 
         Returns
         -------
@@ -4143,7 +4143,7 @@ def remove_component_by_name(self, name: str, /) -> Self:
         """
 
     @abc.abstractmethod
-    def add_client_callback(self, name: typing.Union[str, ClientCallbackNames], callback: MetaEventSig, /) -> Self:
+    def add_client_callback(self, name: typing.Union[str, ClientCallbackNames], /, *callbacks: MetaEventSig) -> Self:
         """Add a client callback.
 
         Parameters
@@ -4152,10 +4152,10 @@ def add_client_callback(self, name: typing.Union[str, ClientCallbackNames], call
             The name this callback is being registered to.
 
             This is case-insensitive.
-        callback
-            The callback to register.
+        *callbacks
+            The callbacks to register.
 
-            This may be sync or async and must return None. The positional and
+            These may be sync or async and must return None. The positional and
             keyword arguments a callback should expect depend on implementation
             detail around the `name` being subscribed to.
 
@@ -4263,20 +4263,19 @@ async def on_close() -> None:
         """
 
     @abc.abstractmethod
-    def add_listener(self, event_type: type[hikari.Event], callback: ListenerCallbackSig, /) -> Self:
+    def add_listener(self, event_type: type[hikari.Event], /, *callbacks: ListenerCallbackSig) -> Self:
         """Add a listener to the client.
 
         Parameters
         ----------
         event_type
             The event type to add a listener for.
-        callback
-            The callback to register as a listener.
+        *callbacks
+            The callbacks to register as a listener.
 
-            This callback must be a coroutine function which returns [None][]
-            and always takes one positional arg of type
-            [hikari.events.base_events.Event][] regardless of client
-            implementation detail.
+            These callbacks must be coroutine functions which returns [None][]
+            and always takes one positional arg of the event type passed for
+            `event_type` regardless of client implementation detail.
 
         Returns
         -------

tanjun/clients.py

@@ -1763,15 +1763,15 @@ def set_human_only(self, value: bool = True, /) -> Self:
 
         return self
 
-    def add_check(self, check: tanjun.CheckSig, /) -> Self:
+    def add_check(self, *checks: tanjun.CheckSig) -> Self:
         """Add a generic check to this client.
 
         This will be applied to both message and slash command execution.
 
         Parameters
         ----------
-        check
-            The check to add. This may be either synchronous or asynchronous
+        *checks
+            The checks to add. These may be either synchronous or asynchronous
             and must take one positional argument of type [tanjun.abc.Context][]
             with dependency injection being supported for its keyword arguments.
 
@@ -1780,8 +1780,9 @@ def add_check(self, check: tanjun.CheckSig, /) -> Self:
         Self
             The client instance to enable chained calls.
         """
-        if check not in self._checks:
-            self._checks.append(check)
+        for check in checks:
+            if check not in self._checks:
+                self._checks.append(check)
 
         return self
 
@@ -1884,17 +1885,20 @@ def remove_component_by_name(self, name: str, /) -> Self:
         return self.remove_component(self._components[name])
 
     def add_client_callback(
-        self, name: typing.Union[str, tanjun.ClientCallbackNames], callback: tanjun.MetaEventSig, /
+        self, name: typing.Union[str, tanjun.ClientCallbackNames], /, *callbacks: tanjun.MetaEventSig
     ) -> Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         name = name.casefold()
-        try:
-            if callback in self._client_callbacks[name]:
-                return self
+        for callback in callbacks:
+            try:
+                if callback in self._client_callbacks[name]:
+                    continue
 
-            self._client_callbacks[name].append(callback)
-        except KeyError:
-            self._client_callbacks[name] = [callback]
+            except KeyError:
+                self._client_callbacks[name] = [callback]
+
+            else:
+                self._client_callbacks[name].append(callback)
 
         return self
 
@@ -1938,20 +1942,22 @@ def decorator(callback: _MetaEventSigT, /) -> _MetaEventSigT:
 
         return decorator
 
-    def add_listener(self, event_type: type[hikari.Event], callback: tanjun.ListenerCallbackSig, /) -> Self:
+    def add_listener(self, event_type: type[hikari.Event], /, *callbacks: tanjun.ListenerCallbackSig) -> Self:
         # <<inherited docstring from tanjun.abc.Client>>.
-        injected = self.injector.as_async_self_injecting(callback)
-        try:
-            if callback in self._listeners[event_type]:
-                return self
+        for callback in callbacks:
+            injected = self.injector.as_async_self_injecting(callback)
+            try:
+                if callback in self._listeners[event_type]:
+                    continue
 
-            self._listeners[event_type][callback] = injected
+            except KeyError:
+                self._listeners[event_type] = {callback: injected}
 
-        except KeyError:
-            self._listeners[event_type] = {callback: injected}
+            else:
+                self._listeners[event_type][callback] = injected
 
-        if self._loop and self._events:
-            self._events.subscribe(event_type, injected.__call__)
+            if self._loop and self._events:
+                self._events.subscribe(event_type, injected.__call__)
 
         return self
 

tanjun/commands/base.py

@@ -98,10 +98,11 @@ def set_metadata(self, key: typing.Any, value: typing.Any, /) -> Self:
         self._metadata[key] = value
         return self
 
-    def add_check(self, check: tanjun.CheckSig, /) -> Self:
+    def add_check(self, *checks: tanjun.CheckSig) -> Self:
         # <<inherited docstring from tanjun.abc.ExecutableCommand>>.
-        if check not in self._checks:
-            self._checks.append(check)
+        for check in checks:
+            if check not in self._checks:
+                self._checks.append(check)
 
         return self
 

tanjun/components.py

@@ -565,21 +565,22 @@ def set_slash_hooks(self, hooks: typing.Optional[tanjun.SlashHooks], /) -> Self:
         self._slash_hooks = hooks
         return self
 
-    def add_check(self, check: tanjun.CheckSig, /) -> Self:
+    def add_check(self, *checks: tanjun.CheckSig) -> Self:
         """Add a command check to this component to be used for all its commands.
 
         Parameters
         ----------
-        check
-            The check to add.
+        *checks
+            The checks to add.
 
         Returns
         -------
         Self
             This component to enable method chaining.
         """
-        if check not in self._checks:
-            self._checks.append(check)
+        for check in checks:
+            if check not in self._checks:
+                self._checks.append(check)
 
         return self
 
@@ -621,7 +622,7 @@ def with_check(self, check: _CheckSigT, /) -> _CheckSigT:
         return check
 
     def add_client_callback(
-        self, name: typing.Union[str, tanjun.ClientCallbackNames], callback: tanjun.MetaEventSig, /
+        self, name: typing.Union[str, tanjun.ClientCallbackNames], /, *callbacks: tanjun.MetaEventSig
     ) -> Self:
         """Add a client callback.
 
@@ -631,10 +632,10 @@ def add_client_callback(
             The name this callback is being registered to.
 
             This is case-insensitive.
-        callback
-            The callback to register.
+        *callbacks
+            The callbacks to register.
 
-            This may be sync or async and must return None. The positional and
+            These may be sync or async and must return None. The positional and
             keyword arguments a callback should expect depend on implementation
             detail around the `name` being subscribed to.
 
@@ -644,16 +645,19 @@ def add_client_callback(
             The client instance to enable chained calls.
         """
         name = name.lower()
-        try:
-            if callback in self._client_callbacks[name]:
-                return self
+        for callback in callbacks:
+            try:
+                if callback in self._client_callbacks[name]:
+                    continue
 
-            self._client_callbacks[name].append(callback)
-        except KeyError:
-            self._client_callbacks[name] = [callback]
+            except KeyError:
+                self._client_callbacks[name] = [callback]
 
-        if self._client:
-            self._client.add_client_callback(name, callback)
+            else:
+                self._client_callbacks[name].append(callback)
+
+            if self._client:
+                self._client.add_client_callback(name, callback)
 
         return self
 
@@ -982,19 +986,21 @@ def with_message_command(
         # <<inherited docstring from tanjun.abc.Component>>.
         return _with_command(self.add_message_command, command, copy=copy)
 
-    def add_listener(self, event: type[hikari.Event], listener: tanjun.ListenerCallbackSig, /) -> Self:
+    def add_listener(self, event: type[hikari.Event], /, *callbacks: tanjun.ListenerCallbackSig) -> Self:
         # <<inherited docstring from tanjun.abc.Component>>.
-        try:
-            if listener in self._listeners[event]:
-                return self
+        for listener in callbacks:
+            try:
+                if listener in self._listeners[event]:
+                    continue
 
-            self._listeners[event].append(listener)
+            except KeyError:
+                self._listeners[event] = [listener]
 
-        except KeyError:
-            self._listeners[event] = [listener]
+            else:
+                self._listeners[event].append(listener)
 
-        if self._client:
-            self._client.add_listener(event, listener)
+            if self._client:
+                self._client.add_listener(event, listener)
 
         return self
 
@@ -1022,7 +1028,7 @@ def decorator(callback: _ListenerCallbackSigT, /) -> _ListenerCallbackSigT:
 
         return decorator
 
-    def add_on_close(self, callback: OnCallbackSig, /) -> Self:
+    def add_on_close(self, *callbacks: OnCallbackSig) -> Self:
         """Add a close callback to this component.
 
         !!! note
@@ -1032,8 +1038,8 @@ def add_on_close(self, callback: OnCallbackSig, /) -> Self:
 
         Parameters
         ----------
-        callback
-            The close callback to add to this component.
+        *callbacks
+            The close callbacks to add to this component.
 
             This should take no positional arguments, return [None][] and may
             take use injected dependencies.
@@ -1043,7 +1049,7 @@ def add_on_close(self, callback: OnCallbackSig, /) -> Self:
         Self
             The component object to enable call chaining.
         """
-        self._on_close.append(callback)
+        self._on_close.extend(callbacks)
         return self
 
     def with_on_close(self, callback: _OnCallbackSigT, /) -> _OnCallbackSigT:
@@ -1060,7 +1066,7 @@ def with_on_close(self, callback: _OnCallbackSigT, /) -> _OnCallbackSigT:
             The close callback to add to this component.
 
             This should take no positional arguments, return [None][] and may
-            take use injected dependencies.
+            request injected dependencies.
 
         Returns
         -------
@@ -1070,7 +1076,7 @@ def with_on_close(self, callback: _OnCallbackSigT, /) -> _OnCallbackSigT:
         self.add_on_close(callback)
         return callback
 
-    def add_on_open(self, callback: OnCallbackSig, /) -> Self:
+    def add_on_open(self, *callbacks: OnCallbackSig) -> Self:
         """Add a open callback to this component.
 
         !!! note
@@ -1080,18 +1086,18 @@ def add_on_open(self, callback: OnCallbackSig, /) -> Self:
 
         Parameters
         ----------
-        callback
-            The open callback to add to this component.
+        *callbacks
+            The open callbacks to add to this component.
 
-            This should take no positional arguments, return [None][] and may
-            take use injected dependencies.
+            These should take no positional arguments, return [None][] and may
+            request injected dependencies.
 
         Returns
         -------
         Self
             The component object to enable call chaining.
         """
-        self._on_open.append(callback)
+        self._on_open.extend(callbacks)
         return self
 
     def with_on_open(self, callback: _OnCallbackSigT, /) -> _OnCallbackSigT: