Add Generic to Translator and add translator property to Context

Author: EvieePy

twitchio/ext/commands/context.py

@@ -256,6 +256,15 @@ def type(self) -> ContextType:
         """
         return self._type
 
+    @property
+    def translator(self) -> Translator[Any] | None:
+        """Property returning the :class:`.commands.Translator` assigned to the :class:`.commands.Command` if found or
+        ``None``. This property will always return ``None`` if no valid command or prefix is associated with this Context."""
+        if not self.command:
+            return None
+
+        return self.command.translator
+
     @property
     def error_dispatched(self) -> bool:
         return self._error_dispatched
@@ -594,7 +603,7 @@ async def send_translated(self, content: str, *, me: bool = False, langcode: str
         TranslatorError
             An error occurred during translation.
         """
-        translator: Translator | None = getattr(self.command, "translator", None)
+        translator: Translator[Any] | None = self.translator
         new = (f"/me {content}" if me else content).strip()
 
         if not self.command or not translator:
@@ -722,7 +731,7 @@ async def reply_translated(self, content: str, *, me: bool = False, langcode: st
         if self._type is ContextType.REWARD:
             raise TypeError("Cannot reply to a message in a Reward based context.")
 
-        translator: Translator | None = getattr(self.command, "translator", None)
+        translator: Translator[Any] | None = self.translator
         new = (f"/me {content}" if me else content).strip()
 
         if not self.command or not translator:

twitchio/ext/commands/core.py

@@ -225,11 +225,11 @@ 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)
+        translator: Translator[Any] | type[Translator[Any]] | None = getattr(callback, "__command_translator__", None)
         if translator and inspect.isclass(translator):
             translator = translator()
 
-        self._translator: Translator | None = translator
+        self._translator: Translator[Any] | None = translator
 
         self._help: str = callback.__doc__ or ""
         self.__doc__ = self._help
@@ -271,7 +271,7 @@ def _get_signature(self) -> None:
         self._signature = help_sig
 
     @property
-    def translator(self) -> Translator | None:
+    def translator(self) -> Translator[Any] | None:
         """Property returning the :class:`.commands.Translator` associated with this command or ``None`` if one was not
         used.
         """
@@ -1482,7 +1482,7 @@ def wrapper(
         return wrapper
 
 
-def translator(cls: Translator | type[Translator]) -> Any:
+def translator(cls: Translator[Any] | type[Translator[Any]]) -> Any:
     """|deco|
 
     Decorator which adds a :class:`.commands.Translator` to a :class:`.commands.Command`.

twitchio/ext/commands/translators.py

@@ -25,17 +25,20 @@
 from __future__ import annotations
 
 import abc
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, Generic, TypeVar
 
 
 if TYPE_CHECKING:
     from .context import Context
 
 
+T = TypeVar("T")
+
+
 __all__ = ("Translator",)
 
 
-class Translator(abc.ABC):
+class Translator(Generic[T], abc.ABC):
     """Abstract Base Class for command translators.
 
     This class allows you to implement logic to translate messages sent via the :meth:`.commands.Context.send_translated`
@@ -49,16 +52,16 @@ class Translator(abc.ABC):
     """
 
     @abc.abstractmethod
-    def get_langcode(self, ctx: Context[Any], name: str) -> str | None:
+    def get_langcode(self, ctx: Context[Any], name: str) -> T | None:
         """Method which is called when :meth:`.commands.Context.send_translated` is used on a :class:`.commands.Command`
         which has an associated Translator, to determine the ``langcode`` which should be passed to :meth:`.translate` or ``None``
         if the content should not be translated.
 
-        By default the ``name`` or ``alias`` used to invoke the command is passed alongside :class:`.commands.Context` to aid in
-        determining the ``langcode`` you should use.
+        By default the lowercase ``name`` or ``alias`` used to invoke the command is passed alongside :class:`.commands.Context`
+        to aid in determining the ``langcode`` you should use.
 
-        You can use any system for the language codes, however they must be a :class:`str`. We also recommend using a
-        recognized system such as the ``ISO 639`` language code format.
+        You can use any format or type for the language codes. We recommend using a recognized system such as the ``ISO 639``
+        language code format as a :class:`str`.
 
         Parameters
         ----------
@@ -70,8 +73,10 @@ def get_langcode(self, ctx: Context[Any], name: str) -> str | None:
 
         Returns
         -------
-        str
-            The language code as a :class:`str` to pass to :meth:`.translate`.
+        Any
+            The language code to pass to :meth:`.translate`.
+        None
+            No translation attempt should be made with :meth:`.translate`.
 
         Example
         -------
@@ -81,7 +86,7 @@ def get_langcode(self, ctx: Context[Any], name: str) -> str | None:
             # For example purposes only the "get_langcode" method is shown in this example...
             # The "translate" method must also be implemented...
 
-            class HelloTranslator(commands.Translator):
+            class HelloTranslator(commands.Translator[str]):
                 def __init__(self) -> None:
                     self.code_mapping = {"hello": "en", "bonjour": "fr"}
 
@@ -98,7 +103,7 @@ async def hello_command(ctx: commands.Context) -> None:
         """
 
     @abc.abstractmethod
-    async def translate(self, ctx: Context[Any], text: str, langcode: str) -> str:
+    async def translate(self, ctx: Context[Any], text: str, langcode: T) -> str:
         """|coro|
 
         Method used to translate the content passed to :meth:`.commands.Context.send_translated` with the language code returned from
@@ -116,7 +121,7 @@ async def translate(self, ctx: Context[Any], text: str, langcode: str) -> str:
             The context surrounding the command invocation.
         text: str
             The content passed to :meth:`~.commands.Context.send_translated` which should be translated.
-        langcode: str
+        langcode: Any
             The language code returned via :meth:`.get_langcode`, which can be used to determine the language the text should
             be translated to.
 
@@ -133,7 +138,7 @@ async def translate(self, ctx: Context[Any], text: str, langcode: str) -> str:
             # For example purposes only the "translate" method is shown in this example...
             # The "get_langcode" method must also be implemented...
 
-            class HelloTranslator(commands.Translator):
+            class HelloTranslator(commands.Translator[str]):
 
                 async def translate(self, ctx: commands.Context, text: str, langcode: str) -> str:
                     # Usually you would call an API, or retrieve from a database or dict or some other solution...