PyInstaller 打包 Python 脚本文件及配置文件的详细教程

PyInstaller 是一个非常实用的工具，可以将 Python 脚本及其依赖项（包括库和配置文件等）打包成一个独立的可执行文件。这样，你就可以在没有安装 Python 环境的机器上运行你的程序了。下面是如何使用 PyInstaller 打包 Python 脚本以及如何包含配置文件的步骤：

1. 安装 PyInstaller

首先，确保你已经安装了 PyInstaller。如果还没有安装，可以通过 pip 进行安装：

pip install pyinstaller

2. 打包 Python 脚本

假设你有一个名为 main.py 的 Python 脚本，并且该脚本依赖于一个名为 config.ini 的配置文件。你可以通过以下命令来生成一个可执行文件：

pyinstaller --onefile main.py

这里的 --onefile 参数表示将所有依赖打包进一个单独的可执行文件中。如果你希望输出一个包含多个文件（如 .exe 和一些依赖库）的目录结构，可以省略此参数。

3. 包含配置文件

默认情况下，PyInstaller 不会自动包含非 Python 文件（如配置文件、图片等）。为了将 config.ini 配置文件包含进打包的可执行文件中，你需要修改你的脚本，使其能够从可执行文件所在的目录加载配置文件，或者显式地告诉 PyInstaller 将该文件包含进来。

方法一：修改脚本动态加载配置文件路径

在你的 Python 脚本中，使用如下方式获取当前脚本目录，从而动态读取配置文件：

import os
import configparser

def get_config_path():
    return os.path.join(os.path.dirname(os.path.abspath(__file__)), 'config.ini')

config = configparser.ConfigParser()
config.read(get_config_path())
# ... 使用配置...

这样，无论你的脚本被打包到哪里，都能正确找到配置文件。

方法二：使用 PyInstaller 的数据文件功能

如果你不想修改脚本，或者希望更直接地控制哪些额外文件被包含，可以在打包时使用 -add-data 参数指定要包含的额外文件或目录。例如：

pyinstaller --onefile --add-data "config.ini;." main.py

这里，--add-data 后面跟的是“源文件或目录;目标目录”，. 表示目标目录为可执行文件所在目录。这样，config.ini 就会被复制到生成的可执行文件的同一目录下。

4. 测试打包后的程序

打包完成后，根据你的操作系统，在 dist 目录下找到生成的可执行文件。将其移动到一个没有原始脚本和配置文件的新目录中测试，确保一切正常工作。

通过以上步骤，你就可以成功地使用 PyInstaller 打包 Python 脚本及配置文件了。

作者：学亮编程手记