Conversation
Command.main runs shell completion before its ClickException handler. A custom Group.get_command that calls ctx.fail() therefore printed a full traceback instead of the usage error. Catch ClickException in _main_shell_completion and show it the same way as a normal invocation. Fixes pallets#2853 Signed-off-by: elix3r <157088510+22elix3r@users.noreply.github.com>
Member
davidism
added
the
rejected AI
davidism
changed the title
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
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.
Summary
Command.mainhandles shell completion before it enters theClickExceptionhandler. A customGroup.get_commandthat callsctx.fail()(the documented alias/prefix pattern) therefore prints a traceback during tab completion instead of the usage error.Normal invocation of the same prefix already shows
Error: Too many matches: ...and exits 2. Completion should do the same.Related Issue
Fixes #2853
Changes Made
ClickExceptioninCommand._main_shell_completion, callshow(), and exit with the exception's exit code.Testing
pytest tests/test_shell_completion.py tests/test_commands.py tests/test_basic.py(265 passed)pytest(1993 passed, 24 skipped, 1 xfailed)ruff check/ruff formaton the touched filesTests use the documented ambiguous-prefix
get_commandpattern: completion ofcli ino longer traceback, and a normalcli iinvoke still reports the usage error.Notes
Completion still uses
resilient_parsingfor missing commands and invalid values. This only covers exceptions thatget_command(or similar) raises on purpose viactx.fail().