pyinstaller打包python文件成exe(原理.安装.问题)

py文件打包成exe文件的方式一共有三种：py2exe、PyInstaller和cx_Freeze

本文分四个步骤来详讲如何用PyInstaller将py文件打包成exe文件

1. PyInstaller 简介
2. PyInstaller 安装
3. 将py文件打包成exe文件
4. PyInstaller打包常见问题

一. PyInstaller简介

1.python相关文件介绍

python作为一门解释型脚本语言，它有三种发布方式：
        .py文件 : 源码文件，运行需要使用者安装Python环境并且安装依赖的各种库
        .pyc文件：pyc文件是Python解释器可以识别的二进制码，可跨平台的，需要使用者安装相应版本的Python和依赖库。
        可执行文件：不需要安装python环境和依赖库,可针对不同平台需要打包不同的可执行文件（Windows,Linux,Mac,...）

2.PyInstaller的原理简介

1. PyInstaller工具可以把python解析器和脚本打包成一个可执行的文件，并不是编译成真正的机器码，打包成一个可执行文件后运行效率可能会降低，好处就是在使用者的机器上可以不用安装python和你的脚本依赖的库。
2. 利用PyInstaller对指定的的脚本打包时，会先分析脚本所依赖的其他脚本，然后根据导包路径去查找，把所有相关的脚本收集起来，包括Python解析器，然后根据你的命令参数可分别生成文件夹，或者打包成一个可执行文件。
3. 无论是生成的文件夹里的可执行文件或者只打包成一个可执行文件都可以直接运行，前者需要把整个文件夹都给别人。

注意⚠️：PyInstaller打包的执行文件，只能在和打包机器系统同样的环境下。也就是说，不具备可移植性，若需要在不同系统上运行，就必须针对该平台进行打包。

二. PyInstaller的安装

这里建议安装python环境管理工具conda，做到不同的环境隔离
https://www.cnblogs.com/trotl/p/11863544.html

1. PyInstaller在windows下的安装

使用命令pip install PyInstaller即可
在windows下，pyinstaller需要PyWin32的支持。当用pip安装PyInstaller时未找到PyWin32，会自动安装pypiwin32

2. PyInstaller在mac,linux下的安装

pip install PyInstaller

三. PyInstaller打包

1. options参数说明

通用参数

与生成结果有关参数

Windows和Mac特有的参数

2. 基本语法：

PyInstaller -F -w -i  xxx.ico dev.py --hidden-import=pandas._libs.tslibs.timedeltas

常用参数：
-F 指只生成一个exe文件，不生成其他dll文件
-w 不弹出交互窗口,如果你想程序运行的时候，与程序进行交互，则不加该参数
-i 设定程序图标 ，其后面的xxx.ico文件就是程序小图标
dev.py 要打包的程序，如果你不是在dev.py同一级目录下执行的打包命令，这里得写上dev.py的路径地址
–hidden-import=pandas._libs.tslibs.timedeltas 隐藏相关模块的引用

注意⚠️：你在哪个目录下执行的命令，默认打包完成的文件或者文件夹就在该目录

四. PyInstaller打包常见问题

⚠️避坑点(打包之前请先看看)：

1. 路径最好为英文，没有中文字符；
2. 脚本名称里没有特殊字符
3. 使用utf-8编码
4. 图标文件必须是正常格式，为.ico文件
5. 命令使用pyinstaller和pyinstaller.exe结果都是一样的
6. 参数的添加得在pyinstaller和dev.py文件中间，不能随意位置添加
7. 如果你打包的代码中用到了静态文件，如图片和资源文件，需手动复制到文件夹中，否则exe文件会报找不到文件的错
8. 代码里导包最好使用from的方式，可节省打包后的文件大小
9. 就是当你使用错误的参数去打包或者打包到一半中断，等等此类运行到一半没了的情况。会导致你原来的py文件变成一个0KB的空文件。里面的代码会全部消失！！！所以以后需要有个良好的习惯，就是复制一份代码出来，用这个副本进行打包。并且参数出错，或者打错了导致失败时，检查下副本文件的py文件是否还存在再继续重新打包，不然打出来的就是空的文件，自然一直闪退，因为压根没内容(这点我没遇到过，来自别人的提醒)
10. pygame代码调试的时候要在结束时加quit()不然程序会崩溃
11. py文件运行没问题，不代表你打包后的文件运行就没问题，所以在打包好文件，打算运行exe文件测试时一定要录屏，因为报错会一闪而逝然后程序关闭，不仔细看的话，发现不了还报错，只会认为程序一运行就闪退，会让人不明所以，都不知道为什么，只有清楚报的什么错才好去解决，所以，一定要录屏！！！！
12. 如果在py文件中用到了多进程，且你在Windows下编译需要加一行代码在开头，multiprocessing.freeze_support() 
13. 打包的时候要进入到能运行这个py文件的虚拟环境中，不能在别的环境中对py文件打包，不然打包的结果还是你原来的环境，可能打包文件过大，或者引起缺失包等其他问题
14. 如果有打包错误，具体看build里的warn***.txt文档，里面详细记载了错误的原因。一般都是库丢失

⚠️Bug：

1. “IndexError: tuple index out of range”

错误分析：这个问题是当前的pyinstaller版本不支持python的版本
解决办法：修改pyinstaller的版本，pip install pyinstaller==适合你的版本

**2. ImportError: C extension: No module named‘pandas._libs.tslibs.timedeltas’ **

错误分析：因为我的代码中引用了pandas库，然后使用pyinstaller打包的时候显示模块缺失
解决办法：
1. 忽略此模块(打包时加上–hidden-import=pandas._libs.tslibs.timedeltas)
2. 添加文件
    在你的python3的安装路径下找到PyInstaller/hooks的位置
        如C:Python36Libsite-packagesPyInstallerhooks
    新建文件hook-pandas.py，并填写以下内容：
                        hiddenimports=[
                            #all your previous hidden imports
                            'pandas', 'pandas._libs.tslibs.timedeltas'
                        ]