🗑️ Deprecate shell_complete and continue to use autocompletion for CLI parameters
#974
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
shell_complete and continue to use autocompletionshell_complete and continue to use autocompletion
|
📝 Docs preview for commit 749cade at: https://6b09d267.typertiangolo.pages.dev Modified Pages |
|
📝 Docs preview for commit 286b94e at: https://b744c2ac.typertiangolo.pages.dev Modified Pages |
|
📝 Docs preview for commit ca4ca2c at: https://214d2bbc.typertiangolo.pages.dev Modified Pages |
7 tasks
svlandeg
commented
Sep 5, 2024
|
📝 Docs preview for commit 2261391 at: https://bde7f85a.typertiangolo.pages.dev Modified Pages |
1 task
|
📝 Docs preview for commit e17a0f5 at: https://b6cd9db3.typertiangolo.pages.dev Modified Pages |
This was referenced Sep 29, 2024
|
📝 Docs preview for commit 37cbc85 at: https://f067fbd8.typertiangolo.pages.dev Modified Pages |
tiangolo
changed the title
shell_complete and continue to use autocompletionshell_complete and continue to use autocompletion for CLI parameters
|
📝 Docs preview for commit 5d13465 at: https://df25d00f.typertiangolo.pages.dev Modified Pages |
tiangolo
reviewed
Dec 4, 2024
1 task
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.
Cf issue: #949
After some internal discussion with Tiangolo, we've decided to keep the
autocompletionfunctionality in Typer as-is, to ensure minimal breaking changes for users. This also means that we won't be moving to a new argumentshell_complete, as Click v8 has done.While there were some preliminary provisions for
shell_completealready in the code base, this functionality wasn't really documented or supported yet, and it didn't yet rely on type annotations, so we consider it to have been non-functional, and we'll remove it in a later version.This PR clarifies the deprecation status both in the code, in a warning message, and in the docs.