Fix long option completion with equals#3486
Closed
sjh9714 wants to merge 1 commit into
Closed
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
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.
Shell completion currently strips the long option assignment prefix when completing values typed as
--option=value. That makes bash return no replacement for partial values and makes zsh replace the whole option with the bare completion value.This keeps the parsed value incomplete for matching, but remembers the
--option=prefix and applies it back to plain completion values. File and directory completion markers are left unchanged so shell-native path completion still receives the raw path fragment. Space-separated option values and short options keep their existing bare value completions.fixes #2847
Tests
uv run pytest tests/test_shell_completion.py -k "long_option_equals" -qfailed before the implementation with bareauto/alwayscompletions instead of--color=auto/--color=always.uv run pytest tests/test_shell_completion.py -k "long_option_equals" -quv run pytest tests/test_shell_completion.py -quv run pytest tests -quv run ruff check src/click/shell_completion.py tests/test_shell_completion.pygit diff --checkNote: I used Codex to help inspect the shell completion path and draft the regression tests, but I reviewed the final diff and ran the listed verification commands locally.