Flask-Babel使用简易教程(一)

本文参考https://translations.readthedocs.io/en/latest/flask-babel.html做了修改,如有疑问请指正。

修改如下:

在终l端执行pybabel --list-locales命令,查看本机支持的语言,发现中文支持是zh_Hans_CN,而非zh_CN。所以在以下文章中,把zh_CN做下修改即可。修改的地方有两处,一处是命令,一处是文件。

安装 Flask-Babel

Flask-Babel是 Flask 的翻译扩展工具。安装命令如下:

pip install flask-babel

安装它的时候会顺便安装Babel、pytz、speaklater这三个包,其中 Babel 是 Python 的一个国际化工具包。pytz 是处理时区的工具包,speaklater 相当于是 Babel 的一个辅助工具,我们这里集中在翻译流程上,这几个工具就供以后进一步了解吧。

Hello, World

接下来我们做一个简单的 Hello World 程序,新建一个叫 hello 的文件夹,在其中创建一个叫 hello.py 的文件,内容如下:


Flask-Babel使用简易教程(一)_第1张图片
hello.py

然后在 hello.py 的同一级目录下创建一个叫 templates 的文件夹,在其中写一个 index.html,内容如下:


Flask-Babel使用简易教程(一)_第2张图片
index.html

很简单的 Hello World 程序,接下来我们要做的是让这个站变成中文站。

更新程序和模板

再接下来就是翻译了。翻译需要用到 flask-babel 这个 flask 扩展。首先我们将这个 app “国际化”,为模板和 .py 文件中的每一个字符串添加一个 gettext 函数,由于 gettext 函数被引用的次数太多了,为了方便手写,就将其 import 为 “_”:


Flask-Babel使用简易教程(一)_第3张图片
hello.py

然后修改模板:


Flask-Babel使用简易教程(一)_第4张图片
index.html

你可以注意到我们对 app 的 locale 做了配置,然后用 babel 扩展将 app 再次初始化,并且将 .py 和 .html 中的字符串做了配置,让它们都使用gettext这个函数。其中值得注意的是gettext的格式化字符串的参数。如果直接用类似"It's %s today"% day是不行的。

这么一来,app 的语言其实是被写死成中文了。其实你可以在 flask 程序中让用户选择自己喜好的语言,或者依据浏览器设置用户优先显示的语言,详细做法可以参考官方文档中提到localeselector的部分。

设置 Babel

接下来我们要做的是 babel 的配置。在 hello.py 的同级目录创建一个叫 babel.cfg 的文件,内容如下:


Flask-Babel使用简易教程(一)_第5张图片
babel.cfg

生成翻译模板

这样 babel 就知道要从哪些位置搜索要翻译的字符串了。然后我们用 pybabel 生成要翻译的 PO 模板文件,这个命令是 babel 这个工具包带来的,生成翻译模板命令如下:

$ pybabel extract -F babel.cfg -o messages.pot .

注意结尾的点“.”,这个点表示当前目录,目录是 pybabel 必须的参数,官方文档中缺少这个点,所以命令是无法执行成功的。messages.pot 就是我们生成的翻译模板文件,内容大致如下:

# Translations template for PROJECT.

# Copyright (C) 2017 ORGANIZATION

# This file is distributed under the same license as the PROJECT project.

# FIRST AUTHOR , 2017.

#

#, fuzzy

msgid""

msgstr""

"Project-Id-Version: PROJECT VERSION\n"

"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"

"POT-Creation-Date: 2017-03-22 13:46+0800\n"

"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

"Last-Translator: FULL NAME \n"

"Language-Team: LANGUAGE \n"

"MIME-Version: 1.0\n"

"Content-Type: text/plain; charset=utf-8\n"

"Content-Transfer-Encoding: 8bit\n"

"Generated-By: Babel 2.3.4\n"

#: hello.py:10

msgid"Saturday"

msgstr""

#: templates/index.html:1

msgid"Flask International"

msgstr""

#: templates/index.html:2

msgid"Hello, World!"

msgstr""

#: templates/index.html:3

#, python-format

msgid"It's %(day)s today"

msgstr""

你可以修改里边头文件的信息,把个人和项目相关的资料加进去。

翻译

接下来我们创建中文翻译:

$ pybabel init -i messages.pot -d translations -l zh_Hans_CN

这句命令会在 hello 文件夹中生成一个 translations 文件夹,要确保 flask 能找到翻译内容,translations文件夹要和 templates 文件夹在同一个目录中。接下来我们就可以进行翻译了,修改translations/zh_Hans_CN/LC_MESSAGES/messages.po文件,将其中的内容翻译过来:

# Chinese (Simplified, China) translations for PROJECT.

# Copyright (C) 2017 ORGANIZATION

# This file is distributed under the same license as the PROJECT project.

# FIRST AUTHOR , 2017.

#

msgid""

msgstr""

"Project-Id-Version: PROJECT VERSION\n"

"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"

"POT-Creation-Date: 2017-03-22 13:46+0800\n"

"PO-Revision-Date: 2017-03-22 13:42+0800\n"

"Last-Translator: \n"

"Language: zh_Hans_CN\n"

"Language-Team: zh_Hans_CN \n"

"Plural-Forms: nplurals=1; plural=0\n"

"MIME-Version: 1.0\n"

"Content-Type: text/plain; charset=utf-8\n"

"Content-Transfer-Encoding: 8bit\n"

"Generated-By: Babel 2.3.4\n"

#: hello.py:10

msgid"Saturday"

msgstr"星期六"

#: templates/index.html:1

msgid"Flask International"

msgstr"Flask国际化"

#: templates/index.html:2

msgid"Hello, World!"

msgstr"哈喽,世界"

#: templates/index.html:3

#, python-format

msgid"It's %(day)s today"

msgstr"今天是%(day)s"

PO文件的翻译其实可以用专门的工具来编辑,比如Poedit,不过小文件直接手译就可以了。

编译翻译结果

翻译完后执行下面的命令,为其编译出 message.mo 文件:

$ pybabel compile -d translations

如果上述命令无法生成 messages.mo 文件,那你需要将 message.po 中的#,fuzzy删除。

然后就算基本完成了。这时执行 python hello.py 就会看到翻译的中文页面了。

更新翻译

有时我们需要对程序和模板做修改,翻译也要随之更新。更新后需要用前面的命令重新生成 messages.pot 文件,然后使用下面的命令将更新的内容 merge 到原来的翻译中:

$ pybabel update -i messages.pot -d translations

最后再到对应 locale 的文件夹下更新翻译并 compile 即可。

项目结构:


Flask-Babel使用简易教程(一)_第6张图片
目录树

你可能感兴趣的:(Flask-Babel使用简易教程(一))