zl程序教程

您现在的位置是:首页 >  其它

当前栏目

pyinstaller用法

用法 Pyinstaller
2023-09-11 14:21:25 时间
pip install pyinstaller
#系统的python打包
pyinstaller -F ./autocheckin.py -p ~/.local/lib/python3.8/site-packages/
#pyenv的虚拟环境打包(注意替换里面的`虚拟环境名称`,是否需要指定多个路径取决于实际情况)
pyinstaller -F ./autocheckin.py \
-p '~/.pyenv/versions/虚拟环境名称/lib/python3.8/site-packages/,\
/usr/local/lib/python3.8/dist-packages,\
/usr/lib/python3/dist-packages,\
/usr/lib/python3.8/dist-packages'
#添加其他资源(Linux)data或者binary文件路径之前使用冒号。
pyinstaller --noconfirm --log-level=WARN \
    --onefile --nowindow \
    --add-data="README:." \
    --add-data="image1.png:img" \
    --add-binary="libfoo.so:lib" \
    --hidden-import=secret1 \
    --hidden-import=secret2 \
    --upx-dir=/usr/local/share/ \
    myscript.spec
#windows需要不一样的换行符,data或者binary文件路径之前使用分号。
pyinstaller --noconfirm --log-level=WARN ^
    --onefile --nowindow ^
    --add-data="README;." ^
    --add-data="image1.png;img" ^
    --add-binary="libfoo.so;lib" ^
    --hidden-import=secret1 ^
    --hidden-import=secret2 ^
    --icon=..\MLNMFLCN.ICO ^
    myscript.spec

pyinstaller通用参数

参数名描述说明
-h显示帮助
-v显示版本号
–distpath生成文件放在哪里默认:当前目录的dist文件夹内
–workpath生成过程中的中间文件放在哪里默认:当前目录的build文件夹内
-y如果dist文件夹内已经存在生成文件,则不询问用户,直接覆盖默认:询问是否覆盖
–upx-dirUPX_DIR 指定upx工具的目录默认:execution path
-a不包含unicode支持默认:尽可能支持unicode
–clean在本次编译开始时,清空上一次编译生成的各种文件默认:不清除
–log-levelLEVEL 控制编译时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
-d执行生成的main.exe会输出pyi的一些log,有助于查错 默认:不输出pyi的log
-s优化符号表原文明确表示不建议在windows上使用
–noupx强制不使用upx默认:尽可能使用。
–runtime-tmpdir指定运行时的临时目录默认:使用系统临时目录

指定打包哪些资源、代码

参数名描述说明
–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需要排除的modulepyi会分析出很多相互关联的库,但是某些库对用户来说是没用的,可以用这个参数排除这些库,有助于减少生成文件的大小
–keypyi会存储字节码指定加密字节码的key 16位的字符串

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请参考原文

例子

如下脚本将autocheckin.py打包为一个文件(参数-F),并且指定包含一个库文件libtdjson.so(文件路径用文件名冒号之后的符号指定,本例中是当前目录.),还要包含pyenv中名为tele虚拟环境以及系统 内置python3.8中的各种模块相关文件(注意替换里面的虚拟环境名称,是否需要指定多个路径取决于实际情况)

pyinstaller -F ./autocheckin.py --add-binary="libtdjson.so:."\
-p '~/.pyenv/versions/虚拟环境名称/lib/python3.8/site-packages/,\
/usr/local/lib/python3.8/dist-packages,\
/usr/lib/python3/dist-packages,\
/usr/lib/python3.8/dist-packages'

#或者
pyinstaller -F ./autocheckin.py 
-p ~/.pyenv/versions/虚拟环境名称/lib/python3.8/site-packages/

参考资料: https://pyinstaller.readthedocs.io/en/v3.3.1/usage.html