使用 PyInstaller 打包 Python 脚本文件及配置文件

使用 PyInstaller 打包 Python 脚本文件及配置文件

在 Python 开发中，打包应用程序是一个常见的需求，特别是当我们需要将应用程序分发给用户时。PyInstaller 是一个非常流行的工具，可以帮助我们将 Python 脚本及其依赖打包成独立的可执行文件。在这篇文章中，我们将探讨如何使用 PyInstaller 打包 Python 脚本及其配置文件。

1. 安装 PyInstaller

首先，我们需要安装 PyInstaller。您可以通过 pip 命令轻松完成安装：

pip install pyinstaller

检查安装是否成功，可以通过以下命令获取 PyInstaller 的版本：

pyinstaller --version

2. 准备项目目录

假设我们的项目结构如下：

my_project/
│
├── main.py              # 主脚本
├── config.json          # 配置文件

main.py 是我们的主程序，config.json 是我们需要在程序运行时读取的配置文件。

main.py 的简单示例代码如下：

import json

def load_config(filename):
    with open(filename, 'r', encoding='utf-8') as f:
        return json.load(f)

if __name__ == "__main__":
    config = load_config('config.json')
    print("配置内容:", config)

3. 使用 PyInstaller 打包

我们可以使用 PyInstaller 命令将 Python 脚本打包成单个可执行文件。基本的命令如下：

pyinstaller --onefile main.py

这个命令会创建一个 dist 文件夹，其中包含打包后的 main 可执行文件。

然而，默认情况下，PyInstaller 不会将其他非 Python 文件（如 config.json）包含在内。为了解决这个问题，我们需要在打包时告诉 PyInstaller 也包含这些配置文件。

4. 指定打包文件

我们可以使用 --add-data 参数来指定将其他文件打包到可执行文件中。具体命令如下：

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

这里，--add-data "config.json;." 表示将 config.json 文件添加到当前目录（"."），以便在运行时可以正常读取。

5. 修改代码以支持打包后的文件结构

PyInstaller 打包后，文件结构会有所变化，因此在读文件时需要考虑到这一点。如果你的程序在不同环境中读取文件，应该使用 sys._MEIPASS 来处理路径。修改后的 load_config 函数如下：

import json
import os
import sys

def load_config(filename):
    if getattr(sys, 'frozen', False):
        # 如果在打包后的程序中运行
        base_path = sys._MEIPASS
    else:
        # 在开发环境中运行
        base_path = os.path.dirname(__file__)

    config_file_path = os.path.join(base_path, filename)

    with open(config_file_path, 'r', encoding='utf-8') as f:
        return json.load(f)

if __name__ == "__main__":
    config = load_config('config.json')
    print("配置内容:", config)

6. 完成打包

现在我们再运行一次 PyInstaller 命令：

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

执行完成后，在 dist 文件夹中找到生成的可执行文件，您可以将其发送给其他用户，他可以在没有 Python 环境的情况下直接运行这个程序。

7. 结论

通过以上步骤，我们成功地使用 PyInstaller 打包了一个 Python 脚本及其配置文件。注意，打包时想要包含其他数据文件需要使用 --add-data 参数，并在代码中适当处理路径。这种打包方式不仅可以简化部署过程，还能提高程序的可用性和用户体验。希望这篇文章对您有所帮助，让您在项目中能够顺利使用 PyInstaller 打包您的应用。