8000 Add “maybe you meant” in argparse `choices` argument · Issue #99749 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Add “maybe you meant” in argparse choices argument #99749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
NIKDISSV-Forever opened this issue Nov 24, 2022 · 3 comments
Closed

Add “maybe you meant” in argparse choices argument #99749

NIKDISSV-Forever opened this issue Nov 24, 2022 · 3 comments
Assignees
@savannahostrowski
Labels
stdlib Python modules in the Lib dir type-feature A feature request or enhancement

Comments

@NIKDISSV-Forever
Copy link
NIKDISSV-Forever commented Nov 24, 2022 •
edited by bedevere-app bot
Loading

argparse guesses

Print the possible (nearest) value of the argument. If options are specified with the choices argument.

Pitch

argparse are end user oriented.
Such a message will make the program interface more user-friendly.

def main():
    arg_parser = argparse.ArgumentParser()
    arg_parser.add_argument('family', type=str.casefold, help='Font family', choices=get_all_family_names(FAMILY_FILES))
    args = arg_parser.parse_args(['S200Flora'])

Now outputs this:

error: argument family: invalid choice: 's200flora' (choose from 'a431', ..., 's200flor', ... 'wingdings 3')

I suggest making the output look like this:

error: argument family: invalid choice: 's200flora', maybe you meant 's200flor'? (choose from 'a431', ..., 's200flor', ... 'wingdings 3')

It doesn't have to look exactly like this. I'm not talking about the implementation, perhaps the assumptions should always be (if there are matches) in the presence of the choices argument, perhaps only in some certain conditions.
These questions are decided by those who will implement it, as they see fit.

Previous discussion

Add “maybe you meant” in argparse choices argument on discuss.python.org

Linked PRs
@NIKDISSV-Forever NIKDISSV-Forever added the type-feature A feature request or enhancement label Nov 24, 2022
@sobolevn sobolevn added the stdlib Python modules in the Lib dir label Nov 24, 2022
@sobolevn
Copy link
Member

Do you want to work on this? :)

@NIKDISSV-Forever
Copy link
Author
NIKDISSV-Forever commented Nov 25, 2022 •
edited
Loading

I don't mind working on it, I have an idea of ​​how argparse works, it's just that I'm not a professional in git and have never done pull requests.

While this is a really good idea, I'll start working on it today.

@abdulrafey38 abdulrafey38 mentioned this issue Nov 25, 2022
Closed
@bedevere-bot bedevere-bot mentioned this issue Nov 28, 2022
Closed
@erlend-aasland erlend-aasland moved this to Features in Argparse issues Feb 21, 2023
@bedevere-app bedevere-app bot mentioned this issue Sep 24, 2024
Merged
@savannahostrowski savannahostrowski self-assigned this Sep 24, 2024
serhiy-storchaka pushed a commit that referenced this issue Oct 17, 2024
@savannahostrowski
GH-99749: Add optional feature to suggest correct names (ArgumentPars…
624be86 
…er) (GH-124456)
@savannahostrowski
Copy link
Member

Now completed with #124456

@github-project-automation github-project-automation bot moved this from Features to Doc issues in Argparse issues Oct 17, 2024
@bedevere-app bedevere-app bot mentioned this issue Oct 18, 2024
Merged
serhiy-storchaka pushed a commit that referenced this issue Oct 19, 2024
@savannahostrowski
GH-99749: Add What's New entry for GH-124456 (GH-125671)
84074a4
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@savannahostrowski @ebonnal
pythonGH-99749: Add optional feature to suggest correct names (Argume…
925417c 
…ntParser) (pythonGH-124456)
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@savannahostrowski @ebonnal
pythonGH-99749: Add What's New entry for pythonGH-124456 (pythonGH-12…
7fb9a90 
…5671)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@savannahostrowski savannahostrowski

Labels
stdlib Python modules in the Lib dir type-feature A feature request or enhancement
Projects
Argparse issues
Status: Doc issues
Milestone
No milestone
Development

No branches or pull requests
3 participants
@sobolevn @savannahostrowski @NIKDISSV-Forever
0