Python打包含有gettext locales语言环境的项目

问题

如何使用 pyinstaller 打包使用了 gettext 本地化的项目，最终只生成一个 exe 文件

起因

最近在用 pyhton 做一个图片处理的小工具，顺便接触了一下 gettext，用来实现本地化化中英文转换。项目主要结构如下：

.
|--src # 源码
|  |--package1
|  |--package2
|  |--locales # 本地化文件
|  |  |--en # 英文
|  |  |  |--LC_MESSAGES
|  |  |     |--en.mo
|  |  |--zh # 中文
|  |    |--LC_MESSAGES
|  |       |--en.mo
|  |--GUI.py # 界面
|  |--main.py # 主程序

直接使用 pyinstaller -F src\main.py 命令进行打包，打包后运行在 dist 文件夹中生成的 main.exe 会报错。原因是 gettext 找不到本地化文件。但如果试着将 locales 文件夹复制到 main.exe 的目录下程序能正常运行，说明 pyinstaller 在打包时不会将 locales 文件夹打包进去。

复制 locales 文件夹到可执行文件目录下固然可以运行，但这样用起来会很麻烦。

解决方案

​目标是将 locales 目录一起打包进 exe 文件中，查阅 pyinstaller 的官方文档，了解到执行之前的 pyinstaller -F src\\main.py 命令会在目录下生成一个 .spec 文件，pyinstaller 通过该文件的内容来构建应用程序。

the first thing PyInstaller does is to build a spec (specification) file myscript.spec. That file is stored in the --specpath directory, by default the current directory.

The spec file tells PyInstaller how to process your script. It encodes the script names and most of the options you give to the pyinstaller command. The spec file is actually executable Python code. PyInstaller builds the app by executing the contents of the spec file.

使用记事本打开，.spec 文件里面大致长这样（来自官方例子）

block_cipher = None
a = Analysis(['minimal.py'],
     pathex=['/Developer/PItests/minimal'],
     binaries=None,
     datas=None,
     hiddenimports=[],
     hookspath=None,
     runtime_hooks=None,
     excludes=None,
     cipher=block_cipher)
pyz = PYZ(a.pure, a.zipped_data,
     cipher=block_cipher)
exe = EXE(pyz,... )
coll = COLLECT(...)

其中，Analysis 里面有个 datas 参数，用于存放非二进制文件，也就是我们想让程序包含的静态文件。我们只要把 locales 目录填到这里面打包就会添加进去。当然不是填一个路径就好了，data 的格式如下：

--add-data <SRC;DEST or SRC:DEST>

SRC 就是未打包前的文件路径，DEST 是打包后文件的路径。以我的项目为例，打包前 locales 在 src/locales，打包后我想讲里面的文件放到临时目录的根目录下就填 ./locales，临时目录是什么后面讲。于是在我的 .spec文件里 datas 处就写成 datas=[("src/locales","./locales")]。如果有多个路径就以这样形式 datas=[(src1, dest1), (src2, dest2), ...]就OK。

这样打包部分的配置就改完了，不要急，还要改下源代码。exe 文件在运行时会生成一个临时目录，我们之前 datas 中的文件也会在该目录下。看看你的源码，如果调用资源用的是相对路径，那读取的是 exe 文件当前的目录，必然是找不到资源的。所以要把源码中相对路径改成临时目录的绝对路径。

sys 中的 _MEIPASS 属性存储了临时目录路径，直接获取即可。如果程序运行环境是打包后的，那么在 sys 中会添加一个 frozen 属性，通过能不能获取 frozen 属性可以判断当前环境是打包前还是打包后，具体详情请查阅 pyinstaller 官方文档（末尾有地址）。打包前就不需要获取临时目录路径了，直接用文件所在目录路径就行。

注意：打包后环境 file 属性不生效

import sys
import os

if getattr(sys, 'frozen', None):
    dir = sys._MEIPASS
else:
    dir = os.path.dirname(__file__)

获取路径 dir，可以使用 os.path.join() 来拼接路径，把源码中调用 datas 中资源地方的路径改成 os.path.join(dir, <打包后相对路径>)

如我的项目中原来的 './locales' 处就变成了 os.path.join(dir, 'locales')

最后一步，打包！不要再输之前的命令了，要使用改过之后的 .spec 文件进行打包，输入 pyinstaller -F 文件名.spec 就完成了。

参考资料

pyinstaller 文档：Using Spec Files

pyinstaller 文档：Run-time Information