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

本文介绍如何在使用 PyInstaller 打包 PyQt5 应用时，通过修改 .spec 文件，实现在开发和调试阶段显示控制台，而在最终发布版本中隐藏控制台。重点在于利用 PyInstaller 6.0.0 及其以上版本中新增的参数传递功能，在同一 .spec 文件基础上，通过命令行参数控制 console 选项，从而避免维护多个 .spec 文件带来的不便。

在使用 PyInstaller 打包 Python 应用时，我们通常会创建一个 .spec 文件来配置打包过程。 默认情况下，PyInstaller 会根据 .spec 文件中的 console 选项来决定是否显示控制台窗口。 然而，在开发和调试阶段，我们可能需要显示控制台以便查看输出和错误信息，而在最终发布版本中，则希望隐藏控制台窗口，以提供更友好的用户体验。

为了解决这个问题，我们可以利用 PyInstaller 6.0.0 及其以上版本中新增的参数传递功能，通过命令行参数来动态控制 .spec 文件中的 console 选项。

步骤如下：

1. 更新 PyInstaller 版本：

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

   pip install --upgrade pyinstaller

2. 修改 .spec 文件：

   在 .spec 文件中，找到 EXE 对象，并添加 console 参数。为了能够通过命令行参数控制 console 的值，我们可以使用 **opts 接收命令行参数，并在 EXE 对象中使用条件表达式来设置 console 的值。

   以下是一个示例 .spec 文件：

   # -*- mode: python ; coding: utf-8 -*-
   
   block_cipher = None
   
   a = Analysis(
       ['your_script.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,
       a.binaries,
       a.zipfiles,
       a.datas,
       [],
       name='your_application',
       debug=False,
       bootloader_ignore_signals=False,
       strip=False,
       upx=True,
       upx_exclude=[],
       runtime_tmpdir=None,
       console=False if 'noconsole' in kwargs else True,  # 通过命令行参数控制 console 选项
       disable_windowed_traceback=False,
       argv_emulation=False,
       target_arch=None,
       codesign_identity=None,
       entitlements_file=None,
   )

   解释：

   

   Figma

   Figma 是一款基于云端的 UI 设计工具，可以在线进行产品原型、设计、评审、交付等工作。

   下载
   • console=False if 'noconsole' in kwargs else True：这行代码使用条件表达式来设置 console 的值。如果命令行参数中包含 noconsole，则 console 的值为 False，否则为 True。 kwargs 是一个字典，用于接收传递给 .spec 文件的命令行参数。

3. 使用 PyInstaller 打包：

   • 显示控制台 (开发/调试)：

     pyinstaller your_application.spec

     或者

     pyinstaller your_application.spec --console

     不添加 noconsole 参数，console 默认为 True。

   • 隐藏控制台 (发布版本)：

     pyinstaller your_application.spec --noconsole

     添加 --noconsole 参数，console 被设置为 False。

注意事项：

• 确保你的 .spec 文件中使用了正确的脚本文件名 (your_script.py) 和应用程序名称 (your_application)。
• kwargs 变量在 PyInstaller 6.0.0 及以上版本中可用，如果使用较低版本，需要升级 PyInstaller。
• 这种方法允许你使用同一个 .spec 文件，通过简单的命令行参数来控制是否显示控制台，从而简化了打包流程。
• 如果需要更复杂的配置，可以参考 PyInstaller 的官方文档：PyInstaller documentation。

总结：

通过修改 .spec 文件并利用 PyInstaller 6.0.0 及其以上版本的参数传递功能，我们可以轻松地控制打包时是否显示控制台，从而满足不同场景的需求，并提高开发效率。 这种方法避免了维护多个 .spec 文件，简化了打包流程，并确保最终发布版本和开发版本的配置一致性。