Python高级技术之：`Python`的`pyinstaller`和`cx_Freeze`：将`Python`脚本打包成可执行文件。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，晚上好！我是老码，今晚咱们聊点实用的，关于如何把咱们辛辛苦苦写的Python脚本，变成人见人爱、点击就跑的可执行文件（exe）。

这事儿，听起来好像很高深，但其实就像把大象装冰箱一样，只需要三步（当然，实际操作肯定不止三步，但原理差不多）。我们需要借助两个神器：PyInstaller和cx_Freeze。

第一部分：为什么要把脚本打包成可执行文件？

在开始之前，咱们先唠唠嗑，说说为什么要费劲巴拉地把Python脚本打包成exe？

方便性: 想象一下，你写了一个炫酷的脚本，想分享给朋友，结果他电脑上没装Python环境，还得让他下载、安装、配置一堆东西，想想就头大。但如果你直接给他一个exe文件，双击就能运行，是不是方便多了？
保护源代码: 虽然Python是开源的，但有时候我们也不想让别人轻易看到我们的源代码，打包成exe可以起到一定的保护作用（当然，专业的逆向工程师还是能破解的，但至少能挡住一部分人）。
部署简化: 在生产环境中，如果需要部署Python脚本，直接部署exe文件可以省去很多配置环境的麻烦。

第二部分：PyInstaller：打包界的扛把子

PyInstaller，顾名思义，就是用来打包Python程序的。它功能强大，配置灵活，是目前最流行的Python打包工具之一。

2.1 安装PyInstaller

安装PyInstaller非常简单，只需要一条命令：

pip install pyinstaller

如果你的网络比较慢，可以考虑使用国内的镜像源，比如：

pip install pyinstaller -i https://pypi.tuna.tsinghua.edu.cn/simple

2.2 使用PyInstaller打包

假设我们有一个简单的Python脚本，名为hello.py，内容如下：

# hello.py
print("Hello, world!")
input("Press Enter to exit...")

现在，我们要把这个脚本打包成exe文件。打开命令行，进入hello.py所在的目录，执行以下命令：

pyinstaller hello.py

这条命令会生成一个dist目录和一个build目录。dist目录里就是打包好的exe文件。

2.3 PyInstaller常用参数

PyInstaller有很多参数，可以用来定制打包过程。下面是一些常用的参数：

参数	含义
`-F` 或 `--onefile`	将所有依赖项打包成一个单独的exe文件。
`-D` 或 `--onedir`	创建一个包含exe文件和所有依赖项的目录。这是默认选项。
`-w` 或 `--windowed`	移除控制台窗口。适用于GUI程序。
`-c` 或 `--console`	保留控制台窗口。适用于命令行程序。
`-n NAME` 或 `--name NAME`	指定exe文件的名称。
`--icon=ICON_FILE`	指定exe文件的图标。
`--hidden-import MODULE`	强制PyInstaller包含指定的模块。有些时候，PyInstaller可能无法自动检测到某些模块的依赖，这时就需要手动指定。
`--add-data SOURCE:DEST`	将指定的文件或目录添加到exe文件中。`SOURCE`是源文件或目录的路径，`DEST`是目标路径，相对于exe文件所在的目录。
`--exclude-module MODULE`	排除指定的模块。

举个例子，如果我们要把hello.py打包成一个单独的exe文件，并且移除控制台窗口，可以执行以下命令：

pyinstaller -F -w hello.py

如果我们要给exe文件指定一个图标，可以执行以下命令：

pyinstaller -F -w --icon=myicon.ico hello.py

2.4 解决常见问题

在使用PyInstaller的过程中，可能会遇到一些问题。下面是一些常见问题及解决方法：

缺少依赖项: 有些时候，PyInstaller可能无法自动检测到某些模块的依赖，导致程序运行时出错。这时，可以使用--hidden-import参数手动指定依赖的模块。

比如，如果你的程序使用了matplotlib模块，但PyInstaller没有自动检测到，可以执行以下命令：
```
pyinstaller --hidden-import matplotlib -F -w hello.py
```
数据文件丢失: 如果你的程序需要读取一些数据文件，比如配置文件、图片等，PyInstaller默认不会把这些文件打包到exe文件中。这时，可以使用--add-data参数手动添加数据文件。

比如，如果你的程序需要读取一个名为config.ini的配置文件，可以执行以下命令：
```
pyinstaller --add-data "config.ini:." -F -w hello.py
```
这条命令会将config.ini文件添加到exe文件所在的目录。
运行时出现FileNotFoundError: 这通常是因为程序中使用了相对路径来访问文件，而打包后的exe文件运行时的当前目录发生了变化。解决方法是使用绝对路径，或者使用os.path.dirname(sys.executable)来获取exe文件所在的目录。
```
import os
import sys

# 获取exe文件所在的目录
exe_dir = os.path.dirname(sys.executable)

# 构建配置文件的绝对路径
config_path = os.path.join(exe_dir, "config.ini")

# 读取配置文件
with open(config_path, "r") as f:
    # ...
    pass
```

2.5 PyInstaller进阶技巧

使用spec文件: PyInstaller可以通过spec文件来配置打包过程。spec文件是一个Python脚本，包含了打包的所有配置信息。

要生成spec文件，可以执行以下命令：
```
pyi-makespec hello.py
```
这条命令会生成一个名为hello.spec的文件。你可以修改这个文件来定制打包过程。

