gh-86657: Add a timeout parameter to tkinter wait_visibility()#152621
Open
serhiy-storchaka wants to merge 1 commit into
Open
gh-86657: Add a timeout parameter to tkinter wait_visibility()#152621serhiy-storchaka wants to merge 1 commit into
serhiy-storchaka wants to merge 1 commit into
Conversation
Without a timeout wait_visibility() blocks until the visibility of the widget changes, which can hang indefinitely (for example if the widget is never mapped). The new keyword-only timeout parameter bounds the wait and returns whether the widget became viewable. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Documentation build overview
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Misc.wait_visibility()wraps the Tcltkwait visibilitycommand, which blocks until the window's visibility changes.It can hang indefinitely — for example when called from a worker thread (gh-86657).
Add an optional keyword-only timeout argument (in seconds).
With a timeout the wait is reimplemented in Python on top of
tkapp.dooneevent(), pollingwinfo_viewable(): it returnsTrueonce the window is viewable, orFalseif the timeout elapsed first (or the window was destroyed).Without a timeout the behaviour is unchanged (the native
tkwaitcall, always returnsTrue).Note: with a timeout the call waits until viewable (returning immediately if the window is already shown), which differs from the native "wait for a change" semantics — the poll behaviour is the useful one here.