python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2026-04-08 16:37:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

I18n example patch (added docs and fixed typos) (#419)

Browse source 
* Update i18n example

1. Replaced one file translation to all project folder translation. It's more usable case. 
2. `For e.g.` --> `E.g.`. E.g. is short for `exempli gratia` which means simply “for example.” So if you write for e.g., you are in effect writing `for for example`. 
3. `xargs` replased with serveral lines, `xargs` is not appliable for Microsoft Windows users. 
4. Added info about translation tools. 
5. Minor edits.

* i18n middlaware typo fix

* i18n example header typo fix
This commit is contained in:
Oleg A 2020-09-10 22:32:56 +03:00 • committed by GitHub
parent 9ab2945267
commit 56ffa00c8c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
aiogram/contrib/middlewares/i18n.py
View file

@ -59,13 +59,13 @@ class I18nMiddleware(BaseMiddleware):
with open(mo_path, 'rb') as fp: with open(mo_path, 'rb') as fp:
translations[name] = gettext.GNUTranslations(fp) translations[name] = gettext.GNUTranslations(fp)
elif os.path.exists(mo_path[:-2] + 'po'): elif os.path.exists(mo_path[:-2] + 'po'):
raise RuntimeError(f"Found locale '{name} but this language is not compiled!") raise RuntimeError(f"Found locale '{name}' but this language is not compiled!")
return translations return translations
def reload(self): def reload(self):
""" """
Hot reload locles Hot reload locales
""" """
self.locales = self.find_locales() self.locales = self.find_locales()

19
examples/i18n_example.py
View file

@ -1,8 +1,8 @@
""" """
Internalize your bot Internationalize your bot
Step 1: extract texts Step 1: extract texts
# pybabel extract i18n_example.py -o locales/mybot.pot # pybabel extract --input-dirs=. -o locales/mybot.pot
Some useful options: Some useful options:
- Extract texts with pluralization support - Extract texts with pluralization support
@ -16,9 +16,14 @@ Step 1: extract texts
- Set version - Set version
# --version=2.2 # --version=2.2
Step 2: create *.po files. For e.g. create en, ru, uk locales. Step 2: create *.po files. E.g. create en, ru, uk locales.
# echo {en,ru,uk} | xargs -n1 pybabel init -i locales/mybot.pot -d locales -D mybot -l # pybabel init -i locales/mybot.pot -d locales -D mybot -l en
Step 3: translate texts # pybabel init -i locales/mybot.pot -d locales -D mybot -l ru
# pybabel init -i locales/mybot.pot -d locales -D mybot -l uk
Step 3: translate texts located in locales/{language}/LC_MESSAGES/mybot.po
To open .po file you can use basic text editor or any PO editor, e.g. https://poedit.net/
Step 4: compile translations Step 4: compile translations
# pybabel compile -d locales -D mybot # pybabel compile -d locales -D mybot
@ -27,7 +32,8 @@ Step 5: When you change the code of your bot you need to update po & mo files.
command from step 1 command from step 1
Step 5.2: update po files Step 5.2: update po files
# pybabel update -d locales -D mybot -i locales/mybot.pot # pybabel update -d locales -D mybot -i locales/mybot.pot
Step 5.3: update your translations Step 5.3: update your translations
location and tools you know from step 3
Step 5.4: compile mo files Step 5.4: compile mo files
command from step 4 command from step 4
""" """
@ -92,5 +98,6 @@ async def cmd_like(message: types.Message, locale):
# NOTE: This is comment for a translator # NOTE: This is comment for a translator
await message.reply(__('Aiogram has {number} like!', 'Aiogram has {number} likes!', likes).format(number=likes)) await message.reply(__('Aiogram has {number} like!', 'Aiogram has {number} likes!', likes).format(number=likes))
if __name__ == '__main__': if __name__ == '__main__':
executor.start_polling(dp, skip_updates=True) executor.start_polling(dp, skip_updates=True)