🗑️ Deprecate `shell_complete` and continue to use `autocompletion`

fastapi / typer

Typer, build great CLIs. Easy to code. Based on Python type hints.

https://typer.tiangolo.com/

MIT License

15.66k stars 666 forks source link

🗑️ Deprecate `shell_complete` and continue to use `autocompletion` #974

Open svlandeg opened 1 month ago

svlandeg commented 1 month ago

Cf issue: https://github.com/fastapi/typer/issues/949

After some internal discussion with Tiangolo, we've decided to keep the autocompletion functionality in Typer as-is, to ensure minimal breaking changes for users. This also means that we won't be moving to a new argument shell_complete, as Click v8 has done.

While there were some preliminary provisions for shell_complete already 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.