Add initial Translator implementation

Author: EvieePy

twitchio/ext/commands/__init__.py

@@ -29,3 +29,4 @@
 from .cooldowns import *
 from .core import *
 from .exceptions import *
+from .translators import *

twitchio/ext/commands/context.py

@@ -47,6 +47,7 @@
     from .bot import Bot
     from .components import Component
     from .core import Command
+    from .translators import Translator
 
     PrefixT: TypeAlias = str | Iterable[str] | Callable[[Bot, ChatMessage], Coroutine[Any, Any, str | Iterable[str]]]
 
@@ -543,6 +544,24 @@ async def send(self, content: str, *, me: bool = False) -> SentMessage:
         new = (f"/me {content}" if me else content).strip()
         return await self.channel.send_message(sender=self.bot.bot_id, message=new)
 
+    async def send_translated(self, content: str, *, me: bool = False, langcode: str | None = None) -> SentMessage:
+        translator: Translator | None = getattr(self.command, "translator", None)
+        new = (f"/me {content}" if me else content).strip()
+
+        if not self.command or not translator:
+            return await self.channel.send_message(sender=self.bot.bot_id, message=new)
+
+        invoked = self.invoked_with
+        code = langcode or translator.get_langcode(self, invoked.lower()) if invoked else None
+
+        if not code:
+            return await self.channel.send_message(sender=self.bot.bot_id, message=new)
+
+        translated = await translator.translate(self, content, code)
+        new_translated = (f"/me {translated}" if me else translated).strip()
+
+        return await self.channel.send_message(sender=self.bot.bot_id, message=new_translated)
+
     async def reply(self, content: str, *, me: bool = False) -> SentMessage:
         """|coro|
 

twitchio/ext/commands/core.py

@@ -61,13 +61,15 @@
     "is_staff",
     "is_vip",
     "reward_command",
+    "translator",
 )
 
 
 if TYPE_CHECKING:
     from twitchio.user import Chatter
 
     from .context import Context
+    from .translators import Translator
     from .types_ import BotT
 
     P = ParamSpec("P")
@@ -223,6 +225,12 @@ def __init__(
         self._before_hook: Callable[[Component_T, Context[Any]], Coro] | Callable[[Context[Any]], Coro] | None = None
         self._after_hook: Callable[[Component_T, Context[Any]], Coro] | Callable[[Context[Any]], Coro] | None = None
 
+        translator: Translator | type[Translator] | None = getattr(callback, "__command_translator__", None)
+        if translator and inspect.isclass(translator):
+            translator = translator()
+
+        self._translator: Translator | None = translator
+
         self._help: str = callback.__doc__ or ""
         self.__doc__ = self._help
 
@@ -262,6 +270,10 @@ def _get_signature(self) -> None:
 
         self._signature = help_sig
 
+    @property
+    def translator(self) -> Translator | None:
+        return self._translator
+
     @property
     def parameters(self) -> MappingProxyType[str, inspect.Parameter]:
         """Property returning a copy mapping of name to :class:`inspect.Parameter` pair, which are the parameters
@@ -1467,6 +1479,20 @@ def wrapper(
         return wrapper
 
 
+def translator(cls: Translator | type[Translator]) -> Any:
+    def wrapper(func: Any) -> Any:
+        inst = cls() if inspect.isclass(cls) else cls
+
+        if isinstance(func, Command):
+            func._translator = inst
+        else:
+            func.__command_translator = inst
+
+        return func  # type: ignore
+
+    return wrapper
+
+
 def guard(predicate: Callable[..., bool] | Callable[..., CoroC]) -> Any:
     """A function which takes in a predicate as a either a standard function *or* coroutine function which should
     return either ``True`` or ``False``, and adds it to your :class:`~.commands.Command` as a guard.

twitchio/ext/commands/translators.py

@@ -0,0 +1,43 @@
+"""
+MIT License
+
+Copyright (c) 2017 - Present PythonistaGuild
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from __future__ import annotations
+
+import abc
+from typing import TYPE_CHECKING, Any
+
+
+if TYPE_CHECKING:
+    from .context import Context
+
+
+__all__ = ("Translator",)
+
+
+class Translator(abc.ABC):
+    @abc.abstractmethod
+    def get_langcode(self, ctx: Context[Any], name: str) -> str | None: ...
+
+    @abc.abstractmethod
+    async def translate(self, ctx: Context[Any], text: str, langcode: str) -> str: ...