Add i18n_override, which enables users to override default i18n messages

Author: ALCC01

botogram/bot.py

@@ -59,6 +59,7 @@ def __init__(self, api_connection):
 
         self._lang = ""
         self._lang_inst = None
+        self.override_i18n = {}
 
         # Support for the old, deprecated bot.hide_commands
         self._hide_commands = []
@@ -273,7 +274,7 @@ def freeze(self):
                                    self._commands, chains, self._scheduler,
                                    self._main_component._component_id,
                                    self._bot_id, self._shared_memory,
-                                   self._update_processors)
+                                   self._update_processors, self.override_i18n)
 
     @property
     def lang(self):

botogram/frozenbot.py

@@ -36,7 +36,7 @@ def __init__(self, api, about, owner, hide_commands, before_help,
                  after_help, link_preview_in_help,
                  validate_callback_signatures, process_backlog, lang, itself,
                  commands_re, commands, chains, scheduler, main_component_id,
-                 bot_id, shared_memory, update_processors):
+                 bot_id, shared_memory, update_processors, override_i18n):
         # This attribute should be added with the default setattr, because is
         # needed by the custom setattr
         object.__setattr__(self, "_frozen", False)
@@ -61,6 +61,7 @@ def __init__(self, api, about, owner, hide_commands, before_help,
         self._update_processors = update_processors
         self._commands = {name: command.for_bot(self)
                           for name, command in commands.items()}
+        self.override_i18n = override_i18n
 
         # Setup the logger
         self.logger = logbook.Logger('botogram bot')
@@ -82,7 +83,7 @@ def __reduce__(self):
             self.validate_callback_signatures, self.process_backlog, self.lang,
             self.itself, self._commands_re, self._commands, self._chains,
             self._scheduler, self._main_component_id, self._bot_id,
-            self._shared_memory, self._update_processors,
+            self._shared_memory, self._update_processors, self.override_i18n
         )
         return restore, args
 
@@ -240,7 +241,12 @@ def register_update_processor(self, kind, processor):
 
     def _(self, message, **args):
         """Translate a string"""
-        return self._lang_inst.gettext(message) % args
+        # Check if the message has been overridden
+        if message in self.override_i18n:
+            return self.override_i18n[message] % args
+        # Otherwise try to return the original message
+        else:
+            return self._lang_inst.gettext(message) % args
 
     # And some internal methods used by botogram
 

tests/test_bot.py

@@ -22,6 +22,7 @@
 
 import botogram.bot
 import botogram.components
+import botogram.utils
 
 import conftest
 
@@ -76,3 +77,17 @@ def test_bot_freeze(bot):
     frozen = bot.freeze()
 
     assert bot == frozen
+
+def test_i18n_override(bot):
+    default_message = botogram.utils.get_language("en").gettext("Use /help to get a list of all the commands.")
+    override_message = "git gud"
+
+    bot.override_i18n = {
+        default_message: override_message
+    }
+
+    assert bot._("Use /help to get a list of all the commands.") == "git gud"
+
+    bot.override_i18n = {}
+
+    assert bot._("Use /help to get a list of all the commands.") == default_message