FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Update argparse `suggest_on_error` code snippet in docs by savannahostrowski · Pull Request #144985 · python/cpython · GitHub

/ cpython Public

Update argparse suggest_on_error code snippet in docs #144985

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

Merged
savannahostrowski merged 3 commits into from
Feb 23, 2026
Conversation 4 Commits 3 Checks 29 Files changed
Merged

Update argparse suggest_on_error code snippet in docs #144985

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb42ddb
Update example to be clear, valid code.
savannahostrowski Feb 19, 2026
71b9a1e
Update return
savannahostrowski Feb 19, 2026
9b691e3
Merge branch 'main' into update-example
savannahostrowski Feb 23, 2026
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
17 changes: 6 additions & 11 deletions Doc/library/argparse.rst
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -602,18 +602,13 @@ choices (if specified) or subparser names, along with a "maybe you meant"
suggestion if a close match is found. Note that this only applies for arguments
when the choices specified are strings::

>>> parser = argparse.ArgumentParser(description='Process some integers.',
suggest_on_error=True)
>>> parser.add_argument('--action', choices=['sum', 'max'])
>>> parser.add_argument('integers', metavar='N', type=int, nargs='+',
... help='an integer for the accumulator')
>>> parser.parse_args(['--action', 'sumn', 1, 2, 3])
tester.py: error: argument --action: invalid choice: 'sumn', maybe you meant 'sum'? (choose from 'sum', 'max')

You can disable suggestions by setting ``suggest_on_error`` to ``False``::
>>> parser = argparse.ArgumentParser(suggest_on_error=True)
>>> parser.add_argument('--action', choices=['debug', 'dryrun'])
>>> parser.parse_args(['--action', 'debugg'])
usage: tester.py [-h] [--action {debug,dryrun}]
tester.py: error: argument --action: invalid choice: 'debugg', maybe you meant 'debug'? (choose from debug, dryrun)

>>> parser = argparse.ArgumentParser(description='Process some integers.',
suggest_on_error=False)
You can disable suggestions by setting ``suggest_on_error`` to ``False``.

.. versionadded:: 3.14
.. versionchanged:: 3.15
Expand Down
Loading
Back | FazBrowse Home | New Git URL