HelpPanel shows the wrong widget's help if focus moved while the app was blurred or a modal was open

オープン
#6,772 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
58/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
frontend

調査の方向性

Start with HelpPanel.update_help, which returns early while the app is blurred or its screen is inactive, and see how Screen.bindings_updated_signal is published from App._on_app_focus, App._on_app_blur and _watch_stack_updates. Run the issue's two reproduction scripts, blur_case and modal_case. Done when the panel shows the help of the widget focused after AppFocus or after a modal is popped, and the existing help panel tests still pass.

索引モデルが issue の本文から書いたものです。

説明

Hi! I hit this while writing generated tests against Textual's widgets.

HelpPanel.update_help returns early while the app doesn't have focus, or while its screen isn't the active one. That makes sense, but nothing runs it again when the app gets focus back or the screen is resumed. So if focus moves in the meantime, the panel keeps the help of the widget that was focused before.

Two ways to see it:

  1. The terminal loses focus (AppBlur), the app moves focus (a timer, a worker, a message), then the terminal gets focus back (AppFocus).
  2. Focus moves on a screen while a modal covers it, then the modal is popped.
import asyncio

import textual
from textual import events
from textual.app import App, ComposeResult
from textual.screen import ModalScreen
from textual.widgets import Button, HelpPanel, Input, Markdown

class First(Input):
    HELP = "Help for the **first** input."

class Second(Input):
    HELP = "Help for the **second** input."

class Modal(ModalScreen):
    def compose(self) -> ComposeResult:
        yield Button("OK")

class HelpApp(App):
    def compose(self) -> ComposeResult:
        yield First(id="first")
        yield Second(id="second")

    def on_mount(self) -> None:
        self.action_show_help_panel()

def shown_help(app: App) -> str:
    return app.screen.query_one(HelpPanel).query_one(Markdown).source

async def blur_case() -> None:
    app = HelpApp()
    async with app.run_test() as pilot:
        await pilot.pause()
        app.query_one("#first").focus()
        await pilot.pause()
        print("focused first:  ", repr(shown_help(app)))
        # The terminal loses focus, the app moves focus, the terminal gets focus back.
        app.post_message(events.AppBlur())
        await pilot.pause()
        app.query_one("#second").focus()
        await pilot.pause()
        app.post_message(events.AppFocus())
        await pilot.pause()
        print("after refocus:  ", app.focused.id, repr(shown_help(app)))

async def modal_case() -> None:
    app = HelpApp()
    async with app.run_test() as pilot:
        await pilot.pause()
        app.query_one("#first").focus()
        await pilot.pause()
        base = app.screen
        app.push_screen(Modal())
        await pilot.pause()
        # Focus moves on the base screen while the modal covers it.
        base.set_focus(base.query_one("#second"))
        await pilot.pause()
        app.pop_screen()
        await pilot.pause()
        print("after pop:      ", app.focused.id, repr(shown_help(app)))

print("Textual", textual.__version__)
asyncio.run(blur_case())
asyncio.run(modal_case())

Output on Textual 8.2.7 (main at 5e5b7ef is the same):

Textual 8.2.7
focused first:   'Help for the **first** input.'
after refocus:   second 'Help for the **first** input.'
after pop:       second 'Help for the **first** input.'

Expected: once the app has focus again, or the screen is resumed, the panel shows the help for the widget that is focused then (Help for the **second** input.).

KeyPanel and Footer don't have this problem, because they update from Screen.bindings_updated_signal. That signal is published on AppFocus and AppBlur (App._on_app_focus / _on_app_blur call refresh_bindings) and when a screen is resumed (_watch_stack_updates). I think HelpPanel could listen to it too, and catch up there. I'm happy to send a PR.

主要言語
Python
スター
37.7k
フォーク
1.5k
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Textualize/textual のほかの issue

Textualize/textual の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。