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

Open
#6,772 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
58/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
frontend

Research direction

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.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Python
Stars
37.7k
Forks
1.5k
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Textualize/textual

All issues in Textualize/textual

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.