然后，使用以下命令来使用spec文件进行打包：
```
pyinstaller hello.spec
```
Hook文件: PyInstaller支持使用hook文件来处理一些特殊的模块。hook文件是一个Python脚本，用于告诉PyInstaller如何处理某个模块的依赖。

如果PyInstaller无法正确处理某个模块的依赖，你可以编写一个hook文件来解决这个问题。

hook文件通常位于PyInstaller/hooks目录下。

第三部分：cx_Freeze：轻量级的选择

cx_Freeze是另一个Python打包工具。它比PyInstaller更轻量级，配置也更简单。

3.1 安装cx_Freeze

安装cx_Freeze也很简单：

pip install cx_Freeze

同样，如果网络慢，可以考虑使用国内镜像源。

3.2 使用cx_Freeze打包

使用cx_Freeze打包需要编写一个setup脚本。假设我们有一个简单的Python脚本，名为hello.py，内容如下：

# hello.py
print("Hello, world!")
input("Press Enter to exit...")

现在，我们要把这个脚本打包成exe文件。创建一个名为setup.py的文件，内容如下：

# setup.py
import sys
from cx_Freeze import setup, Executable

# Dependencies are automatically detected, but exclude tkinter
build_exe_options = {"packages": ["os"], "excludes": ["tkinter"]}

# GUI applications require a different base on Windows (the default is for
# a console application).
base = None
if sys.platform == "win32":
    base = "Win32GUI"  # 如果是GUI程序，使用"Win32GUI"

setup(  name = "hello",
        version = "0.1",
        description = "My Hello World Application!",
        options = {"build_exe": build_exe_options},
        executables = [Executable("hello.py", base=base)])

然后，在命令行中执行以下命令：

python setup.py build

这条命令会在build目录下生成打包好的exe文件。

3.3 cx_Freeze常用参数

cx_Freeze的setup脚本中可以配置很多参数。下面是一些常用的参数：

参数	含义
`name`	可执行文件的名称。
`version`	程序的版本号。
`description`	程序的描述。
`options`	一个字典，包含了构建选项。
`executables`	一个列表，包含了要打包的可执行文件。每个可执行文件都是一个`Executable`对象。
`packages`	一个列表，包含了要包含的Python包。
`excludes`	一个列表，包含了要排除的Python包。
`includes`	一个列表，包含了要强制包含的Python模块。
`include_files`	一个列表，包含了要包含的文件。列表中的每个元素都是一个元组，包含了源文件和目标路径。例如：`[("myfile.txt", "path/to/destination")]`。
`base`	指定可执行文件的类型。对于GUI程序，在Windows平台上应该设置为`"Win32GUI"`。对于命令行程序，可以设置为`None`。

举个例子，如果我们要把hello.py打包成一个GUI程序，可以修改setup.py文件如下：

# setup.py
import sys
from cx_Freeze import setup, Executable

# Dependencies are automatically detected, but exclude tkinter
build_exe_options = {"packages": ["os"], "excludes": ["tkinter"]}

# GUI applications require a different base on Windows (the default is for
# a console application).
base = None
if sys.platform == "win32":
    base = "Win32GUI"

setup(  name = "hello",
        version = "0.1",
        description = "My Hello World Application!",
        options = {"build_exe": build_exe_options},
        executables = [Executable("hello.py", base=base)])

3.4 解决常见问题

在使用cx_Freeze的过程中，也可能会遇到一些问题。下面是一些常见问题及解决方法：

缺少DLL文件: 有些时候，打包后的exe文件运行时会提示缺少DLL文件。这通常是因为程序依赖了一些动态链接库，而cx_Freeze没有自动把这些DLL文件打包到exe文件中。解决方法是手动把这些DLL文件复制到exe文件所在的目录。

可以在setup.py中使用include_files选项来包含所需的DLL文件。
程序无法运行: 这可能是因为程序依赖了一些系统库，而这些库没有被正确地包含到exe文件中。解决方法是尝试使用includes选项来包含这些库。

第四部分：PyInstaller vs cx_Freeze：如何选择？

PyInstaller和cx_Freeze都是优秀的Python打包工具，那么我们应该如何选择呢？

特性	PyInstaller	cx_Freeze
易用性	相对复杂，需要熟悉各种参数。	相对简单，通过setup脚本配置。
功能	功能强大，支持各种高级特性。	功能相对简单，但足以满足大多数需求。
打包体积	打包后的文件通常较大。	打包后的文件通常较小。
兼容性	兼容性较好，支持各种平台。	兼容性较好，但可能需要手动配置一些平台相关的选项。
社区支持	社区活跃，文档完善。	社区相对较小，但文档也比较完善。

总的来说：

如果你需要打包一个复杂的程序，并且需要使用各种高级特性，那么PyInstaller可能更适合你。
如果你只需要打包一个简单的程序，并且希望打包后的文件体积尽可能小，那么cx_Freeze可能更适合你。
如果你是新手，可以先尝试cx_Freeze，如果遇到问题再尝试PyInstaller。

第五部分：总结

好了，各位观众老爷，今天的讲座就到这里了。希望通过今天的讲解，大家能够掌握Python打包的基本技巧，把自己的Python脚本变成人见人爱的可执行文件。

记住，打包的过程可能会遇到各种问题，但不要灰心，多查资料，多尝试，总能找到解决方法。

最后，祝大家编程愉快！下课！