Flask 中的 Unicode

Flask 与 Jinja2 、 Werkzeug 一样,文本方面完全基于 Unicode ,大多数与 web 相关的 Python 库都是这样处理文本的。如果你还不了解 Unicode ,最好先阅读 The Absolute Minimum Every Software Developer Absolutely, Positively Must Know About Unicode and Character Sets 。 本文档尝试介绍一些基本的知识,以便于能够愉快地处理与 Unicode 相关的问题。

自动转换

为了提供基本的、无痛的 Unicode 支持, Flask 做了以下假设:

  • 你网站上文本编码是 UTF-8 。
  • 你在内部对文本始终只使用 Unicode ,除非是只有 ASCII 字符的文字字符串。
  • 只要通过协议传送字节,都离不开编码和解码过程。

所以,这对你来说有什么意义?

HTTP 是基于字节的,不仅是协议,用于定位服务器文档的系统也是这样(即 URI 或 URL )。然而,通常在 HTTP 上传送的 HTML 支持很多种字符集,并且需要在 HTTP header 中注明。为了避免不必要的复杂性, Flask 假设你发送的都是 UTF-8 编码的 Unicode,Flask 会为你完成编码工作,并设置适当的 header。

如果你使用 SQLAlchemy 或类似的 ORM 系统操作数据库,道理也是同样的。一些 数据库已经使用传输 Unicode 的协议,即使没有,SQLALchemy 或其它 ORM 也会 自动处理好这个问题。

金科玉律

经验法则:如果不是处理二进制数据,一律使用 Unicode 。在 Python 2.x 中, 如何使用 Unicode ?

  • 只使用 ASCII charpoints (基本是数字、非变音或非奇特的拉丁字母)时, 可以使用常规的字符串常量( 'Hello World' )。
  • 如果你的字符串里有 ASCII 之外的东西,需要把这个字符串标记为 Unicode 字符串,方法是加上一个小写 u 作为前辍(比如 u'Hänsel und Gretel'
  • 如果在 Python 文件中使用了非 Unicode 字符,那么需要告诉 Python 使用了 何种编码。这里,我再次建议使用 UTF-8 。你可以在 Python 源文件的第一行 或第二行写入 # -*- coding: utf-8 -*- 来告知解释器你的编码类型。
  • Jinja 被配置为以 UTF-8 解码模板文件,所以请同时确保你的编辑器使用 UTF-8 编码保存文件。

自助编码和解码

如果你打交道的文件系统或环境不是真正基于 Unicode 编码的话,那么使用 Unicode 接口时需要妥善地解码。比如,当从文件系统中加载一个文件,并嵌入到 Jinja2 模板时,需要按照文件的编码来解码。这里有一个老问题就是文本文件不指定其本身 的编码。所以帮你自己一个忙,限定在文本文件中使用 UTF-8 。

无论如何,转入一个 Unicode 文件,可以使用内置的 str.decode() 方法:

def read_file(filename, charset='utf-8'):
    with open(filename, 'r') as f:
        return f.read().decode(charset)

把 Unicode 转换成指定的字符集( UTF-8 ),可以使用 unicode.encode() 方法:

def write_file(filename, contents, charset='utf-8'):
    with open(filename, 'w') as f:
        f.write(contents.encode(charset))

配置编辑器

现在的大多数编辑器默认存储为 UTF-8 ,但是如果你的编辑器不是,你必须重新配置。 下面是设置你编辑器存储为 UTF-8 的常用做法:

  • Vim: 在你的 .vimrc 文件中加入 set enc=utf-8

  • Emacs: 要么使用 encoding cookie,要么把这段文字加入到你的 .emacs 文件:

    (prefer-coding-system 'utf-8)
    (setq default-buffer-file-coding-system 'utf-8)
    
  • Notepad++:

    1. 打开 设置 -> 首选项 ...
    2. 选择“新建/缺省路径”选项卡
    3. 选择“ UTF-8 无 BOM ”作为编码

    同样也建议使用 Unix 的换行格式,可以在相同的面板中选择,但不是必须的。