Replace usages of type vars for Self return with typing_extensions.Self

Author: FasterSpeeding

tanjun/abc.py

@@ -65,8 +65,6 @@
 
     import typing_extensions
 
-    _ClientT = typing.TypeVar("_ClientT", bound="Client")
-
     class _MessageContextMakerProto(typing.Protocol):
         def __call__(
             self,
@@ -1104,7 +1102,7 @@ async def declare_application_commands(
 
         return responses
 
-    def set_auto_defer_after(self: _ClientT, time: typing.Optional[float], /) -> _ClientT:
+    def set_auto_defer_after(self, time: typing.Optional[float], /) -> typing_extensions.Self:
         """Set when this client should automatically defer execution of commands.
 
         .. warning::
@@ -1119,7 +1117,7 @@ def set_auto_defer_after(self: _ClientT, time: typing.Optional[float], /) -> _Cl
         self._auto_defer_after = float(time) if time is not None else None
         return self
 
-    def set_ephemeral_default(self: _ClientT, state: bool, /) -> _ClientT:
+    def set_ephemeral_default(self, state: bool, /) -> typing_extensions.Self:
         """Set whether slash contexts spawned by this client should default to ephemeral responses.
 
         Parameters
@@ -1139,7 +1137,7 @@ def set_ephemeral_default(self: _ClientT, state: bool, /) -> _ClientT:
         self._defaults_to_ephemeral = state
         return self
 
-    def set_hikari_trait_injectors(self: _ClientT, bot: hikari_traits.RESTAware, /) -> _ClientT:
+    def set_hikari_trait_injectors(self, bot: hikari_traits.RESTAware, /) -> typing_extensions.Self:
         """Set type based dependency injection based on the hikari traits found in `bot`.
 
         This is a short hand for calling `Client.add_type_dependency` for all
@@ -1156,7 +1154,7 @@ def set_hikari_trait_injectors(self: _ClientT, bot: hikari_traits.RESTAware, /)
 
         return self
 
-    def set_interaction_not_found(self: _ClientT, message: typing.Optional[str], /) -> _ClientT:
+    def set_interaction_not_found(self, message: typing.Optional[str], /) -> typing_extensions.Self:
         """Set the response message for when an interaction command is not found.
 
         .. warning::
@@ -1172,7 +1170,7 @@ def set_interaction_not_found(self: _ClientT, message: typing.Optional[str], /)
         self._interaction_not_found = message
         return self
 
-    def set_message_accepts(self: _ClientT, accepts: MessageAcceptsEnum, /) -> _ClientT:
+    def set_message_accepts(self, accepts: MessageAcceptsEnum, /) -> typing_extensions.Self:
         """Set the kind of messages commands should be executed based on.
 
         Parameters
@@ -1186,7 +1184,9 @@ def set_message_accepts(self: _ClientT, accepts: MessageAcceptsEnum, /) -> _Clie
         self._accepts = accepts
         return self
 
-    def set_message_ctx_maker(self: _ClientT, maker: _MessageContextMakerProto = context.MessageContext, /) -> _ClientT:
+    def set_message_ctx_maker(
+        self, maker: _MessageContextMakerProto = context.MessageContext, /
+    ) -> typing_extensions.Self:
         """Set the message context maker to use when creating context for a message.
 
         .. warning::
@@ -1209,7 +1209,7 @@ def set_message_ctx_maker(self: _ClientT, maker: _MessageContextMakerProto = con
         self._make_message_context = maker
         return self
 
-    def set_slash_ctx_maker(self: _ClientT, maker: _SlashContextMakerProto = context.SlashContext, /) -> _ClientT:
+    def set_slash_ctx_maker(self, maker: _SlashContextMakerProto = context.SlashContext, /) -> typing_extensions.Self:
         """Set the slash context maker to use when creating context for a slash command.
 
         .. warning::
@@ -1232,7 +1232,7 @@ def set_slash_ctx_maker(self: _ClientT, maker: _SlashContextMakerProto = context
         self._make_slash_context = maker
         return self
 
-    def set_human_only(self: _ClientT, value: bool = True) -> _ClientT:
+    def set_human_only(self, value: bool = True) -> typing_extensions.Self:
         """Set whether or not message commands execution should be limited to "human" users.
 
         .. note::
@@ -1258,7 +1258,7 @@ def set_human_only(self: _ClientT, value: bool = True) -> _ClientT:
 
         return self
 
-    def add_check(self: _ClientT, check: _CheckSig, /) -> _ClientT:
+    def add_check(self, check: _CheckSig, /) -> typing_extensions.Self:
         """Add a generic check to this client.
 
         This will be applied to both message and slash command execution.
@@ -1280,7 +1280,7 @@ def add_check(self: _ClientT, check: _CheckSig, /) -> _ClientT:
 
         return self
 
-    def remove_check(self: _ClientT, check: _CheckSig, /) -> _ClientT:
+    def remove_check(self, check: _CheckSig, /) -> typing_extensions.Self:
         """Remove a check from the client.
 
         Parameters
@@ -1317,7 +1317,9 @@ def with_check(self, check: _CheckSigT, /) -> _CheckSigT:
     async def check(self, ctx: tanjun_abc.Context, /) -> bool:
         return await utilities.gather_checks(ctx, self._checks)
 
-    def add_component(self: _ClientT, component: tanjun_abc.Component, /, *, add_injector: bool = False) -> _ClientT:
+    def add_component(
+        self, component: tanjun_abc.Component, /, *, add_injector: bool = False
+    ) -> typing_extensions.Self:
         """Add a component to this client.
 
         Parameters
@@ -1354,7 +1356,7 @@ def get_component_by_name(self, name: str, /) -> typing.Optional[tanjun_abc.Comp
         # <<inherited docstring from tanjun.abc.Client>>.
         return self._components.get(name)
 
-    def remove_component(self: _ClientT, component: tanjun_abc.Component, /) -> _ClientT:
+    def remove_component(self, component: tanjun_abc.Component, /) -> typing_extensions.Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         stored_component = self._components.get(component.name)
         if not stored_component or stored_component != component:
@@ -1373,13 +1375,13 @@ def remove_component(self: _ClientT, component: tanjun_abc.Component, /) -> _Cli
 
         return self
 
-    def remove_component_by_name(self: _ClientT, name: str, /) -> _ClientT:
+    def remove_component_by_name(self, name: str, /) -> typing_extensions.Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         return self.remove_component(self._components[name])
 
     def add_client_callback(
-        self: _ClientT, name: typing.Union[str, tanjun_abc.ClientCallbackNames], callback: _MetaEventSig, /
-    ) -> _ClientT:
+        self, name: typing.Union[str, tanjun_abc.ClientCallbackNames], callback: _MetaEventSig, /
+    ) -> typing_extensions.Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         descriptor = injecting.CallbackDescriptor(callback)
         name = name.casefold()
@@ -1415,8 +1417,8 @@ def get_client_callbacks(
         return ()
 
     def remove_client_callback(
-        self: _ClientT, name: typing.Union[str, tanjun_abc.ClientCallbackNames], callback: _MetaEventSig, /
-    ) -> _ClientT:
+        self, name: typing.Union[str, tanjun_abc.ClientCallbackNames], callback: _MetaEventSig, /
+    ) -> typing_extensions.Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         name = name.casefold()
         self._client_callbacks[name].remove(typing.cast("injecting.CallbackDescriptor[None]", callback))
@@ -1435,7 +1437,9 @@ def decorator(callback: _MetaEventSigT, /) -> _MetaEventSigT:
 
         return decorator
 
-    def add_listener(self: _ClientT, event_type: type[_EventT], callback: _ListenerCallbackSig[_EventT], /) -> _ClientT:
+    def add_listener(
+        self, event_type: type[_EventT], callback: _ListenerCallbackSig[_EventT], /
+    ) -> typing_extensions.Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         injected: injecting.SelfInjectingCallback[None] = injecting.SelfInjectingCallback(self, callback)
         try:
@@ -1453,8 +1457,8 @@ def add_listener(self: _ClientT, event_type: type[_EventT], callback: _ListenerC
         return self
 
     def remove_listener(
-        self: _ClientT, event_type: type[_EventT], callback: _ListenerCallbackSig[_EventT], /
-    ) -> _ClientT:
+        self, event_type: type[_EventT], callback: _ListenerCallbackSig[_EventT], /
+    ) -> typing_extensions.Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         index = self._listeners[event_type].index(typing.cast("injecting.SelfInjectingCallback[None]", callback))
         registered_callback = self._listeners[event_type].pop(index)
@@ -1477,7 +1481,7 @@ def decorator(callback: _ListenerCallbackSigT, /) -> _ListenerCallbackSigT:
 
         return decorator
 
-    def add_prefix(self: _ClientT, prefixes: typing.Union[collections.Iterable[str], str], /) -> _ClientT:
+    def add_prefix(self, prefixes: typing.Union[collections.Iterable[str], str], /) -> typing_extensions.Self:
         """Add a prefix used to filter message command calls.
 
         This will be matched against the first character(s) in a message's
@@ -1504,7 +1508,7 @@ def add_prefix(self: _ClientT, prefixes: typing.Union[collections.Iterable[str],
 
         return self
 
-    def remove_prefix(self: _ClientT, prefix: str, /) -> _ClientT:
+    def remove_prefix(self, prefix: str, /) -> typing_extensions.Self:
         """Remove a message content prefix from the client.
 
         Parameters
@@ -1525,7 +1529,7 @@ def remove_prefix(self: _ClientT, prefix: str, /) -> _ClientT:
         self._prefixes.remove(prefix)
         return self
 
-    def set_prefix_getter(self: _ClientT, getter: typing.Optional[_PrefixGetterSig], /) -> _ClientT:
+    def set_prefix_getter(self, getter: typing.Optional[_PrefixGetterSig], /) -> typing_extensions.Self:
         """Set the callback used to retrieve message prefixes set for the relevant guild.
 
         Parameters
@@ -1753,7 +1757,7 @@ async def fetch_rest_application_id(self) -> hikari.Snowflake:
 
         return self._cached_application_id
 
-    def set_hooks(self: _ClientT, hooks: typing.Optional[tanjun_abc.AnyHooks], /) -> _ClientT:
+    def set_hooks(self, hooks: typing.Optional[tanjun_abc.AnyHooks], /) -> typing_extensions.Self:
         """Set the general command execution hooks for this client.
 
         The callbacks within this hook will be added to every slash and message
@@ -1774,7 +1778,7 @@ def set_hooks(self: _ClientT, hooks: typing.Optional[tanjun_abc.AnyHooks], /) ->
         self._hooks = hooks
         return self
 
-    def set_slash_hooks(self: _ClientT, hooks: typing.Optional[tanjun_abc.SlashHooks], /) -> _ClientT:
+    def set_slash_hooks(self, hooks: typing.Optional[tanjun_abc.SlashHooks], /) -> typing_extensions.Self:
         """Set the slash command execution hooks for this client.
 
         The callbacks within this hook will be added to every slash command
@@ -1796,7 +1800,7 @@ def set_slash_hooks(self: _ClientT, hooks: typing.Optional[tanjun_abc.SlashHooks
         self._slash_hooks = hooks
         return self
 
-    def set_message_hooks(self: _ClientT, hooks: typing.Optional[tanjun_abc.MessageHooks], /) -> _ClientT:
+    def set_message_hooks(self, hooks: typing.Optional[tanjun_abc.MessageHooks], /) -> typing_extensions.Self:
         """Set the message command execution hooks for this client.
 
         The callbacks within this hook will be added to every message command
@@ -1842,7 +1846,7 @@ def _load_module(self, module: types.ModuleType, module_repr: str) -> None:
         if not found:
             raise RuntimeError(f"Didn't find any loaders in {module_repr}")
 
-    def load_modules(self: _ClientT, *modules: typing.Union[str, pathlib.Path], _log: bool = True) -> _ClientT:
+    def load_modules(self, *modules: typing.Union[str, pathlib.Path], _log: bool = True) -> typing_extensions.Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         for module_path in modules:
             if isinstance(module_path, str):
@@ -1889,7 +1893,7 @@ def _unload_module(self, module: types.ModuleType, module_repr: str) -> None:
         if not found:
             raise RuntimeError(f"Didn't find any unloaders in {module_repr}")
 
-    def unload_modules(self: _ClientT, *modules: typing.Union[str, pathlib.Path], _log: bool = True) -> _ClientT:
+    def unload_modules(self, *modules: typing.Union[str, pathlib.Path], _log: bool = True) -> typing_extensions.Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         for module_path in modules:
             if isinstance(module_path, str):
@@ -1909,7 +1913,7 @@ def unload_modules(self: _ClientT, *modules: typing.Union[str, pathlib.Path], _l
 
         return self
 
-    def reload_modules(self: _ClientT, *modules: typing.Union[str, pathlib.Path]) -> _ClientT:
+    def reload_modules(self, *modules: typing.Union[str, pathlib.Path]) -> typing_extensions.Self:
         # <<inherited docstring from tanjun.abc.Client>>.
         for module_path in modules:
             if isinstance(module_path, str):