gh-40440: Add a timeout parameter to tkinter wait_variable() - #152619
Open
serhiy-storchaka wants to merge 1 commit into
Open
gh-40440: Add a timeout parameter to tkinter wait_variable()#152619serhiy-storchaka wants to merge 1 commit into
serhiy-storchaka wants to merge 1 commit into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Without a timeout wait_variable() blocks forever if the variable is never set, for example because the window that would set it was destroyed. The new keyword-only timeout parameter bounds the wait and returns whether the variable was modified. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copy link
Copy Markdown
Documentation build overview3 files changed ± library/tkinter.html ± whatsnew/3.16.html ± whatsnew/changelog.html |
Sorry, something went wrong.
20 tasks
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
Reviewers
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_variable() wraps the Tcl tkwait variable command, which blocks until the variable is written — with no escape if that never happens (e.g. the application is torn down before the setter runs), so the call can hang forever.
Add an optional keyword-only timeout argument (in seconds).
With a timeout the wait is reimplemented in Python on top of tkapp.dooneevent() and a variable trace: it returns True if the variable was modified, or False if the timeout elapsed first (or the application was destroyed while waiting).
Without a timeout the behaviour is unchanged (the native tkwait call, always returns True).