before

win10 + Python3.6.8

有些时候，出于保护源码，或者希望Python源码运行在没有Python环境系统中，都会遇到将Python源码打包成exe可执行文件的需求，本篇就来探讨一下如何将Python源码打包成可执行文件。

我们通常使用下面两个工具来做这些事情：

• pyinstaller
• pyexe

接下来，我将分别演示两个模块的用法。

pyinstaller

摘自PyInstaller手册：

PyInstaller将Python应用程序及其所有依赖项捆绑到一个包中。用户无需安装Python解释器或任何模块即可运行打包的应用程序。 PyInstaller支持Python 3.5或更高版本，并正确捆绑了主要的Python软件包，例如numpy，PyQt，Django，wxPython等。

PyInstaller已针对Windows，Mac OS X和GNU / Linux进行了测试。但是，它不是交叉编译器：要制作Windows应用程序，请在Windows中运行PyInstaller。要创建GNU / Linux应用程序，请在GNU / Linux等环境中运行它 。PyInstaller已成功与AIX，Solaris，FreeBSD和OpenBSD结合使用，但是针对它们的测试并不属于我们持续集成测试的一部分。

使用之前需要先下载

pip install pyinstaller
# 查看版本
pyinstaller --version
4.0

单个文件打包

win10 + python3.6.8 + pyinstaller4.0

首先有一个这样的目录：

D:/tmp/foo/
| ─ t1.py

t1.py文件中代码如下：

import requests

def get_img():
	response = requests.get('http://n.sinaimg.cn/fashion/transform/20151118/3XjS-fxksqiv8463298.jpg')
	with open('./a.jpg', 'wb') as f:
		f.write(response.content)

if __name__ == "__main__":
	get_img()

非常简单的一段段代码，下载一张图片保存到本地。

那如何将这个py文件打包成可执行文件呢？ 在t1.py文件同级目录，终端执行：

pyinstaller t1.py
# 等同于下面的命令
pyinstaller -D t1.py

如果没有报错的话，该目录内会生成如下图的几个文件(夹)。 其中：

• build目录是编译过程产生的文件，可以删除该目录。
• t1.spec文件包含使用脚本文件作为参数运行pyinstaller（或pyi-makespec）时指定的选项所提供的大多数信息。也就是说我们可以通过修改文件来控制编译过程，是非常重要的一个文件，但是我们稍后再说它，关于它的更多信息参考https://pyinstaller.readthedocs.io/en/stable/usage.html
• dist目录是生成的目标目录，我们此时打开dist目录，其中有个t1目录，记住，各种第三方依赖、资源和exe同时存储在该目录,且exe文件只能在该目录内运行；所以，如果你要将这个t1.exe拷贝到别处的话，直接将t1目录一起拷贝走。

此时生成的可执行文件局限性较大，执行还要需要依赖文件；接下来，介绍一种生成后的所有依赖什么的都打包在一个可执行文件中：

pyinstaller -F t1.py

在dist目录中，此时只有t1.exe这个一个可执行文件，所有的依赖也都在这个文件中。所以我们可以将这个文件在任意位置执行。

单个源码文件打包非常简单，再来看多个文件如何打包。

多个文件打包

现在，在t1.py同级新建一个t2.py文件：

from t1 import get_img


def hello():
	print('hello world')
	get_img()

if __name__ == "__main__":
	hello()

t2.py文件调用t1.py，现在执行打包命令：

pyinstaller -F t2.py

在生成的dist目录内的t2.exe可执行文件，你也可以随便的拖动到任意位置去执行，而t2依赖的t1文件则都集成到了t2.exe文件中，我们不做多考虑。 看起来非常简单，加点难度，我们在两个py文件同级创建一个子目录，并且代码有调用关系，此时的目录结构：

D:/tmp/foo/
| —— t2.py
| —— t3.py
| ————tools
|    | —— t1.py
|    | —— __init__.py   # 保持文件为空

t1.py中代码不变，将之移动到tools目录中，且该目录内的__init__.py保持为空即可。 t2代码如下：

from tools import t1

def hello():
	print('hello world')
	t1.get_img()

if __name__ == "__main__":
	hello()

t3.py代码如下：

from t2 import hello

