fix: update return types of dialog shortcuts to include None when cancelled#2078
Open
motty-mio2 wants to merge 1 commit into
Open
fix: update return types of dialog shortcuts to include None when cancelled#2078motty-mio2 wants to merge 1 commit into
motty-mio2 wants to merge 1 commit into
Conversation
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.
Summary
The return types of
input_dialog,radiolist_dialog, andcheckboxlist_dialogshortcuts did not account for the case where the user cancels the dialog.When cancelled, these dialogs return
None, but their return types were typed asApplication[str],Application[_T], andApplication[list[_T]]respectively.This PR updates their return types to:
input_dialog:Application[str | None]radiolist_dialog:Application[_T | None]checkboxlist_dialog:Application[list[_T] | None]This allows type checkers like mypy/pyright to correctly type-check code that handles dialog cancellation.
How to Test / Reproduction
Run your type checker (e.g.,
mypy) against the attached reproduction scriptdialog_tester.py. It should type-check successfully without errors.dialog_tester.py