使用 PyInstaller 和 pkg_resources 打包 Flask 应用为单个 .exe 文件

在将 Flask 应用打包为单个 .exe 文件时，通常会遇到的问题是 static 和 templates 文件夹中的资源文件没有被包含在打包中。本文将介绍如何结合 PyInstaller 和 pkg_resources 将这些资源文件正确打包到 .exe 文件中，并确保程序运行时能够访问这些文件。

项目结构

首先，我们假设 Flask 项目结构如下：

project/
├── app.py         # 主程序文件
├── static/        # 静态文件
│   ├── style.css
│   └── script.js
├── templates/     # HTML 模板文件
│   ├── index.html
│   └── base.html

其中，static 文件夹包含 CSS 和 JS 文件，templates 文件夹包含 HTML 模板。

使用 pkg_resources 定位资源文件

在打包后的运行环境中，资源文件会被解压到临时目录。我们可以使用 pkg_resources 来定位这些文件。

修改 Flask 应用代码

在 app.py 中，使用 pkg_resources 来动态定位资源路径：

import os
from flask import Flask
import pkg_resources

def resource_path(relative_path):
    """获取被打包的资源路径"""
    return pkg_resources.resource_filename(__name__, relative_path)

app = Flask(__name__,
            static_folder=resource_path('static'),
            template_folder=resource_path('templates'))

@app.route('/')
def index():
    return "Hello, Flask!"

在上述代码中：

• pkg_resources.resource_filename(__name__, relative_path) 返回资源文件的解压路径。
• 使用 static_folder 和 template_folder 参数动态设置 Flask 的静态文件和模板路径。

使用 PyInstaller 打包

在打包过程中，需要显式指定 static 和 templates 文件夹。

打包命令

运行以下命令：

pyinstaller --onefile --add-data "static;static" --add-data "templates;templates" app.py

• --onefile：生成单个 .exe 文件。

• --add-data：将静态文件和模板文件夹添加到打包中。

  • 在 Windows 上使用分号 ; 分隔路径。
  • 在 macOS 和 Linux 上使用冒号 :。

验证结果

1. 打包完成后，运行生成的 .exe 文件。
2. 访问浏览器中的 http://127.0.0.1:5000，验证静态文件和模板是否正常加载。

注意事项

1. 确保安装 setuptools

pkg_resources 是 setuptools 的一部分，确保打包环境中已安装该模块：

pip install setuptools

2. 动态路径的优势

相比直接使用 os.path，pkg_resources 更适合处理打包资源，因为它能正确处理临时解压目录中的路径。

3. 打包调试

如果资源文件未正确加载，可以检查：

• 打包命令中的 --add-data 参数是否正确。
• 应用运行时是否能够定位到资源文件。

总结

通过结合 PyInstaller 和 pkg_resources，可以将 Flask 应用的 static 和 templates 文件夹成功打包到单个 .exe 文件中。这种方法不仅简单高效，还能确保应用在运行时正确加载资源文件。

希望本文对你有所帮助！如果有其他问题，欢迎留言交流。