深入Pyinstaller的使用，用spec添加资源文件

最近写的翻译软件——transdocx，就是给普通用户而非Python程序员用的，所以它必须是一个开箱即用的软件，普通用户下载下来就能双击运行。

而Python作为一个脚本语言，要运行是必须有解释器的，它不能像C/C++那样编译成二进制。同样，也不能要求普通用户首先安装Python解释器、再安装依赖的包、最后运行transdocx。所以，需要把Python写好的软件打包成一个exe程序，让用户双击既可以使用。打包Python程序的最好的工具可能就是pyinstaller了。

下面我就结合transdocx打包的过程来讲讲pyinstaller的使用，平台是Windows，Linux和macOS类似。

一、第一版transdocx：纯Python代码的打包

如果你的软件中只有.py文件，即Python代码文件，不包括图标、图片等资源文件，那么使用pyinstaller打包是非常简单的，往往只需要下面一行命令即可：

pyinstaller -F -w -i icon.ico transdocx.py

第一版本的transdocx就是这样完成的。其中的几个选项：

-F把整个软件（包括依赖的各种库文件）打包成单一文件；

-w禁止Windows的命令行窗口。不然双击exe时会打开一个黑乎乎的dos窗口；

-i生成的exe文件会带有这个图标，有识别度也更好看；

最后的transdocx.py就是翻译软件的入口程序。

运行完上面的命令，会在当前目录下生成一个transdocx.spec文件和两个文件夹build和dist，其中dist里面就是最终生成的exe文件，把这个文件发给普通用户就可以了。当然，你要先自己测试没有问题。

transdocx.spec 是于pyinstaller生成的配置文件，下次打包时，可以不运行上面带参数的命令，而直接运行：

pyinstaller transdocx.spec

二、第二版transdocx，带有资源文件的打包

第二版为了支持PDF，添加了目录bin/下面的相关资源文件，主要是:

pdftotext.exe : Windows下面的提取PDF文本内容的命令行工具；

pdftotext : Linux下面提取PDF文本内容的命令行工具；

default.docx ： 生成docx的默认模板文件。

提取PDF内容是通过Python的subprocess模块调用命令行工具pdftotext.exe 实现的。如果按照上面比较简单的打包方式，就会报错：找不到这个命令行工具。因为这些资源文件没有被打包到最终的exe文件。

要把这些资源文件包含进去，可以给pyinstaller添加选项，也可以修改spec文件。我通过修改transdocx.spec来实现：

（关于spec的说明可以查看pyinstaller的官方文档）

添加过程还是很简单的，看图中红框部分就是。

前面pyinstaller 自动生成的spec文件中，binaries原本是空的：

binaries=[]

就是一个空的list，把要添加的资源文件以tuple的形式传入，tuple的第一个元素是资源文件的路径，第二个元素是打包后存放资源的文件夹。比如：

('./bin/pdftotext.exe', 'bin')

就是把 ‘./bin/pdftotext.exe’ 打包后放到bin目录下面。打包后的目录跟Python代码的目录结构一直即可，pdftotext.exe原先放在bin下面可以让程序运行，那么打包后也放在bin下面即可。

在spec文件中添加好要包含的资源文件再次打包就可以把资源文件打包到最终的exe文件了。然而，这时得到的最终exe还是不能运行！ 报的错误还是找不到相关文件。

三、修改资源文件路径以保证打包结果能执行

为什么还不能运行？这样从pyinstaller打包后的exe的运行机制讲起。打包得到的exe文件是一个可自解压的程序，它会把这个exe文件中包含的文件打包到一个名为_MEIxxxxxx的临时目录下面，这个目录在系统的临时文件夹下面（Linux下是 /tmp），当程序退出时，会自动清空删除这个临时目录_MEIxxxxxx。

我们先来看看这个临时目录 _MEIxxxx 里面都是些什么，下面截图是Linux下面的，Windows类似，只不过路径不一样，Windows下是.dll等。

其中的bin目录下就是我添加的资源文件。

最终的exe文件有可能放在任何目录执行，其当前目录下不会有bin目录下面的资源文件，而是被解压到了临时目录下面，所以程序报错找不到相关文件。

因此，我们要在程序中指定资源文件的路径，使得它在非打包模式和打包模式下运行时都能找到相关资源文件。这需要添加一个路径解析函数：

这个函数很简单，把资源的相对路径转换为绝对路径。如果找到 _MEIPASS 路径就以此为资源的基准路径，否则以当前路径为基准路径。

代码中任何使用资源文件的相对路径都用该函数转换一下即可保证资源文件可以被找到。比如代码中：

可以从transdocx的源码中查找更多resource_path的示例。

至此，打包的问题完美解决了。再次使用spec打包一下，看看exe应该可以正常运行了。

双击exe运行正常，选取一个PDF文件，点击“翻译”。纳尼？！又报错！！

一番搜索后，stackoverflow上找到了原因：

https://stackoverflow.com/questions/337870/

问题出在subprocess上面：

简单来说就是，打包是关闭了命令行窗口，stdin, stdout 无处安放。

所以，把它们用subprocess.PIPE 管道代替即可。

shell=True 可以防止执行subprocess.Popen()时闪现一个黑糊糊的dos窗口。

这时候，才算完美解决了pyinstaller打包的问题。总结一下pyinstaller打包的过程：

（1）pyinstaller -F -w xxx.py；

（2）修改上一把生成的xxx.spec文件，添加资源文件；

（3）pyinstaller xxx.spec 打包为exe文件。

如果你在使用pyinstaller的过程中，遇到和解决了一些问题，欢迎在下面留言和大家一起讨论分享。