GH-99749: Add optional feature to suggest correct names (ArgumentParser) #124456
Conversation
This file contains 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
savannahostrowski
added
stdlib
serhiy-storchaka
approved these changes
Sep 26, 2024
There was a problem hiding this comment.
LGTM.
This PR slightly conflicts with #117766. After merging one of them, the other one should be updated. I am not sure what of them should be merged first.
A fix should definitely precede a new feature. |
Misc/NEWS.d/next/Library/2024-09-24-18-49-16.gh-issue-99749.gBDJX7.rst
Outdated
Show resolved
Hide resolved
…DJX7.rst Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR carries #99773 forward with the original author's go-ahead (thanks @abdulrafey38!). This adds the ability for
ArgumentParserto offer suggestions for mistyped argument choices or subparser names. This PR adds this as an optional feature via thesuggest_on_errorparam (default:False).I have opted to not make this configurable at the subparser or argument level and instead at the parser level to keep this simple. We could consider additional granularity but I'm not convinced that this is required at this time.
choicesargument #99749📚 Documentation preview 📚: https://cpython-previews--124456.org.readthedocs.build/