如何在Jupyter Notebook循环中实现非阻塞式按键输入？

由于Jupyter内核会拦截Python层的键盘输入，直接用keyboard等模块无法生效，推荐从前端监听+Python异步循环或者ipywidgets异步事件两个方向解决，以下是具体实现：

方案一：前端JavaScript监听键盘事件（最可靠） #

利用浏览器的JavaScript直接监听键盘输入，通过内核通信触发Python的终止标志，完全绕开Python层的输入拦截问题。

步骤1：设置终止标志并注册前端监听 #

# 全局终止标志
stop_flag = False

运行下方的JavaScript代码，注册页面级的键盘监听（按下Q/q时设置Python的终止标志）：

%%javascript
document.addEventListener('keydown', function(e) {
    // 仅当焦点不在输入框时触发（避免干扰代码编辑）
    if ((e.key === 'q' || e.key === 'Q') && !['INPUT', 'TEXTAREA'].includes(document.activeElement.tagName)) {
        IPython.notebook.kernel.execute("stop_flag = True");
    }
});

步骤2：编写非阻塞异步循环 #

用asyncio实现循环，每次循环让出事件循环，确保前端的消息能被Python内核处理：

import asyncio

async def run_task_loop():
    global stop_flag
    stop_flag = False
    print("循环启动，按下Q/q终止")
    while not stop_flag:
        # 替换为你的业务逻辑
        print("循环运行中...", end='\r')
        # 让出事件循环，给前端消息留处理时间
        await asyncio.sleep(0.1)
    print("\n循环已终止")

# 启动异步循环
await run_task_loop()

方案二：ipywidgets异步事件结合按钮/按键 #

如果需要同时支持按钮点击和键盘终止，可以结合ipywidgets按钮事件和上述前端监听，核心是确保循环不会阻塞事件循环：

import ipywidgets as widgets
import asyncio

stop_flag = False

# 创建终止按钮
stop_button = widgets.Button(description='点击终止循环', button_style='danger')
def on_button_click(_):
    global stop_flag
    stop_flag = True
stop_button.on_click(on_button_click)
display(stop_button)

%%javascript
document.addEventListener('keydown', function(e) {
    if ((e.key === 'q' || e.key === 'Q') && !['INPUT', 'TEXTAREA'].includes(document.activeElement.tagName)) {
        IPython.notebook.kernel.execute("stop_flag = True");
    }
});

async def run_loop():
    global stop_flag
    stop_flag = False
    print("循环启动，点击按钮或按下Q/q终止")
    while not stop_flag:
        print("循环运行中...", end='\r')
        await asyncio.sleep(0.1)
    print("\n循环已终止")

await run_loop()

关键注意事项 #

• 必须用异步循环+await sleep：同步的while循环会阻塞Jupyter的事件循环，导致UI事件（按钮点击）或前端消息无法被处理，这是你之前用ipywidgets无效的核心原因。
• 前端监听的焦点判断：加入document.activeElement判断，避免在编辑代码时误触终止。

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