pyinstaller是最常用的python程序打包成可执行程序(exe)的工具,这篇文章将介绍几个pyinstaller打包可能遇到的问题及其解决方法。

安装

pyinstaller的安装很简单,直接pip安装就可以。

pip install pyinstaller

打包指令

-F

生成一个exe程序,所有依赖项被打包进该exe程序中

-D

生成一个包含exe程序的目录,所有依赖项和exe程序位于同一目录下

-i

为生成的exe程序指定一个icon图标

-n

指定生成的.exe和.spec文件名

-c

显示命令行窗口

-w

不显示命令行窗口

–distpath

指定打包后的程序存放目录,默认为当前目录下的dist目录

–workpath

为输出的所有临时文件指定存放目录

-h

帮助信息

例如,打包成一个exe文件:

pyinstaller -F test.py

打包成一个exe,实际运行目录

将程序打包成一个exe文件后,每次运行时,pyinstaller会先将exe解压到一个临时目录,然后运行主文件,这个目录所在位置在c:/users/xxxx/AppData/Local/Temp目录下,一般为_MEI开头的文件夹。

pyinstaller 封装命令(pyinstaller打包python程序高级技巧)(1)

pyinstaller临时文件夹

需要注意的是:

  1. 每次运行都需要这个解压过程,所以如果exe文件太大,解压需要消耗很长时间,所以大文件不建议打包成一个exe。
  2. 临时文件夹可能不会自动删除,会导致临时文件越积越多,占用磁盘空间。
多进程程序打包无法运行

如果使用到了多进程程序,打包后可能出现循环调用,无法运行程序。这时需要加入一下代码解决,并且最好写在第一行。

from multiprocessing import freeze_support freeze_support()

打包文件太大,如何瘦身

pyinstaller需要将python环境一起打包进去,所以本身打包后的文件就会比较大,但是一些没有用到的模块很可能也被打包进去了,应该想办法将这些模块排除掉。

我们可以先选择不打包为一个exe文件(即不使用-F),然后到dist文件目录下的打包成功目录看看哪个文件或文件夹(模块)最大,分析这个文件或模块是否是必须使用的依赖,甚至可以一个一个排除测试exe是否可以正常执行。

这个时候需要手动编辑spec文件中的excludes,例如:

a = Analysis(['test.py'], pathex=['E:\\python-workspace\\test'], binaries=[], datas=[], hiddenimports=[], hookspath=[], runtime_hooks=[], excludes=['matplotlib','PIL','cython','PyQt4','zmq'], win_no_prefer_redirects=False, win_private_assemblies=False, cipher=block_cipher, noarchive=False)

找不到模块

打包过程中报错,找不到某个模块。

ModuleNotFoundError: No module nameduvicorn

这时首先可以尝试在hiddenimports中引入这个模块再次打包。

a = Analysis(['test.py'], pathex=['E:\\python-workspace\\test'], binaries=[], datas=[], hiddenimports=[ 'fastapi', 'uvicorn.logging'], hookspath=[], runtime_hooks=[], excludes=['matplotlib','PIL','cython','PyQt4','zmq'], win_no_prefer_redirects=False, win_private_assemblies=False, cipher=block_cipher, noarchive=False)

无法引入某些模块的dll

例如使用扫码组件pyzbar,打包执行时提示找不到dll,这时,可以在spec文件中的binaries手动引入。实际代码如下:

import pyzbar import pathlib pyzbar_dir = pathlib.Path(pyzbar.__file__).parent pyzbar_dlls = [(str(dll), '.') for dll in pyzbar_dir.glob('*.dll')] dlls = pyzbar_dlls a = Analysis(['test.py'], pathex=['E:\\python-workspace\\test'], binaries=dlls, ... )

其他资源文件打包

如果需要打包配置文件或者图片资源,可以在spec文件中的datas手动引入。例如打包config文件夹下所有内容:

a = Analysis(['test.py'], pathex=['E:\\python-workspace\\test'], binaries=[], datas=[('config\\','config')], hiddenimports=[], hookspath=[], runtime_hooks=[], excludes=[], win_no_prefer_redirects=False, win_private_assemblies=False, cipher=block_cipher, noarchive=False)

打包后的可执行文件无法在别人电脑运行

程序在自己电脑运行正常,但是在别人电脑上直接弹出错误,而且没有具体报错。这很可能是缺少了一些必要的系统dll。因为很多python模块还需要vcruntime等dll,如果自己的开发电脑已经安装vc运行环境而别人的电脑没有安装,程序就无法运行。

我们可以使用https://github.com/lucasg/Dependencies这个开源项目提供的工具来查看exe文件依赖的dll,然后看我们打包程序中是否缺少某些必要依赖,如果缺少dll,则可以通过上述的binaries或datas中手动引入的方式打包dll。

例如缺少vcruntime140相关dll:

a = Analysis(['test.py'], pathex=['E:\\python-workspace\\test'], binaries=[], datas=[('C:\\Windows\\System32\\vcomp140.dll','.'),('C:\\Windows\\System32\\vcruntime140_1.dll','.')], hiddenimports=[], hookspath=[], runtime_hooks=[], excludes=[], win_no_prefer_redirects=False, win_private_assemblies=False, cipher=block_cipher, noarchive=False)

,