`Enter` and `Leave` can reach a parent in either order when the mouse moves between its children

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
cli

Research direction

Start with App._set_mouse_over to see where the Leave and Enter events are posted for the old and new widgets, then trace how each bubbles through message pumps to the shared parent. The repro script shows the ordering problem with a delayed on_leave; the calculator example is the case where it shows up in traces. Done means Leave reaches every shared ancestor before Enter, while event.stop() still works for ListItem.

Written by the indexing model from the issue text.

Description

Hi! When the mouse moves from one widget to a sibling, the parent sometimes gets the new widget's Enter before the old widget's Leave.

App._set_mouse_over posts Leave to the old widget and Enter to the new one at the same time. Both events bubble, and each climbs from its own widget's message pump, so which of the two reaches a shared ancestor first depends on which pump gets there first. If the old widget is still busy, for example because its own on_leave awaits something, the Enter wins.

import asyncio
import collections
import sys

import textual
from textual import events
from textual.app import App, ComposeResult
from textual.containers import Horizontal
from textual.widgets import Static

class Cell(Static):
    """A widget whose own Leave handler takes `delay` seconds (0: a plain handler)."""

    def __init__(self, label: str, delay: float) -> None:
        super().__init__(label, id=label)
        self.delay = delay

    async def on_leave(self, event: events.Leave) -> None:
        if self.delay:
            await asyncio.sleep(self.delay)

class Row(Horizontal):
    """Records the Enter and Leave events that bubble up to it, in the order it gets them."""

    seen: list[str] = []

    def on_enter(self, event: events.Enter) -> None:
        Row.seen.append(f"Enter({event.node.id})")

    def on_leave(self, event: events.Leave) -> None:
        Row.seen.append(f"Leave({event.node.id})")

class EnterLeaveApp(App):
    CSS = "Cell { width: 10; height: 3; }"

    def __init__(self, delay: float) -> None:
        super().__init__()
        self.delay = delay

    def compose(self) -> ComposeResult:
        with Row():
            yield Cell("a", self.delay)
            yield Cell("b", 0)

async def once(delay: float) -> str:
    app = EnterLeaveApp(delay)
    async with app.run_test() as pilot:
        await pilot.hover("#a")
        await pilot.pause(0.1)
        Row.seen = []
        await pilot.hover("#b")
        await pilot.pause(0.1)
        return " ".join(Row.seen)

async def main() -> None:
    runs = int(sys.argv[1]) if len(sys.argv) > 1 else 20
    print(f"Textual {textual.__version__}, {runs} runs each")
    for delay in (0, 0.01):
        tally = collections.Counter()
        for _ in range(runs):
            tally[await once(delay)] += 1
        print(f"a's on_leave takes {delay} s; what Row gets moving from a to b -> runs: {dict(tally)}")

asyncio.run(main())

Output on main (5e5b7ef), Python 3.13, macOS (8.2.7 is the same):

Textual 8.2.8, 30 runs each
a's on_leave takes 0 s; what Row gets moving from a to b -> runs: {'Leave(a) Enter(b)': 30}
a's on_leave takes 0.01 s; what Row gets moving from a to b -> runs: {'Enter(b) Leave(a)': 30}

With plain handlers the order is usually right, but it still depends on scheduling: in a test harness that compares message traces run against run, the calculator example's clicks from one button to the next got the screen's Enter and Leave in the other order about one run in ten, and scrolling content under a still pointer does the same. I expected Leave(a) before Enter(b) at every shared ancestor, every time. I have a fix that keeps both events bubbling (so event.stop() still works, which ListItem relies on) and posts the Enter once the Leave has bubbled as far as it goes. I'm happy to open a PR if that approach sounds right.

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.