Internationalize a Python application - Revision history

103.14.248.31: /* Configure gettext Define the '_()' function */

2016-05-04T09:43:18Z

Configure gettext Define the '_()' function

← Older revision		Revision as of 09:43, 4 May 2016
Line 21:		Line 21:

	Ok, this is what we need to do. Let's code.		Ok, this is what we need to do. Let's code.

	~~== Configure gettext Define the '_()' function ==~~

	If you don't care too much about the details, just copy this [https://garage.maemo.org/plugins/ggit/browse.php/?p=mussorgsky;a=blob;f=src/i18n.py;hb=HEAD i18n.py] file in your src/ directory ('''change the APP_NAME''' variable there!), or copy the code block below into a file i18n.py:
	~~<source lang="python">~~
	~~# -- coding: utf-8 --~~

	~~import os, sys~~
	~~import locale~~
	~~import gettext~~

	~~# Change this variable to your app name!~~
	~~# The translation files will be under~~
	~~# @LOCALE_DIR@/@LANGUAGE@/LC_MESSAGES/@APP_NAME@.mo~~
	~~APP_NAME = "SleepAnalyser"~~

	~~# This is ok for maemo. Not sure in a regular desktop:~~
	~~#APP_DIR = os.path.join (sys.prefix, 'share')~~
	~~LOCALE_DIR = os.path.join(APP_DIR, 'i18n') # .mo files will then be located in APP_Dir/i18n/LANGUAGECODE/LC_MESSAGES/~~

	~~# Now we need to choose the language. We will provide a list, and gettext~~
	~~# will use the first translation available in the list~~
	#
	~~# In maemo it is in the LANG environment variable~~
	~~# (on desktop is usually LANGUAGES)~~
	~~DEFAULT_LANGUAGES = os.environ.get('LANG', '').split(':')~~
	~~DEFAULT_LANGUAGES += ['en_US']~~

	~~lc, encoding = locale.getdefaultlocale()~~
	~~if lc:~~
	~~languages = [lc]~~

	~~# Concat all languages (env + default locale),~~
	~~# and here we have the languages and location of the translations~~
	~~languages += DEFAULT_LANGUAGES~~
	~~mo_location = LOCALE_DIR~~

	~~# Lets tell those details to gettext~~
	~~# (nothing to change here for you)~~
	~~gettext.install(True, localedir=None, unicode=1)~~

	~~gettext.find(APP_NAME, mo_location)~~

	~~gettext.textdomain (APP_NAME)~~

	~~gettext.bind_textdomain_codeset(APP_NAME, "UTF-8")~~

	~~language = gettext.translation(APP_NAME, mo_location, languages=languages, fallback=True)~~
	~~</source>~~



	~~And in '''every .py''' file that needs to translate any string, add these lines at the top:~~
	~~<source lang="python">~~
	~~import i18n~~
	~~_ = i18n.language.ugettext #use ugettext instead of getttext to avoid unicode errors~~
	~~</source>~~
	~~Done. If you are curious about what is going on there, the file has plenty of comments explaining every line.~~

	== Mark strings for i18n ==		== Mark strings for i18n ==

103.14.248.31: /* Generate template for the translators */

2016-05-04T09:42:46Z

Generate template for the translators

@@ Line 96: / Line 96: @@
         self.set_title ( _("All music") )   <------- ADD THIS!
 </source>
 == How to add translations ==

103.14.248.31: /* Include translations in your installation */

2016-05-04T09:42:11Z

Include translations in your installation

← Older revision		Revision as of 09:42, 4 May 2016
Line 141:		Line 141:

	If you don't know the locale of a language, can check [http://www.roseindia.net/tutorials/I18N/locales-list.shtml www.roseindia.net/tutorials/I18N/locales-list.shtml] or [http://people.w3.org/rishida/utils/subtags/ people.w3.org/rishida/utils/subtags].		If you don't know the locale of a language, can check [http://www.roseindia.net/tutorials/I18N/locales-list.shtml www.roseindia.net/tutorials/I18N/locales-list.shtml] or [http://people.w3.org/rishida/utils/subtags/ people.w3.org/rishida/utils/subtags].

	~~== Include translations in your installation ==~~
	~~Here again are several ways of doing it. I suggest to do it the automatic way as it is way easier if you have scratchbox.~~
	~~=== Automatic way ===~~
	If you already have the .tar.gz file, then you already have the structure with the files. Just unpack the .tar.gz file into a folder. If you have to pack it for the first time, MohammadAG has a good page about how to generate the needed files: [[User:Mohammad7410/Packaging]]

	Now you will have to add some basic lines to the debian/rules file.Under the line with "install: build" should be many lines with "<code>mkdir</code>" and "<code>cp -a</code>". After the last one of them, add those two lines:

	~~#compile language files with msgfmt~~
	~~msgfmt src/opt/PROJECTNAME/i18n/de.po --output-file debian/PROJECTNAME/opt/PROJECTNAME/i18n/de/LC_MESSAGES/PROJECTNAME.mo~~
	~~This will tell the autobuilder to generate the .mo files. You will need a line like that for every language!~~
	~~Don't forget to adapt the file paths. In the example the .mo files are in the sub folder i18n/de/LC_MESSAGES/~~

	~~=== Python way ===~~
	This part is more tricky, because it depends on your build system. I'll explain how it goes with the common python 'distutils' (what makes the usual ''<code>python setup.py install</code>'' command work). In distutils all the magic happens in the ''<code>setup.py</code>'' file.

	~~First of all, if in the previous steps you have added the <code>i18n.py</code> file to your source tree, don't forget to include it in your <code>data_files</code> list!~~

	Then, copy to the root folder of your project the file [https://garage.maemo.org/plugins/ggit/browse.php/?p=mussorgsky;a=blob;f=msgfmt.py;hb=HEAD msgfmt.py]. It is a program that translates the .po files into the binary .mo files that the application needs.

	In your <code>setup.py</code> file you need to add all this code. It "overloads" the default 'build' and 'install' instructions to include the translations in the process. Now in 'build' time it will generate the .mo files (using the <code>msgfmt.py</code> we added just now), and in 'install' time it will include the '<code>.mo</code>' files in the <code>data_files</code> list. The code is copied from this a [https://garage.maemo.org/plugins/ggit/browse.php/?p=mussorgsky;a=blob;f=setup.py;hb=HEAD setup.py] file.

	~~<source lang="python">~~
	~~from distutils.core import setup~~
	~~from distutils import cmd~~
	~~from distutils.command.install_data import install_data as _install_data~~
	~~from distutils.command.build import build as _build~~

	~~import msgfmt~~
	~~import os~~
	~~</source>~~
	~~This command compiles every <code>.po</code> file under the <code>po/</code> folder into a <code>.mo</code> (the <code>.mo</code> files will be under <code>build/locale/</code>)~~
	~~<source lang="python">~~
	~~class build_trans(cmd.Command):~~
	~~description = 'Compile .po files into .mo files'~~
	~~def initialize_options(self):~~
	~~pass~~

	~~def finalize_options(self):~~
	~~pass~~

	~~def run(self):~~
	~~po_dir = os.path.join(os.path.dirname(os.curdir), 'po')~~
	~~for path, names, filenames in os.walk(po_dir):~~
	~~for f in filenames:~~
	~~if f.endswith('.po'):~~
	~~lang = f[:-3]~~
	~~src = os.path.join(path, f)~~
	~~dest_path = os.path.join('build', 'locale', lang, 'LC_MESSAGES')~~
	~~dest = os.path.join(dest_path, 'mussorgsky.mo')~~
	~~if not os.path.exists(dest_path):~~
	~~os.makedirs(dest_path)~~
	~~if not os.path.exists(dest):~~
	~~print 'Compiling %s' % src~~
	~~msgfmt.make(src, dest)~~
	~~else:~~
	~~src_mtime = os.stat(src)[8]~~
	~~dest_mtime = os.stat(dest)[8]~~
	~~if src_mtime > dest_mtime:~~
	~~print 'Compiling %s' % src~~
	~~msgfmt.make(src, dest)~~
	~~</source>~~
	~~Now we append the previous command to the 'build' command.~~
	~~<source lang="python">~~
	~~class build(_build):~~
	~~sub_commands = _build.sub_commands + [('build_trans', None)]~~
	~~def run(self):~~
	~~_build.run(self)~~
	~~</source>~~
	~~Installation time: put every <code>.mo</code> file under <code>build/locale</code> in the <code>data_files</code> list (the list of things to be installed) and call the default 'install' operation~~
	~~<source lang="python">~~
	~~class install_data(_install_data):~~

	~~def run(self):~~
	~~for lang in os.listdir('build/locale/'):~~
	~~lang_dir = os.path.join('share', 'locale', lang, 'LC_MESSAGES')~~
	~~lang_file = os.path.join('build', 'locale', lang, 'LC_MESSAGES', 'mussorgsky.mo')~~
	~~self.data_files.append( (lang_dir, [lang_file]) )~~
	~~_install_data.run(self)~~
	~~</source>~~
	~~Finally, add the new commands in distutils...~~
	~~<source lang="python">~~
	~~cmdclass = {~~
	~~'build': build,~~
	~~'build_trans': build_trans,~~
	~~'install_data': install_data,~~
	}
	~~</source>~~
	~~And don't forget to add this in your setup function, in the <code>setup.py</code>~~
	~~<source lang="python">~~
	~~setup(name = 'your project',~~
	~~...~~
	~~license = 'GPL v2 or later',~~
	~~data_files = DATA,~~
	~~scripts = SCRIPTS,~~
	~~cmdclass = cmdclass <----- DON'T FORGET THIS~~
	)
	~~</source>~~
	~~Ok, now everything should be ready. If you run~~

	~~python2.5 setup.py build~~

	~~the terminal will print things like~~

	~~compiling es.po~~
	~~compiling de.po~~
	~~...~~

	~~Usually <code>dpkg-buildpackage</code> uses <code>python2.5 setup.py build</code> and <code>install</code>, so everything should work out-of-the-box with your previous package configuration.~~

	~~Feel free to complete/correct this wiki page with your own experience.~~

	~~[[Category:Internationalization]]~~
	~~[[Category:Development]]~~
	~~[[Category:HowTo]]~~
	~~[[Category:Python]]~~

209.121.191.146: /* Configure gettext Define the '_()' function */

2013-04-05T21:17:58Z

Configure gettext Define the '_()' function

← Older revision		Revision as of 21:17, 5 April 2013
Line 60:		Line 60:
	# Lets tell those details to gettext		# Lets tell those details to gettext
	# (nothing to change here for you)		# (nothing to change here for you)
	gettext.install (True,localedir=None, unicode=1)		gettext.install(True, localedir=None, unicode=1)

	gettext.find(APP_NAME, mo_location)		gettext.find(APP_NAME, mo_location)
Line 68:		Line 68:
	gettext.bind_textdomain_codeset(APP_NAME, "UTF-8")		gettext.bind_textdomain_codeset(APP_NAME, "UTF-8")

	language = gettext.translation (APP_NAME, mo_location, languages = languages, fallback = True)		language = gettext.translation(APP_NAME, mo_location, languages=languages, fallback=True)
	</source>		</source>

143.167.245.36: Simplify example code slightly

2012-09-03T22:16:33Z

Simplify example code slightly

← Older revision		Revision as of 22:16, 3 September 2012
Line 187:		Line 187:
	for f in filenames:		for f in filenames:
	if f.endswith('.po'):		if f.endswith('.po'):
	lang = f[:~~len(f)~~ - 3]		lang = f[:-3]
	src = os.path.join(path, f)		src = os.path.join(path, f)
	dest_path = os.path.join('build', 'locale', lang, 'LC_MESSAGES')		dest_path = os.path.join('build', 'locale', lang, 'LC_MESSAGES')

imported_>caco3: /* Configure gettext Define the '_()' function */

2010-12-20T14:11:00Z

Configure gettext Define the '_()' function

← Older revision		Revision as of 14:11, 20 December 2010
Line 39:		Line 39:
	# This is ok for maemo. Not sure in a regular desktop:		# This is ok for maemo. Not sure in a regular desktop:
	#APP_DIR = os.path.join (sys.prefix, 'share')		#APP_DIR = os.path.join (sys.prefix, 'share')
	LOCALE_DIR = os.path.join(APP_DIR, '~~locale~~') # .mo files will then be located in APP_Dir/~~locale~~/LANGUAGECODE/LC_MESSAGES/		LOCALE_DIR = os.path.join(APP_DIR, 'i18n') # .mo files will then be located in APP_Dir/i18n/LANGUAGECODE/LC_MESSAGES/

	# Now we need to choose the language. We will provide a list, and gettext		# Now we need to choose the language. We will provide a list, and gettext

imported_>caco3: /* Configure gettext Define the '_()' function */

2010-12-20T14:10:09Z

Configure gettext Define the '_()' function

← Older revision		Revision as of 14:10, 20 December 2010
Line 25:		Line 25:

	If you don't care too much about the details, just copy this [https://garage.maemo.org/plugins/ggit/browse.php/?p=mussorgsky;a=blob;f=src/i18n.py;hb=HEAD i18n.py] file in your src/ directory ('''change the APP_NAME''' variable there!), or copy the code block below into a file i18n.py:		If you don't care too much about the details, just copy this [https://garage.maemo.org/plugins/ggit/browse.php/?p=mussorgsky;a=blob;f=src/i18n.py;hb=HEAD i18n.py] file in your src/ directory ('''change the APP_NAME''' variable there!), or copy the code block below into a file i18n.py:
	<source>		<source lang="python">
	# -- coding: utf-8 --		# -- coding: utf-8 --

imported_>caco3: /* Configure gettext Define the '_()' function */

2010-12-20T14:09:47Z

Configure gettext Define the '_()' function

← Older revision		Revision as of 14:09, 20 December 2010
Line 25:		Line 25:

	If you don't care too much about the details, just copy this [https://garage.maemo.org/plugins/ggit/browse.php/?p=mussorgsky;a=blob;f=src/i18n.py;hb=HEAD i18n.py] file in your src/ directory ('''change the APP_NAME''' variable there!), or copy the code block below into a file i18n.py:		If you don't care too much about the details, just copy this [https://garage.maemo.org/plugins/ggit/browse.php/?p=mussorgsky;a=blob;f=src/i18n.py;hb=HEAD i18n.py] file in your src/ directory ('''change the APP_NAME''' variable there!), or copy the code block below into a file i18n.py:
	~~[code]~~		<source>
	# -- coding: utf-8 --		# -- coding: utf-8 --

Line 69:		Line 69:

	language = gettext.translation (APP_NAME, mo_location, languages = languages, fallback = True)		language = gettext.translation (APP_NAME, mo_location, languages = languages, fallback = True)
	[/~~code]~~		</source>



	~~and~~ in '''every .py''' file ~~in your module~~ that needs to translate any string, add these lines at the top:		And in '''every .py''' file that needs to translate any string, add these lines at the top:
	<source lang="python">		<source lang="python">
	import i18n		import i18n

imported_>caco3: /* Configure gettext Define the '_()' function */

2010-12-20T14:08:55Z

Configure gettext Define the '_()' function

@@ Line 24: / Line 24: @@
 == Configure gettext Define the '_()' function ==
-If you don't care too much about the details, just copy this [https://garage.maemo.org/plugins/ggit/browse.php/?p=mussorgsky;a=blob;f=src/i18n.py;hb=HEAD i18n.py] file in your src/ directory ('''change the APP_NAME''' variable there!), and in every .py file in your module that needs to translate any string, add these lines at the top:
+If you don't care too much about the details, just copy this [https://garage.maemo.org/plugins/ggit/browse.php/?p=mussorgsky;a=blob;f=src/i18n.py;hb=HEAD i18n.py] file in your src/ directory ('''change the APP_NAME''' variable there!), or copy the code block below into a file i18n.py:
 <source lang="python">
 import i18n

imported_>caco3: /* Manual way */

2010-12-20T13:59:19Z

Manual way

← Older revision		Revision as of 13:59, 20 December 2010
Line 91:		Line 91:
	"Content-Type: text/plain; charset=utf-8\n" <--- THIS MUST BE UTF-8		"Content-Type: text/plain; charset=utf-8\n" <--- THIS MUST BE UTF-8

	If you don't know the locale of a language, can check [http://www.roseindia.net/tutorials/I18N/locales-list.shtml ~~this~~ list] or [http://people.w3.org/rishida/utils/subtags/].		If you don't know the locale of a language, can check [http://www.roseindia.net/tutorials/I18N/locales-list.shtml www.roseindia.net/tutorials/I18N/locales-list.shtml] or [http://people.w3.org/rishida/utils/subtags/ people.w3.org/rishida/utils/subtags].

	== Include translations in your installation ==		== Include translations in your installation ==