🐛 Fix arg parameter of autocompletion
#1134
Open
Conversation
This file contains 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
svlandeg
changed the title
svlandeg
changed the title
arg parameter of autocompletion
|
Related comment with links to the relevant code places: #1006 (comment) |
svlandeg
approved these changes
Feb 26, 2025
There was a problem hiding this comment.
Thanks again for the contribution @bckohan, and for your patience while we're moving these different PRs to the review process! 🙏
I agree that this behaviour is not what is expected/documented, and the change in unit tests reflects the correct behaviour.
While I'm approving this PR, I will request an additional review from Tiangolo to get his feedback on the change, as he might have more information on why this was implemented originally the way it was.
tests/test_tutorial/test_options_autocompletion/test_tutorial008.py
Outdated
Show resolved
Hide resolved
tests/test_tutorial/test_options_autocompletion/test_tutorial008_an.py
Outdated
Show resolved
Hide resolved
…08.py Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>
…08_an.py Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>
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.
Separated from #1006
Bug documented in #1133
One note on the implementation. Because the CLI options during an autocompletion run are passed through shell-specific mechanisms (usually environment variables) and are not available in sys.args we have to resort to adding this information to the context in the completer classes. Click provides a mechanism to do this using ctx_args and the "obj" parameter. Obj is seldom used, but it can be anything per the click docs. Right now I do not believe the click code path sets it to anything. This PR sets it to a dictionary if it isn't already and if it is dictionary it sets the args key to be the arguments passed by the shell specific mechanism. This would be brittle to obj being set somewhere upstream to anything but a dictionary. I think this is unlikely to happen, but if it does it will not brick the code, it'll just revert to the current behavior (empty list) and the CI will fail.