Skip to content

⬆️ Add compatibility with Click 8.2 #1222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 23 commits into from
May 26, 2025
Merged

⬆️ Add compatibility with Click 8.2 #1222

merged 23 commits into from
May 26, 2025

Conversation

tiangolo
Copy link
Member

⬆️ Add compatibility with Click 8.2

@thewhaleking
Copy link

Also, the docs reference using mix_stderr=False for CliRunner, but this is not longer available in Click 8.2.0

@anschweitzer anschweitzer mentioned this pull request May 14, 2025
Open
@zmoon zmoon mentioned this pull request May 14, 2025
Draft
1 task
@tiangolo tiangolo mentioned this pull request May 14, 2025
Merged
@theMarix theMarix mentioned this pull request May 14, 2025
Closed
lord-haffi
lord-haffi reviewed May 14, 2025
View reviewed changes
@bckohan bckohan mentioned this pull request May 14, 2025
Closed
@benemer benemer mentioned this pull request May 15, 2025
Closed
@finsberg finsberg mentioned this pull request May 17, 2025
Merged
@ncoghlan ncoghlan mentioned this pull request May 19, 2025
Closed
@hoechenberger hoechenberger mentioned this pull request May 19, 2025
Merged
kiinami added a commit to kamihi-dev/kamihi that referenced this pull request May 20, 2025
@kiinami
fix(cli): pinning click to <8.2 until fastapi/typer#1222 is merged
49841d7
@davidism
Copy link

I haven't looked over this PR, but we did just add a new doc page about supporting multiple versions in Click, with an example for the get_metavar signature change. https://click.palletsprojects.com/en/stable/support-multiple-versions/ If there are other parts that you think we should document, or need help figuring out compatibility with, please let us (Click maintainers) know.

@belingud belingud mentioned this pull request May 22, 2025
Closed
@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 02f6565 at: https://a1cfb4c7.typertiangolo.pages.dev

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 1cbcbc1 at: https://3eb7a4b8.typertiangolo.pages.dev

@tiangolo
Copy link
Member Author

tiangolo commented May 22, 2025 •
edited
Loading

Thanks a lot for offering help @davidism and especially for writing those docs! 🙌

I'm currently debugging the output showing errors for required parameters, with the update it doesn't show what was the (missing) required parameter, I probably have something wrong here... still debugging. 🤓 This was mainly about updating output formatting.

Now I'm debugging something related to shell completion. The shell completion thing was only about accessing the result.output.

The challenge was finding something related to the new support for enums in Click. In Click 8.2, choice types can use enums, but they expect the command to pass the name of the enum, not the value. And Typer has supported enums but using the value as the input instead of the enum name. This was handled by creating a custom Typer class type for choice that handles the input with the old Typer behavior.

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit bd98584 at: https://ec702d88.typertiangolo.pages.dev

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 17350f5 at: https://f7ea7382.typertiangolo.pages.dev

kiinami added a commit to kamihi-dev/kamihi that referenced this pull request May 26, 2025
@kiinami
fix(cli): pinning click to <8.2 until fastapi/typer#1222 is merged
3af9c25
@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 3b8f9bc at: https://560ec3ed.typertiangolo.pages.dev

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit ce2f27b at: https://243fb83f.typertiangolo.pages.dev

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit a336edd at: https://530c5e42.typertiangolo.pages.dev

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 7da4979 at: https://41a2b5ff.typertiangolo.pages.dev

Modified Pages

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 5c0b4a6 at: https://2203dc8e.typertiangolo.pages.dev

Modified Pages

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 45ca749 at: https://4703c015.typertiangolo.pages.dev

Modified Pages

@tiangolo tiangolo marked this pull request as ready for review May 26, 2025 14:18
@tiangolo tiangolo merged commit 74e0923 into master May 26, 2025
24 checks passed
@tiangolo tiangolo deleted the click-8.2 branch May 26, 2025 14:22
@tiangolo
Copy link
Member Author

This is now available in Typer 0.16.0 🚀 🎉

@FFY00 FFY00 mentioned this pull request May 27, 2025
Closed
@gnahtb gnahtb mentioned this pull request Jun 26, 2025
Merged
anschweitzer added a commit to SmoothStoneComputing/gridworks-proactor that referenced this pull request Jul 15, 2025
@anschweitzer
Merge pull request #404 from SmoothStoneComputing/dev
6f2a5d7 
Allow typer 0.16.0 by restricting click to <8.2.0. Discussions: 
* fastapi/typer#1240
* fastapi/typer#1233

Older layers of discussion of click 8.2 support in typer:
* fastapi/typer#1215
*  fastapi/typer#1222
*  https://github.com/fastapi/typer/commits/click-8.2/
* pallets/click#2909
* pallets/click#1394
* pallets/click#1489
@xretr0 xretr0 mentioned this pull request Aug 5, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@lord-haffi lord-haffi lord-haffi left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
upgrade
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tiangolo @thewhaleking @davidism @lord-haffi