如何让pyproject GUI脚本向控制台输出帮助信息？

我有一个基于wxPython的Python GUI项目，通过pyproject.toml的[project.gui-scripts]定义启动脚本：

[project.gui-scripts]
my-script = "my_project.cli:cli_run"

脚本中设置了--help选项，但由于GUI脚本会以独立进程启动，无法将帮助信息输出到调用它的控制台。如果改用[project.scripts]，脚本会绑定到调用它的控制台，关闭控制台时GUI也会随之关闭，不符合需求。

需求是：当指定--help时，向控制台输出帮助信息；其他情况则脱离控制台独立运行GUI。

已尝试以下方法但未解决问题：

• 使用[project.scripts]结合multiprocessing：即使不调用join()，控制台仍会被阻塞至GUI关闭。
• 使用os.fork()：在Windows系统无法生效。
• 同时配置[project.scripts]和[project.gui-scripts]：无论顺序如何，效果与仅使用[project.gui-scripts]一致。

最小示例 #

项目结构：

my-project
├── pyproject.toml
└── src
    └── my_project
        └── cli.py

pyproject.toml内容：

[build-system]
requires = ["setuptools >= 64"]
build-backend = "setuptools.build_meta"

[project]
name = "my-project"
version = "0.1.0"

dependencies = [
    "wxPython~=4.2.2",
]

[project.gui-scripts]
my-project = "my_project.cli:cli_run"

cli.py内容：

import sys
import wx

def cli_run() -> None:
    if "--help" in sys.argv:
        print("Help message")
        return
    
    app = wx.App()
    frame = wx.Frame(None, title="Hello, World!")
    frame.Show()
    app.MainLoop()

执行pip install .安装后，运行my-project即可启动应用。

核心思路是使用[project.scripts]作为统一入口，在脚本中判断参数：如果是--help则直接输出帮助并退出；否则启动一个独立的GUI进程，主进程立即退出以释放控制台，同时保证GUI进程能独立运行。

步骤1：修改pyproject.toml #

将[project.gui-scripts]替换为[project.scripts]：

[build-system]
requires = ["setuptools >= 64"]
build-backend = "setuptools.build_meta"

[project]
name = "my-project"
version = "0.1.0"

dependencies = [
    "wxPython~=4.2.2",
]

[project.scripts]
my-project = "my_project.cli:cli_run"

步骤2：修改cli.py #

添加进程启动逻辑，实现跨平台的GUI独立运行：

import sys
import subprocess
import wx

def run_gui():
    """独立的GUI启动函数"""
    app = wx.App()
    frame = wx.Frame(None, title="Hello, World!")
    frame.Show()
    app.MainLoop()

def cli_run() -> None:
    # 检查是否为内部GUI启动模式
    if len(sys.argv) > 1 and sys.argv[1] == "--gui-internal":
        run_gui()
        return
    
    # 处理--help参数
    if "--help" in sys.argv:
        print("Help message")
        print("Usage: my-project [--help]")
        return
    
    # 构造启动GUI进程的命令
    gui_args = [sys.executable, "-m", "my_project.cli", "--gui-internal"]
    
    # 跨平台启动独立GUI进程
    if sys.platform == "win32":
        # Windows下隐藏控制台窗口
        startup_info = subprocess.STARTUPINFO()
        startup_info.dwFlags |= subprocess.STARTF_USESHOWWINDOW
        subprocess.Popen(gui_args, startupinfo=startup_info)
    else:
        # Linux/macOS下后台运行，重定向标准输入输出避免阻塞
        subprocess.Popen(
            gui_args,
            stdout=subprocess.DEVNULL,
            stderr=subprocess.DEVNULL,
            stdin=subprocess.DEVNULL,
            start_new_session=True
        )
    
    # 主进程立即退出，释放控制台
    sys.exit(0)

效果验证 #

• 运行my-project --help：控制台直接输出帮助信息，随后退出，不启动GUI。
• 运行my-project：主进程启动GUI进程后立即退出，控制台可正常关闭，GUI保持独立运行。

方案说明 #

• 避免了multiprocessing的父子进程绑定问题：通过subprocess.Popen启动独立进程，主进程退出后不影响GUI进程。
• 跨平台兼容：针对Windows设置STARTF_USESHOWWINDOW隐藏控制台，Linux/macOS通过start_new_session和重定向IO实现后台运行。
• 内部参数--gui-internal用于区分是主进程调用还是GUI进程启动，避免循环调用。

内容的提问来源于stack exchange，提问作者Pasu4