Allow users to programmatically override default i18n strings #91
Conversation
There was a problem hiding this comment.
Thank you for this PR, and welcome!
There are a few nitpicks in the code you sent, but more importantly the new feature is missing documentation and a changelog line. You can either just add the API docs for the attribute, or also write a narrative chapter about i18n.
Looking forward to merge this!
botogram/frozenbot.py
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
Missing a comma after the last element (so it's easier to add new arguments here)
tests/test_bot.py
Outdated
| @@ -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.") | |||
There was a problem hiding this comment.
The line is too long, can you make it fit into 80 chars (maybe splitting it)?
tests/test_bot.py
Outdated
| default_message: override_message | ||
| } | ||
|
|
||
| assert bot._("Use /help to get a list of all the commands.") == "git gud" |
There was a problem hiding this comment.
Here you should use the variable you defined earlier.
tests/test_bot.py
Outdated
|
|
||
| bot.override_i18n = {} | ||
|
|
||
| assert bot._("Use /help to get a list of all the commands.") == default_message |
There was a problem hiding this comment.
This line is also too long.
| A dictionary that allows to override default i18n messages by associating | ||
| the default ``msgid`` string of a message with its alternative. | ||
|
|
||
| .. versionadded:: 0.4.1 |
There was a problem hiding this comment.
Since it's a new feature it probably will be added in 0.5
There was a problem hiding this comment.
Yep, but I'll tweak the changelog myself after merging, don't worry.
|
Thank you for this pull request, I merged it! About the narrative documentation, #85 isn't a blocker for that: the language_code thing can be added later when it's implemented. And thanks for considering writing it, more documentation is badly needed. |
|
Done. |
Implements the API set out in #47 to allow botogram users to override i18n messages without the need to recompile the
.pofiles. This change may conflict with #85, but the PR looks pretty dead. This also contributes towards the completion of the #46 roadmap.When the
FrozenBot._method is called it will first look up themsgidin thei18n_overridemap, before falling back to_lang_inst.gettext. This actually allows users to define custom messages stored in the bot instance and is independent from the language the bot is using.While not strictly related to #47,
.pofiles have been rebuilt from sources as they were missing some new messages and used outdated references.