使用同一 .spec 文件控制 PyInstaller 打包程序是否显示控制台

本文介绍如何使用同一 PyInstaller .spec 文件，通过命令行参数控制打包后的 PyQt5 应用程序是否显示控制台窗口，从而方便开发调试和生成最终发布版本。该方法避免了维护多个 .spec 文件，确保不同构建版本（开发、候选发布、正式发布）的一致性，仅在控制台显示上有所区别。此方案依赖于 PyInstaller 6.0.0 及以上版本。

在开发 PyQt5 应用程序时，我们通常希望在调试阶段显示控制台窗口，以便查看输出信息和错误日志。然而，在最终发布版本中，我们通常会隐藏控制台窗口，以提供更简洁的用户体验。 使用不同的 .spec 文件来实现这一目标会增加维护成本，并可能导致不同构建版本之间的差异。

PyInstaller 6.0.0 引入了向 .spec 文件添加参数的功能，允许我们通过命令行参数动态修改 .spec 文件中的变量，从而实现使用同一 .spec 文件控制控制台显示。

步骤：

1. 升级 PyInstaller： 确保你使用的 PyInstaller 版本为 6.0.0 或更高版本。可以使用以下命令升级：

   pip install --upgrade pyinstaller

2. .spec 文件配置： 修改你的 .spec 文件，添加一个参数来控制 console 变量。

   例如，假设你的 .spec 文件名为 my_app.spec，你需要修改 EXE 对象，添加 console 参数。以下是一个示例：

   # my_app.spec
   # -*- mode: python ; coding: utf-8 -*-
   
   block_cipher = None
   
   a = Analysis(['my_app.py'],
                pathex=['.'],
                binaries=[],
                datas=[],
                hiddenimports=[],
                hookspath=[],
                hooksconfig={},
                runtime_hooks=[],
                excludes=[],
                win_no_prefer_redirects=False,
                win_private_assemblies=False,
                cipher=block_cipher,
                noarchive=False)
   pyz = PYZ(a.pure, a.zipped_data,
                cipher=block_cipher)
   
   exe = EXE(pyz,
             a.scripts,
             [],
             exclude_binaries=True,
             name='my_app',
             debug=False,
             bootloader_ignore_signals=False,
             strip=False,
             upx=True,
             console=True, # 默认显示控制台
             disable_windowed_traceback=False,
             argv_emulation=False,
             target_arch=None,
             codesign_identity=None,
             entitlements_file=None )
   coll = COLLECT(exe,
                  a.binaries,
                  a.zipfiles,
                  a.datas,
                  strip=False,
                  upx=True,
                  upx_exclude=[],
                  name='my_app')

3. 使用命令行参数控制控制台显示：

   

   启山智软物流配送系统

   启山智软物流配送是基于Spring Cloud 和 Vue.js的JAVA物流配送系统。包含总控制后台 、城市合伙人(商家pc端)、 区域团长后台 、用户端小程序 、手机H5等多个操作模块。为响应用户需求我们新增了后台自定义装修组件模块，使页面更加美观，操作更加灵活简便。淘宝商品CSV一键导入，提升用户使用感。还有与众不同的管理台侧边栏设计，打破传统管理台样式。 另有公众号接龙、引导页上传、区域团

   下载

   • 显示控制台（调试模式）：

     pyinstaller my_app.spec

     或者显式指定console参数：

     pyinstaller --additional-hooks-dir=. --console my_app.spec

   • 隐藏控制台（发布模式）：

     pyinstaller --additional-hooks-dir=. --noconsole my_app.spec

   解释：

   • --additional-hooks-dir=. 这个选项在某些情况下可能需要，用于指定额外的 hook 脚本目录。如果你的项目依赖于一些隐藏的 import，并且 PyInstaller 无法自动检测到它们，你需要创建 hook 脚本来处理这些依赖。如果你的项目没有额外的 hook 脚本，可以省略这个选项。
   • --console 参数显式地设置 console=True，强制显示控制台。
   • --noconsole 参数显式地设置 console=False，强制隐藏控制台。

注意事项：

• 请确保你的 PyInstaller 版本满足要求（6.0.0 及以上）。
• 如果你的应用程序依赖于一些隐藏的 import，你可能需要创建 hook 脚本来处理这些依赖。
• 在发布版本中，务必使用 --noconsole 参数来隐藏控制台窗口。

总结：

通过使用 PyInstaller 6.0.0 及以上版本提供的参数化 .spec 文件功能，我们可以方便地控制打包后的应用程序是否显示控制台窗口，从而简化开发流程并确保不同构建版本之间的一致性。 这提供了一种更灵活和高效的方式来管理 PyQt5 应用程序的打包过程。