Skip to content

gh-69134: Harden tkinter GUI tests that depend on a mapped widget#152499

Merged
serhiy-storchaka merged 1 commit into
python:mainfrom
serhiy-storchaka:gh-69134-wait-until-mapped
Jun 28, 2026
Merged

gh-69134: Harden tkinter GUI tests that depend on a mapped widget#152499
serhiy-storchaka merged 1 commit into
python:mainfrom
serhiy-storchaka:gh-69134-wait-until-mapped

Conversation

@serhiy-storchaka

Copy link
Copy Markdown
Member

Several ttk and tkinter tests query realized geometry (winfo_width(), identify(), coords(), place_info(), ...) right after a bare update(), which does not guarantee that the window manager has mapped and sized the widget. Under a tiling window manager or a headless/contended display the widget can still have a 1x1 size, so identify() returns the empty string and coordinate-based assertions fail intermittently.

This adds a wait_until_mapped() helper (and an AbstractTkTest.require_mapped() wrapper) to test_tkinter.support that waits, with a bounded timeout, for the widget to be mapped with a non-trivial size. Unlike Misc.wait_visibility() it never blocks indefinitely (see bpo-40722).

It is used to guard only the assertions that need a mapped widget, so the remaining checks still run, and the empty string that several identify() tests accepted solely to tolerate an unmapped widget is dropped.

Add wait_until_mapped() and AbstractTkTest.require_mapped() to
test_tkinter.support and use them to guard the assertions that need a
widget to be actually mapped (winfo_width(), identify(), coords(), ...).
This avoids intermittent failures under window managers that do not map
the widget promptly, without skipping the unrelated checks.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@serhiy-storchaka serhiy-storchaka added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip news labels Jun 28, 2026
@serhiy-storchaka serhiy-storchaka merged commit 0fff6bd into python:main Jun 28, 2026
57 of 58 checks passed
@miss-islington-app

Copy link
Copy Markdown

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

@bedevere-app

bedevere-app Bot commented Jun 28, 2026

Copy link
Copy Markdown

GH-152516 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Jun 28, 2026
@miss-islington-app

Copy link
Copy Markdown

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 0fff6bd86cf0224152c509e295d3cbbd209098f3 3.13

@bedevere-app

bedevere-app Bot commented Jun 28, 2026

Copy link
Copy Markdown

GH-152517 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jun 28, 2026
@bedevere-app

bedevere-app Bot commented Jun 28, 2026

Copy link
Copy Markdown

GH-152518 is a backport of this pull request to the 3.23 branch.

@bedevere-app

bedevere-app Bot commented Jun 28, 2026

Copy link
Copy Markdown

GH-152518 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Jun 28, 2026
serhiy-storchaka added a commit that referenced this pull request Jun 28, 2026
…get (GH-152499) (GH-152517)

Add wait_until_mapped() and AbstractTkTest.require_mapped() to
test_tkinter.support and use them to guard the assertions that need a
widget to be actually mapped (winfo_width(), identify(), coords(), ...).
This avoids intermittent failures under window managers that do not map
the widget promptly, without skipping the unrelated checks.
(cherry picked from commit 0fff6bd)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
serhiy-storchaka added a commit that referenced this pull request Jun 28, 2026
…get (GH-152499) (GH-152518)

Add wait_until_mapped() and AbstractTkTest.require_mapped() to
test_tkinter.support and use them to guard the assertions that need a
widget to be actually mapped (winfo_width(), identify(), coords(), ...).
This avoids intermittent failures under window managers that do not map
the widget promptly, without skipping the unrelated checks.


(cherry picked from commit 0fff6bd)

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
@serhiy-storchaka serhiy-storchaka deleted the gh-69134-wait-until-mapped branch June 29, 2026 14:01
serhiy-storchaka added a commit that referenced this pull request Jun 29, 2026
…get (GH-152499) (GH-152516)

Add wait_until_mapped() and AbstractTkTest.require_mapped() to
test_tkinter.support and use them to guard the assertions that need a
widget to be actually mapped (winfo_width(), identify(), coords(), ...).
This avoids intermittent failures under window managers that do not map
the widget promptly, without skipping the unrelated checks.
(cherry picked from commit 0fff6bd)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant