django i18n 實戰

最近在為的上線前專案做中文化的處理，在此留下一心得記錄。
就django 中文化相關工具而言，主要是將gettext中的兩個命令：

• xgettext包裝成django-admin.py makemessages, 用以將程式及腳本檔中所定義的Key字串取出放入至django.po
• msgfmt包裝成django-admin.py compilemessages, 用來把django.po 轉為二進位的django.mo檔案。

Key 字串
以底線（_)為常見的gettext key字串
在下列命令為常使用的兩種：

from django.utils.translation import gettext_lazy as _

筆者使用下列語法：

from django.utils.translation import ugettext as _

為什麼筆者不使用 gettext_lazy呢？
django 在更新po檔案時，會將相近字詞直接複製到附加的詞組中，時常牛頭不對馬嘴，不如手動編修。

以demo 專案為例
請進入與settings.py同層的專案目錄

$ django-admin.py makemessages –l zh_TW processing language zh_TW

正確產生自動下列檔案django.po

locale/zh_TW/LC_MESSAGES/django.po

如出現下列錯誤:

$ django-admin.py makemessages -l zh_TW Error: This script should be run from the Django SVN tree or your project or app tree. If you did indeed run it from the SVN checkout or your project or application, maybe you are just missing the conf/locale (in the django tree) or locale (for project and application) directory? It is not created automatically, you have to create it by hand if you want to enable i18n for your project or application.

請建立locale目錄，再試一次。

更新po檔案
每當新增一些個需要中文化字串，並不需要將它們動手加入django.po
可使用下列指令，直接將新字串附加至原有的django.po:

$ django-admin.py makemessages –a

編譯mo

$ django-admin.py compilemessages

註：在測試時，如有重新mo檔案，請重新執行django。

附錄

• 在使用 blocktrans 及 endblocktrans時，因為採用python 內建dict 變數代換功能，所以只能使用－層。範例如下：

{% blocktrans %} {{user.username}} 進行統 統操作中，… {% endblocktrans %}

其中 {{user.username}}將無法正確代換，需改為 {{username}} 一層dict 結構。對照python 原字串展開範例：

userinfo={'username': _('Bill')}

"%(user.username)s 進行統 統操作中，…" % userinfo

結論


gettext 廣泛使用在開源軟體之中，而django-admin加以包裝，讓它在使用上更加方便。
若對如何包裝gettext有興趣，可參閱python腳本檔如下：

/usr/lib/python2.7/site-packages/django/core/management/commands/makemessages.py

/usr/lib/python2.7/site-packages/django/core/management/commands/compilemessages.py