如何在prompt会话外使用prompt-toolkit输入处理与按键绑定

可以实现，不需要启动完整的prompt_toolkit Application实例，直接复用其底层输入、按键绑定模块即可，全程内存和性能开销极低，完全支持在prompt会话间隔、命令运行阶段捕获CTRL-Z按键，匹配自定义挂起逻辑。

核心原理 #

prompt_toolkit的按键绑定能力本身不依赖上层的prompt会话或完整Application生命周期：

• 底层Input模块会根据运行系统自动选择适配的异步输入实现（PosixAsyncInput/Win32AsyncInput），持续监听标准输入流事件
• KeyBindings实例可独立初始化，和输入流绑定后，只要标准输入出现匹配的按键序列就会触发注册的回调，和当前是否处于prompt输入阶段无关

具体实现 #

• 全局初始化复用实例，避免每次调用prompt时重复生成输入、按键绑定对象导致的监听冲突

  import asyncio
  from prompt_toolkit import prompt_async
  from prompt_toolkit.input import create_input
  from prompt_toolkit.key_binding import KeyBindings
  
  # 以下实例全局只初始化一次
  kb = KeyBindings()
  input_obj = create_input()
  ctrl_z_event = asyncio.Event()
  background_tasks = [] # 可选，用于管理挂起到后台的任务
  

• 注册CTRL-Z按键回调，触发时标记事件

  @kb.add('c-z')
  def handle_ctrlz(event):
      ctrl_z_event.set()
      # 可在此处插入挂起操作的前置逻辑
  

• 启动常驻后台的轻量按键监听协程，不需要依赖完整Application生命周期

  async def global_key_listener():
      with input_obj.raw_mode():
          with input_obj.attach(kb):
              # 保活协程，按键事件由input模块自动异步分发，无额外性能开销
              while True:
                  await asyncio.sleep(0.2)
  

• 改造主循环逻辑，让命令执行阶段和按键监听并行，实现任意阶段响应CTRL-Z

  async def run_your_command(line):
      # 替换为你自己的命令解析、执行逻辑
      await asyncio.sleep(10) # 模拟长耗时命令
      return f"命令 {line} 执行完成"
  
  async def main():
      # 启动全局按键监听，全程后台运行
      asyncio.create_task(global_key_listener())
      while True:
          ctrl_z_event.clear()
          # 传入全局复用的输入、按键绑定实例，和后台监听逻辑打通
          line = await prompt_async(">", key_bindings=kb, input=input_obj)
          
          # 创建命令执行任务
          cmd_task = asyncio.create_task(run_your_command(line))
          # 并行等待：要么命令执行完，要么按下CTRL-Z
          done, _ = await asyncio.wait(
              [cmd_task, asyncio.create_task(ctrl_z_event.wait())],
              return_when=asyncio.FIRST_COMPLETED
          )
  
          if ctrl_z_event.is_set():
              # 检测到CTRL-Z，将任务加入后台列表，不等待执行完成直接回到prompt
              background_tasks.append(cmd_task)
              print(f"\n已将当前任务挂起到后台，后台任务总数：{len(background_tasks)}")
              continue
          # 命令正常执行完成，获取结果处理即可
          result = cmd_task.result()
          print(result)
  
  if __name__ == "__main__":
      asyncio.run(main())
  

注意事项 #

• 调用prompt_async时必须传入全局初始化的key_bindings和input参数，否则会使用默认生成的独立实例，导致多套输入监听抢占标准输入、间隔期无法捕获按键的问题
• 全局按键监听协程不要加入阻塞逻辑，仅做事件标记即可，实际挂起、后台任务管理逻辑放到主循环处理，整体开销远低于启动完整prompt_toolkit Application
• Windows平台建议使用Windows Terminal、PowerShell 7+运行，老旧cmd终端对raw模式支持不完善，可能出现按键捕获延迟

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