gh-103878: Document that the cancelled file dialog value is only falsy#152429
Open
serhiy-storchaka wants to merge 4 commits into
Open
gh-103878: Document that the cancelled file dialog value is only falsy#152429serhiy-storchaka wants to merge 4 commits into
serhiy-storchaka wants to merge 4 commits into
Conversation
…y falsy Its exact type (empty string, tuple, list or None) varies between platforms and Tk versions, so advise testing the result for truth. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
serhiy-storchaka
added
needs backport to 3.13
Documentation build overview
|
askopenfiles() returns an empty tuple, not an empty list, when cancelled. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
No file dialog function returns an empty list on cancellation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
The static file dialog functions return a false value when the dialog is cancelled, but its exact type is not stable:
askdirectory(), for example, yields()on some platforms and""on others (see the issue). Code that compares the result against a specific empty value is therefore fragile.The blanket "or
None" wording the issue reported was already corrected by the gh-86726 documentation overhaul. This adds a short note to the shared description advising callers to test the result for truth rather than comparing it with a specific value.This is the documentation half of the issue; normalizing the return type itself is a separate, future-release change.