Python PyInstaller安装和使用教程（详解版）

最新推荐文章于 2024-07-12 09:05:24 发布

Zsanfeng

最新推荐文章于 2024-07-12 09:05:24 发布

阅读量3.5k

点赞数 1

文章标签： python

Python PyInstaller安装和使用教程

在创建了独立应用（自包含该应用的依赖包）之后，还可以使用 PyInstaller 将 Python 程序生成可直接运行的程序，这个程序就可以被分发到对应的 Windows 或 Mac OS X 平台上运行。

安装 PyInstalle
Python 默认并不包含 PyInstaller 模块，因此需要自行安装 PyInstaller 模块。
安装 PyInstaller 模块与安装其他 Python 模块一样，使用 pip 命令安装即可。在命令行输入如下命令：

pip install pyinstaller

强烈建议使用 pip 在线安装的方式来安装 PyInstaller 模块，不要使用离线包的方式来安装，因为 PyInstaller 模块还依赖其他模块，pip 在安装 PyInstaller 模块时会先安装它的依赖模块。

运行上面命令，应该看到如下输出结果：

Successfully installed pyinstaller-x.x.x

其中的 x.x.x 代表 PyInstaller 的版本。

在 PyInstaller 模块安装成功之后，在 Python 的安装目录下的 Scripts(D:\Python\Python36\Scripts) 目录下会增加一个 pyinstaller.exe 程序，接下来就可以使用该工具将 Python 程序生成 EXE 程序了。
PyInstaller生成可执行程序
PyInstaller 工具的命令语法如下：

	pyinstaller 选项 Python 源文件

不管这个 Python 应用是单文件的应用，还是多文件的应用，只要在使用 pyinstaller 命令时编译作为程序入口的 Python 程序即可。
PyInstaller工具是跨平台的，它既可以在 Windows平台上使用，也可以在 Mac OS X 平台上运行。在不同的平台上使用 PyInstaller 工具的方法是一样的，它们支持的选项也是一样的。

下面先创建一个 app 目录，在该目录下创建一个 app.py 文件，文件中包含如下代码：

from say_hello import *
	def main():
		print('程序开始执行')
		print(say_hello('孙悟空'))

增加调用main()函数

if __name__ == '__main__':
main()

接下来使用命令行工具进入到此 app 目录下，执行如下命令：

pyinstaller -F app.py

执行上面命令，将看到详细的生成过程。当生成完成后，将会在此 app 目录下看到多了一个 dist 目录，并在该目录下看到有一个 app.exe 文件，这就是使用 PyInstaller 工具生成的 EXE 程序。

在命令行窗口中进入 dist 目录下，在该目录执行 app.exe ，将会看到该程序生成如下输出结果：

程序开始执行
孙悟空，您好！

由于该程序没有图形用户界面，因此如果读者试图通过双击来运行该程序，则只能看到程序窗口一闪就消失了，这样将无法看到该程序的输出结果。

在上面命令中使用了-F 选项，该选项指定生成单独的 EXE 文件，因此，在 dist 目录下生成了一个单独的大约为 6MB 的 app.exe 文件（在 Mac OS X 平台上生成的文件就叫 app，没有后缀）；与 -F 选项对应的是 -D 选项（默认选项），该选项指定生成一个目录（包含多个文件）来作为程序。

下面先将 PyInstaller 工具在 app 目录下生成的 build、dist 目录删除，并将 app.spec 文件也删除，然后使用如下命令来生成 EXE 文件。

pyinstaller -D app.py

执行上面命令，将看到详细的生成过程。当生成完成后，将会在 app 目录下看到多了一个 dist 目录，并在该目录下看到有一个 app 子目录，在该子目录下包含了大量 .dll 文件和 .pyz 文件，它们都是 app.exe 程序的支撑文件。在命令行窗口中运行该 app.exe 程序，同样可以看到与前一个 app.exe 程序相同的输出结果。

PyInstaller 不仅支持 -F、-D 选项，而且也支持如表 1 所示的常用选项。

