Jak začlenit do programu podporu lokalizace

Určitě jste si už v Linuxu všimli skvělého systému na překlad aplikací Gettext. Stáhnete si .po soubor s překladem, přeložíte, co můžete, odešlete zpátky autorovi programu a v nové verzi už je vaše čeština oficiálním překladem. Launchpad.net dokonce umožňuje překládat přímo online. Jednoduché, efektivní. Jak ale podporu pro lokalizaci začlenit do vlastních aplikací napsaných v Pythonu a PyGtk? To jest téma tohoto článku.

Příprava

Pusťme se tedy do toho. Začlenění překladu budu demonstrovat na souborech gui.glade s uživatelským rozhraním a main.py, který načte a zobrazí toto rozhraní a v případě neúspěchu vypíše chybovou hlášku:

1. #!/usr/bin/python
2. # -*- coding: utf-8 -*-
3. import gtk
4. import sys
6. class LocalizationExample:
7.     def __init__(self):
8.         # use GtkBuilder to build our interface from the XML file
9.         try:
10.             builder = gtk.Builder()
11.             builder.add_from_file('gui.glade')
12.         except:
13.             self.error_message("Can't load the glade file with user interface: gui.glade")
14.             sys.exit(1)
15.        
16.         # get the widgets which will be referenced in callbacks
17.         self.window = builder.get_object("window")
19.         # connect signals
20.         builder.connect_signals(self)
22.     def main (self):
23.         # Run main window of the app
24.         self.window.show()
25.         gtk.main()
27.     def on_window_delete (self, *args):
28.         gtk.main_quit()
30. if __name__ == "__main__":
31.     le = LocalizationExample()
32.     le.main()

Úprava main.py

Pro začlenění podpory pro lokalizaci je potřeba mírně pozměnit původní soubor main.py. Na začátek souboru přidáme:

1. import gettext
2. import locale
4. APP = "locex"
5. DIR = 'locale'
7. locale.setlocale(locale.LC_ALL, '')
8. gettext.bindtextdomain(APP, DIR)
9. locale.bindtextdomain(APP, DIR)
10. gettext.textdomain(APP)
11. locale.textdomain(APP)
12. _ = gettext.gettext

Všimněte si konstanty APP = "locex". Nastavuje jakýsi jmenný prostor překladu. Není důležité jakou hodnotu zadáte, každopádně zapamatujte si ji, protože ji za chvíli budeme potřebovat.

Dále také musíme každý řetězec, který chceme přeložit, pozměnit z "řetězec" na _("řetězec"). Náš finální soubor bude tedy po úpravě vypadat takto:

1. #!/usr/bin/python
2. # -*- coding: utf-8 -*-
3. import gtk
4. import sys
6. import gettext
7. import locale
9. APP = "locex"
10. DIR = 'locale'
12. locale.setlocale(locale.LC_ALL, '')
13. gettext.bindtextdomain(APP, DIR)
14. locale.bindtextdomain(APP, DIR)
15. gettext.textdomain(APP)
16. locale.textdomain(APP)
17. _ = gettext.gettext
19. class LocalizationExample:
20.     def __init__(self):
21.         # use GtkBuilder to build our interface from the XML file
22.         try:
23.             builder = gtk.Builder()
24.             builder.add_from_file('gui.glade')
25.         except:
26.             self.error_message(_("Can't load the glade file with user interface: gui.glade"))
27.             sys.exit(1)
28.        
29.         # get the widgets which will be referenced in callbacks
30.         self.window = builder.get_object("window")
32.         # connect signals
33.         builder.connect_signals(self)
35.     def main (self):
36.         # Run main window of the app
37.         self.window.show()
38.         gtk.main()
40.     def on_window_delete (self, *args):
41.         gtk.main_quit()
43. if __name__ == "__main__":
44.     le = LocalizationExample()
45.     le.main()

Nyní můžeme soubor uložit a zavřít.

Příprava .pot šablony

Vzhledem k tomu, že gettext neumí pracovat přímo s .glade soubory, použijeme intltool-extract k vygenerování pomocného .glade.h souboru. Otevřeme si Terminál ve složce s programem a zadáme:

intltool-extract --type=gettext/glade gui.glade

Nyní si vytvoříme složku na .po soubory s překlady a necháme do něj vygenerovat .pot šablonu ze souborů main.py a gui.glade.h:

mkdir po
xgettext --language=Python --keyword=_ --keyword=N_ --output=po/template.pot main.py gui.glade.h

Volitelně můžeme přidat také parametry --package-name=NÁZEV a --package-version=VERZE, které se zapíšou do výsledného .pot souboru:

xgettext --language=Python --keyword=_ --keyword=N_ --package-name=LocalizationTest --package-version=0.1 --output=po/template.pot main.py gui.glade.h

Vytvoření souboru pro překlad

Překladový soubor pro konkrétní jazyk vytvoříme zadáním příkazu msginit --input=template.pot --locale=/kód jazyku/ ve složce se šablonou. Pokud chceme vytvořit soubor pro češtinu, bude to:

cd po
msginit --input=template.pot --locale=cs_CZ

Ve složce po se nám vytvoří soubor cs.po, který můžeme otevřít buďto v obyčejném textovém editoru, nebo třeba v Gtranslatoru. Přeložíme tedy všechny řetězce, soubor uložíme a pokračujeme k poslednímu kroku, kterým bude vytvoření .mo souboru.

Binární .mo soubory

.mo soubory jsou v podstatě binární verze .po souborů využívané gettext modulem k lokalizaci. Nejdříve ale musíme pro tyto soubory vytvořit patřičné složky. Přejdeme v terminálu do umístění se souborem main.py a spol. a zadáme:

mkdir -p locale/cs_CZ/LC_MESSAGES

Nakonec vytvoříme .mo soubory příkazem:

msgfmt --output-file=locale/cs_CZ/LC_MESSAGES/locex.mo po/cs.po

Všimněte si, že je .mo soubor pojmenovaný podle konstanty, kterou jsme nastavovali v souboru main.py. Nyní můžeme program vyzkoušet. Měl by být v češtině. Pokud ne, zkuste ho spusit s nastavením proměnné LANG:

LANG=cs_CZ.utf8 ./main.py

Můžete také program spustit v původní anglické verzi:

LANG=en_GB.utf8 ./main.py

Aktualizace překladu

Pokud v budoucnu upravíte zdrojový kód aplikace a přidáte nové řetězce, je potřeba aktualizovat soubory s překlady, abychom nepřišli o již přeložené řetězce.

Pokud máte v aplikaci zatím jenom jeden jazyk, asi bude nejjednodušším řešením ve složce s aplikací vždy spustit tento skript:

1. #!/bin/bash
2. intltool-extract --type=gettext/glade gui.glade
3. xgettext --language=Python --keyword=_ --keyword=N_ --output=po/template.pot main.py gui.glade.h
4. cd po
5. msgmerge -U cs.po template.pot
6. cd ..
7. mkdir -p locale/cs_CZ/LC_MESSAGES/
8. msgfmt po/cs.po -o locale/cs_CZ/LC_MESSAGES/locex.mo

U jiných aplikací by bylo samozřejmě nutné skript upravit na odpovídající názvy souborů.

Finální struktura

(main_without_loc.py není potřeba...)

Odkazy

• Translating your Python/PyGTK application - anglický článek ze kterého jsem nejvíce čerpal
• Oficiální stránky Gettext
• Stránky Pythonu