Changes
Jump to navigation
Jump to search
Development Team/Almanac/Internationalization (view source)
Revision as of 15:36, 17 July 2008
, 15:36, 17 July 2008no edit summary
== Broad Steps to Internationalize/Localize Your Code ==
# === Step 1: ===
# === Step 2: ===
=== How do I ensure that a text string is correctly translated to another language when appropriate (for internationalization)? ===
To ensure that string output from your activity is correctly translated, you would use the gettext utility. The code below imports gettext, renaming it as '_' for code brevity. Then, whenever there is a string that you want to make sure is translated based on language settings, you simply pass it to the _() function. According to the [http://docs.python.org/lib/node731.html Python Reference Library], gettext will "return the localized translation of message, based on the current global domain, language, and locale directory."
from gettext import gettext as _
...
#Make sure 'hello world' translates
print _('hello world')
=== How do I ensure that using gettext does not crash my activity, especially when I try to translate more complex string substitution? ===
Since some strings require variables to be substituted into them, they need to be translated carefully. If they're not translated correctly, trying to do a string substitution can crash your activity.
The code below redefines the _() to use the gettext method only if gettext actually works. If there is an exception, the code will simply return the untranslated string. This ensures that instead of crashing, your activity will simply not translate your string.
<pre>
#Do the import of the gettext, but do not give it the underscore alias
from gettext import gettext
...
#defensive method against variables not translated correctly
def _(s):
#todo: permanent variable
istrsTest = {}
for i in range (0,4):
istrsTest[str(i)] = str(i)
#try to use gettext. If it fails, then just return the string untranslated.
try:
#test translating the string with many replacements
i = gettext(s)
test = i % istrsTest
print test
except:
#if it doesn't work, revert
i = s
return i
...
#Now we can use the _() function and it should not crash if gettext fails.
substitutionMap = {}
substitutionMap[str(1)] = 'one'
substitutionMap[str(2)] = 'two'
substitutionMap[str(3)] = 'three'
print _("Lets count to three: %(1)s, %(2)s, %(3)s") % substitutionMap
</pre>
= Additional Resources =
[http://wiki.laptop.org/go/Localization Sugar Localization]
[http://wiki.laptop.org/go/Python_i18n Python i18n]
# === Step 1: ===
# === Step 2: ===
=== How do I ensure that a text string is correctly translated to another language when appropriate (for internationalization)? ===
To ensure that string output from your activity is correctly translated, you would use the gettext utility. The code below imports gettext, renaming it as '_' for code brevity. Then, whenever there is a string that you want to make sure is translated based on language settings, you simply pass it to the _() function. According to the [http://docs.python.org/lib/node731.html Python Reference Library], gettext will "return the localized translation of message, based on the current global domain, language, and locale directory."
from gettext import gettext as _
...
#Make sure 'hello world' translates
print _('hello world')
=== How do I ensure that using gettext does not crash my activity, especially when I try to translate more complex string substitution? ===
Since some strings require variables to be substituted into them, they need to be translated carefully. If they're not translated correctly, trying to do a string substitution can crash your activity.
The code below redefines the _() to use the gettext method only if gettext actually works. If there is an exception, the code will simply return the untranslated string. This ensures that instead of crashing, your activity will simply not translate your string.
<pre>
#Do the import of the gettext, but do not give it the underscore alias
from gettext import gettext
...
#defensive method against variables not translated correctly
def _(s):
#todo: permanent variable
istrsTest = {}
for i in range (0,4):
istrsTest[str(i)] = str(i)
#try to use gettext. If it fails, then just return the string untranslated.
try:
#test translating the string with many replacements
i = gettext(s)
test = i % istrsTest
print test
except:
#if it doesn't work, revert
i = s
return i
...
#Now we can use the _() function and it should not crash if gettext fails.
substitutionMap = {}
substitutionMap[str(1)] = 'one'
substitutionMap[str(2)] = 'two'
substitutionMap[str(3)] = 'three'
print _("Lets count to three: %(1)s, %(2)s, %(3)s") % substitutionMap
</pre>
= Additional Resources =
[http://wiki.laptop.org/go/Localization Sugar Localization]
[http://wiki.laptop.org/go/Python_i18n Python i18n]