表1 PyInstaller 支持的常用选项
-h，–help 查看该模块的帮助信息
-F，-onefile 产生单个的可执行文件
-D，–onedir 产生一个目录（包含多个文件）作为可执行程序
-a，–ascii 不包含 Unicode 字符集支持
-d，–debug 产生 debug 版本的可执行文件
-w，–windowed，–noconsolc 指定程序运行时不显示命令行窗口（仅对 Windows 有效）
-c，–nowindowed，–console 指定使用命令行窗口运行程序（仅对 Windows 有效）
-o DIR，–out=DIR 指定 spec 文件的生成目录。如果没有指定，则默认使用当前目录来生成 spec 文件
-p DIR，–path=DIR 设置 Python 导入模块的路径（和设置 PYTHONPATH 环境变量的作用相似）。也可使用路径分隔符（Windows 使用分号，Linux 使用冒号）来分隔多个路径
-n NAME，–name=NAME 指定项目（产生的 spec）名字。如果省略该选项，那么第一个脚本的主文件名将作为 spec 的名字

在表1中列出的只是 PyInstaller 模块所支持的常用选项，如果需要了解 PyInstaller 选项的详细信息，则可通过 pyinstaller -h 来查看。

下面再创建一个带图形用户界面，可以访问 MySQL 数据库的应用程序。

在 app 当前所在目录再创建一个 dbapp 目录，并在该目录下创建 Python 程序，其中 exec_select.py 程序负责查询数据，main.py 程序负责创建图形用户界面来显示查询结果。

exec_select.py 文件包含的代码如下：

导入访问MySQL的模块

import mysql.connector
def query_db():
	# ①、连接数据库
 	conn = conn = mysql.connector.connect(user='root', password='32147',
    	host='localhost', port='3306',
    	database='python', use_unicode=True)
	# ②、获取游标
	c = conn.cursor()
	# ③、调用执行select语句查询数据
	c.execute('select * from user_tb where user_id > %s', (2,))
	# 通过游标的description属性获取列信息
	description = c.description
	# 使用fetchall获取游标中的所有结果集
	rows = c.fetchall()
	# ④、关闭游标
	c.close()
	# ⑤、关闭连接
	conn.close()
	return description, rows

mian.py 文件包含的代码如下：

from exec_select import *
from tkinter import *

def main():
	description, rows = query_db()
	# 创建窗口
	win = Tk()
	win.title('数据库查询')
	# 通过description获取列信息
	for i, col in enumerate(description):
    	lb = Button(win, text=col[0], padx=50, pady=6)
    	lb.grid(row=0, column=i)
	# 直接使用for循环查询得到的结果集
	for i, row in enumerate(rows):
    	for j in range(len(row)):
        	en = Label(win, text=row[j])
        	en.grid(row=i+1, column=j)
	win.mainloop()
if __name__ == '__main__':
	main()

通过命令行工具进入 dbapp 目录下，在该目录下执行如下命令：

Pyinstaller -F -w main.py

上面命令中的 -F 选项指定生成单个的可执行程序，-w 选项指定生成图形用户界面程序（不需要命令行界面）。运行上面命令，该工具同样在 dbapp 目录下生成了一个 dist 子目录，并在该子目录下生成了一个 main.exe 文件。
直接双击运行 main.exe 程序（该程序有图形用户界面，因此可以双击运行），可自行查看运行结果。

案例：
1、规范文件
然后，学习一个命令：

pyi-makespec main.py  # 运行 pyinstaller ，以main.py为主文件，生成一个spec文件，作为一个标准

此规范文件也可以自己编写，同时，生成规范文件时，直接打包的那些参数都可以使用

运行后，其在运行目录下生成一个main.spec文件，其内容为：

# -*- mode: python ; coding: utf-8 -*-

block_cipher = None  #设置 加密，需要安装tinyaes第三方库，最多16位字符，此处在使用--key= 会有变化

