prompt-toolkit全屏应用无用户输入自动刷新实现方法问询

问题描述 #

我正在尝试用prompt-toolkit构建一款全屏CLI应用，用于周期性展示动态更新的信息（示例需求是每秒显示当前时间），但一开始找不到无需用户输入就能让应用自动刷新UI的方法，查文档和相关帖子也没找到合适方案。

解决方案探索 #

方法1：协程+后台任务实现自动刷新 #

经过多次尝试，我找到了可行的实现方式：通过app.create_background_task()向事件循环添加协程来更新UI内容，同时需要设置Application的refresh_interval参数（或手动调用app.invalidate()）触发界面刷新。在没有大量其他任务占用事件循环的情况下，这个方案表现稳定。

示例代码：

import datetime
import asyncio

from prompt_toolkit import Application
from prompt_toolkit.key_binding import KeyBindings
from prompt_toolkit.layout.containers import Window, HSplit
from prompt_toolkit.layout.controls import FormattedTextControl
from prompt_toolkit.layout.layout import Layout
from prompt_toolkit import widgets


static_text = FormattedTextControl(text=f"Time: {datetime.datetime.now().strftime('%H:%M:%S')}")
static_window = Window(content=static_text, height=2)

telemetry_window = Window(content=FormattedTextControl(text="Some fixed text"))

root_container = HSplit([
    widgets.Frame(body=static_window),
    widgets.Frame(body=telemetry_window)
])

layout = Layout(root_container)

kb = KeyBindings()


@kb.add('c-q')
@kb.add('c-c')
def exit_(event):
    event.app.exit()


app = Application(layout=layout, full_screen=True, key_bindings=kb, refresh_interval=0.5)


async def refresh():
    while True:
        static_text.text = f"Time: {datetime.datetime.now().strftime('%H:%M:%S')}"
        await asyncio.sleep(0.1)


app.create_background_task(refresh())
app.run()

方法2：线程更新控件实现自动刷新 #

除了协程方案，也可以通过线程来更新文本控件的内容。只要控件的文本值被更新，当UI失效时就会自动使用新值重新渲染界面，不需要依赖协程。

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