Repository navigation
fix: graceful handling of shell completion KeyError crash - #27
Merged
Merged
Conversation
added 2 commits
April 17, 2026 22:05
Click's shell completion raises KeyError when COMP_WORDS/COMP_LINE env vars are missing in non-standard terminal environments. Added a _safe_call() wrapper that catches these specific KeyErrors and displays a helpful message instead of crashing with a traceback. - Updated console script entry point to use _safe_call - Updated __main__ block to use _safe_call - Added tests for the wrapper (happy path, completion error, unrelated error) Closes #26
The previous fix printed an error message to stdout, which zsh completion captured and tried to execute as a command, causing '(eval):1: command not found: Error:'. Exit silently instead. Closes #26
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.
📝 Description
Fix a crash where pressing Tab in some terminal environments causes a
KeyError: 'COMP_WORDS'traceback instead of failing gracefully.Root cause: Click's shell completion logic accesses
os.environ["COMP_WORDS"]directly when it detects completion mode. In non-standard terminal environments (e.g., IDE terminals, terminal wrappers), completion may be triggered without the expected environment variables being set.Fix: Added a
_safe_call()wrapper function that catches these specific KeyErrors and displays a helpful message:pyproject.toml) to use_safe_call__main__block to use_safe_call🔗 Related Issue
Fixes #26
🧪 Testing
_safe_call✅ Checklist