if __name__ == "__main__":
	hello()

代码也非常简单，主要是为了建立调用关系。 来打包：

pyinstaller -F t3.py

在生成的dist目录内的t3.exe可执行文件，你也可以随便的拖动到任意位置去执行，而其他依赖文件则都集成到了t3.exe文件中，我们不做多考虑。 再来看其他操作，如我们给可执行文件自定义一个图标，首先在t3.py目录准备一张.ico图片，然后执行：

pyinstaller -i a.ico -F t3.py

注意，图片格式必须是.ico格式的图片，别的图片会报错。你可能需要：ICO图标在线生成转换工具

参数一览

更多姿势等你自己解锁吧！我们来罗列下你可能会遇到的参数： 通用参数

参数名	描述	说明
-h	显示帮助	无
-v	显示版本号	无
–distpath	生成文件放在哪里	默认：当前目录的dist文件夹内
–workpath	生成过程中的中间文件放在哪里	默认：当前目录的build文件夹内
-y	如果dist文件夹内已经存在生成文件，则不询问用户，直接覆盖	默认：询问是否覆盖
–upx-dir UPX_DIR	指定upx工具的目录	默认：execution path
-a	不包含unicode支持	默认：尽可能支持unicode
–clean	在本次编译开始时，清空上一次编译生成的各种文件	默认：不清除
–log-level LEVEL	控制编译时pyi打印的信息	一共有6个等级，由低到高分别为TRACE DEBUG INFO(默认) WARN ERROR CRITICAL。也就是默认清空下，不打印TRACE和DEBUG信息

与生成结果有关的参数

参数名	描述	说明
-D	生成one-folder的程序（默认）	生成结果是一个目录，各种第三方依赖、资源和exe同时存储在该目录
-F	生成one-file的程序	生成结果是一个exe文件，所有的第三方依赖、资源和代码均被打包进该exe内
–specpath	指定.spec文件的存储路径	默认：当前目录
-n	生成的.exe文件和.spec的文件名	默认：用户脚本的名称，即main.py和main.spec

指定打包哪些资源、代码

参数名	描述	说明
–add-data	打包额外资源	用法：pyinstaller main.py --add-data=src;dest。windows以;分割，linux以:分割
–add-binary	打包额外的代码	用法：同–add-data。与–add-data不同的是，用binary添加的文件，pyi会分析它引用的文件并把它们一同添加进来
-p	指定额外的import路径，类似于使用PYTHONPATH	参见PYTHONPATH
–hidden-import	打包额外py库	pyi在分析过程中，有些import没有正确分析出来，运行时会报import error，这时可以使用该参数
–additional-hooks-dir	指定用户的hook目录	hook用法参见其他，系统hook在PyInstaller\hooks目录下
–runtime-hook	指定用户runtime-hook	如果设置了此参数，则runtime-hook会在运行main.py之前被运行
–exclude-module	需要排除的module	pyi会分析出很多相互关联的库，但是某些库对用户来说是没用的，可以用这个参数排除这些库，有助于减少生成文件的大小
–key	pyi会存储字节码，指定加密字节码的key	16位的字符串

生成参数

参数名	描述	说明
-d	执行生成的main.exe时，会输出pyi的一些log，有助于查错	默认：不输出pyi的log
-s	优化符号表	原文明确表示不建议在windows上使用
–noupx	强制不使用upx	默认：尽可能使用。

其他

参数名	描述	说明
–runtime-tmpdir	指定运行时的临时目录	默认：使用系统临时目录

Windows和Mac特有的参数

参数名	描述	说明
-c	显示命令行窗口	与-w相反，默认含有此参数
-w	不显示命令行窗口	编写GUI程序时使用此参数有用。
-i	为main.exe指定图标	pyinstaller -i beauty.ico main.py

** Windows特有的参数**

参数名	描述	说明
–version-file	添加版本信息文件	pyinstaller --version-file ver.txt
-m, --manifest	添加manifest文件	pyinstaller -m main.manifest
-r RESOURCE	请参考原文
–uac-admin	请参考原文
–uac-uiaccess	请参考原文

参考：PyInstaller.org | PyInstaller手册 | PyInstaller各参数含义

pyexe

---

see also: