gettext模块实现Python国际化支持

1.gettext模块介绍

gettext模块为Python模块和应用程序提供国际化(i18n)和本地化(l10n)服务。它提供两套API，一套高层的类似于GNU gettext的API和一套基于类的API。前者适用于单语言的场景，并且语言的选择通常依赖于用户的locale，会全局性地影响到你整个应用程序语言的转译。后者允许你在一个python模块内进行本地化，非常适用于在应用程序运行时切换你的语言。

---

2.通用步骤

（1）无论是使用哪一套API，都必须提取可以翻译的字符串并且生成一个翻译模板文件.pot

（2）然后生成对应于不同语言翻译的文件.po

（3）我们在应用程序中使用是的二进制格式的.mo文件，由.po转换而来

现在举一个简单例子来示范上述步骤

(a)创建一个工程目录py_i18n，创建程序主文件my_app.py

(b)编辑my_app.py，先输入以下内容

# -*- coding: utf-8 -*-

import gettext

_ = gettext.gettext

if __name__ == "__main__":
    print _("hello world")

这里用_()括起来的字符串就是需要翻译的字符串

(c)用xgetext来提取需要翻译的字符串生成翻译模板

(d)用msginit生成对应于不同语言翻译的文件.po，例如简体中文zh_CN和英文en：

注意过程中，可能会询问你的email地址，直接回车即可

(e)编辑po文件，填写需要翻译的字符串对应的译文字符串,例如zh_CN.po：

这里msgid后面的字符串就是需要翻译的字符串，msgstr后面就是译文字符串。对en.po重复(e)操作

(f)使用msgfmt命令从po生成二进制文件mo，也是应用程序需要使用的文件。

先在工程目录下创建存放mo文件的locale目录，目录结构要和系统的locale目录结构一样：

然后在对应目录下生成不同的mo文件

ok! 到目前为止所有准备工作完成

补充：

注:上面的步骤也可以用poedit这款软件完成，官网上有详细的使用教程

另外，一旦python代码中要翻译的字符串发生变化（修改、增删），需要重新生成po文件时，可以用msgmerge命令来代替msginit命令，例如:

msgmerge -U zh_CN.po my_app.pot

---

3.在Python代码中添加国际化支持

    在第一部分介绍gettext模块时，gettext模块有两种使用方式。第一种是根据用户系统的语言配置（系统的环境变量LANGUAGE, LC_ALL, LC_MESSAGES, LANG），自动选择语言；第二种是在程序中实时切换语言。

（1）根据用户系统的语言配置自动选择语言

打开my_app.py, 编辑代码并保存:

# -*- coding: utf-8 -*-

import os
import gettext

APP_NAME = "my_app"
LOCALE_DIR = os.path.abspath("locale")
# 将域APP_NAME与LOCALE_DIR目录绑定，
# 这样gettext函数会在LOCALE_DIR目录下搜索对应语言的二进制APP_NAME.mo文件
gettext.bindtextdomain(APP_NAME, LOCALE_DIR)
# 声明使用现在的域，可以使用多个域，便可以为同一种语言提供多套翻译，
# 本程序只使用了一个域
gettext.textdomain(APP_NAME)

_ = gettext.gettext

if __name__ == "__main__":
    print _("hello world")

然后回到命令行窗口，检查一下现在的语言配置，并运行python my_app.py:

ok, 得到了正确的翻译输出！

我们可以尝试切换语言，直接修改系统的环境变量:

可以看到我们并未修改代码，但是程序已经自动的输出英文

（2）在程序中实时切换语言

打开my_app.py, 编辑代码并保存:

# -*- coding: utf-8 -*-
import os
import gettext

APP_NAME = "my_app"
LOCALE_DIR = os.path.abspath("locale")

# 这条语句会将_()函数自动放到python的内置命名空间中
gettext.install(APP_NAME, LOCALE_DIR)
# 获取简体中文翻译类的实例
lang_zh_CN = gettext.translation(APP_NAME, LOCALE_DIR, ["zh_CN"])
# 获取英文翻译类的实例
lang_en = gettext.translation(APP_NAME, LOCALE_DIR, ["en"])

if __name__ == "__main__":
    # 安装中文
    lang_zh_CN.install()
    print _("hello world")
    # 安装英文（程序中实时切换回英文）
    lang_en.install()
    print _("hello world")

回到命令行直接运行python my_app.py，运行结果如下：

可以看到，可以在程序中同时输出中文和英文。

到此为止，两种在python中添加国际化支持的方式介绍完毕。