a = Analysis(
	['main.py'],  # 运行的所有py文件，包括依赖的py文件 
	pathex=[],  # 搜索导入的路径列表（此列表为项目绝对路径)，包括选项给出的路径--paths，项目需要从什么地方导入自定义库
	binaries=[],  # 脚本需要的非python模块，包括--add-binary选项给出的名称，二进制数据
	datas=[],  # 应用程序中包含的非二进制文件，包括--add-data选项给出的名称，项目需要用到什么数据，比如图片，视频等。里面格式为tuple，第一个参数是文件路径，第二个是打包后所在的路径，其为一个元组：('image/*.png','data/image')
	hiddenimports=[],   # 假如打包后打开exe显示module not found，就要把该库添加到hiddenimports里面了
	hookspath=[],  
	hooksconfig={},  # 挂钩配置选项由一个字典组成
	runtime_hooks=[],  
	excludes=[],  # 假如你用的python有很多库，但是你不需要用到某个，那么就把它添加到里面去，可以压缩文件大小
	win_no_prefer_redirects=False,
	win_private_assemblies=False,
	cipher=block_cipher,
	noarchive=False,
)
pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

exe = EXE(
	pyz,
	a.scripts,  # 打包成EXE的脚本文件
	# a.binaries,  # 如果是单文件模式，则需要添加；多文件也可以添加
	# a.zipfiles,
	# a.datas,
	[],
	exclude_binaries=True,  # 是否排除二进制文件，为True时，为排除二进制的文件，当文件交大时包含二进制文件运行较快，如果是单文件，则没有这个选项
	name='main',  # 打包程序的名字
	debug=False,  # 是否启用调试功能
	bootloader_ignore_signals=False,
	# runtime_tmpdir=None,  # 生成单文件时需要这个参数，定义运行时的临时文件夹
	strip=False,
	upx=True,  # 打包的时候进行压缩，False表示不压缩；要用到一个压缩程序UPX，用于压缩文件，需要单独下载
	console=True,  # 打包后的可执行文件双击运行时屏幕会出现一个cmd窗口，不影响原程序运行，等于是是否加-w参数
	disable_windowed_traceback=False,  
	argv_emulation=False,
	target_arch=None,
	codesign_identity=None,
	entitlements_file=None,

	"""添加选项，初始化时没有的"""
	icon="",  # 指定应用程序的图标，传入路径，可以相对路径    
)
coll = COLLECT(
	"""
	如果是单文件模式，不需要这个COLLECT类，同时需要将：
    	a.binaries,
		a.zipfiles,
		a.datas,
	这些数据文件添加到EXE中
	"""
	exe,
	a.binaries,
	a.zipfiles,
	a.datas,
	strip=False,
	upx=True,
	upx_exclude=[],
	name='main',
)

如果需要更加详细的打包语法，可以到官方文档查看：https://pyinstaller.org/en/stable/index.html
在单文件模式下，不调用COLLECT，并且 EXE实例接收所有脚本、模块和二进制文
对于Analysis，我们主要要对:

script： 写所有的py文件
pathex：写项目的地址，以及自定义库的地址
datas：静态文件数据的地址
binaries：二进制文件地址，如果有报错，或者，需要用的时候再添加

其余的，不是常用的，直接运行不会影响程序的正常执行，但是想要更加精细一点的话，建议根据上面的注释来进行修改。

2、项目打包
然后，我们就需要将我们的项目进行打包了：
我们首先编写main.spec文件：

# -*- mode: python ; coding: utf-8 -*-

block_cipher = None

a = Analysis(
	['main.py', "demo1.py"],  
	pathex=["D:\\35005\\桌面\\demoTest"],
	binaries=[],
	datas=[("config\\*.json", "config")],
	hiddenimports=[],
	hookspath=[],
	hooksconfig={},
	runtime_hooks=[],
	excludes=[],
	win_no_prefer_redirects=False,
	win_private_assemblies=False,
	cipher=block_cipher,
	noarchive=False,
)

pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

exe = EXE(
	pyz,
	a.scripts,
	a.binaries,
	a.zipfiles,
	a.datas,
	[],
	name='main',
	debug=False,
	bootloader_ignore_signals=False,
	strip=False,
	upx=True,
	upx_exclude=[],
	runtime_tmpdir=None,
	console=True,
	disable_windowed_traceback=False,
	argv_emulation=False,
	target_arch=None,
	codesign_identity=None,
	entitlements_file=None,
)

这里是进行单个文件的打包，打包完成后，我们需要把那个config文件夹移动到可执行程序的同级目录下，然后就可以运行成功了！