Automatically suggest CLI arguments #798
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds automatic CLI argument suggestion on error using argparse's suggest_on_error parameter, which helps users by suggesting correct argument names when they make typos. The change also updates the copyright year in one file.
- Adds
suggest_on_error=Trueto ArgumentParser instances in CLI modules - Updates copyright year from 2024 to 2025 in init.py
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| precli/cli/main.py | Adds suggest_on_error=True parameter to the main CLI ArgumentParser |
| precli/cli/init.py | Adds suggest_on_error=True parameter to the init CLI ArgumentParser and updates copyright year to 2025 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ericwb
force-pushed
the
suggest_on_error
branch
from
0da9fb0 to
f2359da
Compare
The suggest_on_error, introduced in Python 3.14 enables argparse to automatically suggest argument names when a user types one in error. Note, this is only available in Python 3.14 https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser Signed-off-by: Eric Brown <eric.brown@securesauce.dev>
ericwb
force-pushed
the
suggest_on_error
branch
from
f2359da to
f7c7108
Compare
qheck
reviewed
Dec 21, 2025
| formatter_class=argparse.RawDescriptionHelpFormatter, | ||
| ) | ||
| if sys.version_info >= (3, 14): | ||
| parser.suggest_on_error = True |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 suggest_on_error, introduced in Python 3.14 enables argparse to automatically suggest argument names when a user types one in error.
Note, this is only available in Python 3.14
https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser