Python使用pyinstaller打包spec文件的方法详解_Python

前言

在python项目的开发过程中，我们经常需要将脚本打包成独立的可执行文件，以便于在没有python环境的机器上运行。pyinstaller 是一个广泛使用的打包工具，可以将python程序及其依赖打包成单个文件或文件夹。在使用 pyinstaller 打包时，spec 文件是一个非常重要的配置文件，它定义了如何打包python脚本的各种细节。本文将详细介绍 pyinstaller 打包 spec 文件的用法。

pyinstaller 简介

什么是pyinstaller?

pyinstaller 是一个将python应用程序打包成独立可执行文件的工具，它支持windows、mac os x和linux等多个平台。打包后的程序可以在目标系统上运行而无需python解释器。

安装pyinstaller

要安装 pyinstaller，可以使用 pip：

pip install pyinstaller

基本用法

在命令行中使用 pyinstaller 命令来打包python脚本，例如：

pyinstaller your_script.py

运行此命令后，pyinstaller 会在当前目录下生成一个 dist 目录，里面包含了打包好的可执行文件。

spec 文件详解

spec 文件的生成

在首次使用 pyinstaller 打包脚本时，会生成一个默认的 spec 文件。生成 spec 文件的命令如下：

pyinstaller --name your_executable_name --onefile your_script.py

运行后，pyinstaller 会生成一个 your_script.spec 文件。这个文件是一个python脚本，包含了打包过程中需要的各种配置信息。

spec 文件的结构

spec 文件的基本结构如下：

# -*- mode: python ; coding: utf-8 -*-

block_cipher = none

a = analysis(
    ['your_script.py'],
    pathex=['/path/to/your_script'],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    runtime_hooks=[],
    excludes=[],
    win_no_prefer_redirects=false,
    win_private_assemblies=false,
    cipher=block_cipher,
)

pyz = pyz(a.pure, a.zipped_data, cipher=block_cipher)

exe = exe(
    pyz,
    a.scripts,
    a.binaries,
    a.zipfiles,
    a.datas,
    [],
    name='your_executable_name',
    debug=false,
    bootloader_ignore_signals=false,
    strip=false,
    upx=true,
    upx_exclude=[],
    runtime_tmpdir=none,
    console=true,
)

coll = collect(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=false,
    upx=true,
    upx_exclude=[],
    name='your_executable_name',
)

关键配置项详解

analysis：
- pathex：包含脚本的搜索路径。
- binaries：需要包含的额外二进制文件。
- datas：需要包含的额外数据文件。
- hiddenimports：需要手动指定的隐藏导入模块。
- hookspath：自定义的hook文件路径。
- runtime_hooks：运行时需要的hook文件。
pyz：
- 用于生成包含所有纯python模块的压缩包。
exe：
- name：生成的可执行文件名称。
- console：是否显示控制台窗口（windows）。
- debug：是否生成调试模式的可执行文件。
- upx：是否使用upx压缩可执行文件。
collect：
- 用于收集所有打包的文件，生成最终的分发文件夹。

示例：自定义spec文件

假设我们有一个python脚本 example.py，需要打包成一个包含额外数据文件和隐藏导入模块的可执行文件，示例如下：

# -*- mode: python ; coding: utf-8 -*-

block_cipher = none

a = analysis(
    ['example.py'],
    pathex=['/path/to/example'],
    binaries=[],
    datas=[('data_folder/', 'data_folder/')],
    hiddenimports=['hidden_module'],
    hookspath=[],
    runtime_hooks=[],
    excludes=[],
    win_no_prefer_redirects=false,
    win_private_assemblies=false,
    cipher=block_cipher,
)

pyz = pyz(a.pure, a.zipped_data, cipher=block_cipher)

exe = exe(
    pyz,
    a.scripts,
    a.binaries,
    a.zipfiles,
    a.datas,
    [],
    name='example_executable',
    debug=false,
    bootloader_ignore_signals=false,
    strip=false,
    upx=true,
    upx_exclude=[],
    runtime_tmpdir=none,
    console=true,
)

coll = collect(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=false,
    upx=true,
    upx_exclude=[],
    name='example_executable',
)

在这个 spec 文件中，我们指定了额外的数据文件 data_folder/ 和隐藏导入模块 hidden_module，打包后的可执行文件名为 example_executable。