✨ Support common pydantic types

[lachaib]

This PR is "functional" as in "it does what was expected"

• Support pydantic common types while keeping pydantic an optional dependency
• Works in lists and tuples
• Documentation with examples and test on examples

However, don't hesitate to request more tests, docs, or improvements on the code if needed to fit with the current standards

Fixes #181

[github-actions]

📝 Docs preview for commit 7ea8313 at: https://d7891fe3.typertiangolo.pages.dev

[github-actions]

📝 Docs preview for commit a36f24d at: https://9028cd14.typertiangolo.pages.dev

[github-actions]

📝 Docs preview for commit 23988ad at: https://4451bb64.typertiangolo.pages.dev

[github-actions]

📝 Docs preview for commit 08d1fac at: https://3976aef9.typertiangolo.pages.dev

[lachaib]

@tiangolo in order to add a basic pydantic support, we'd need to drop python 3.6, and I'd say it's about time 😏
Would you agree with that? Do you want me to open another pull request to do so? I'd be glad to help.

Edit: seems it's already submitted here #556

[github-actions]

📝 Docs preview for commit f6c2b03 at: https://1d1a6c3f.typertiangolo.pages.dev

[svlandeg]

@tiangolo in order to add a basic pydantic support, we'd need to drop python 3.6, and I'd say it's about time 😏

Hi! Note that Python 3.6 support was recently dropped in 0.11.0.

[lachaib]

@tiangolo in order to add a basic pydantic support, we'd need to drop python 3.6, and I'd say it's about time 😏

Hi! Note that Python 3.6 support was recently dropped in 0.11.0.

Yep I noticed that's why I rebased my PR yesterday 😁
Now the docs can't build in CI and I don't control it 😓

[svlandeg]

Now the docs can't build in CI and I don't control it 😓

There's an issue with the documentation building on the CI, unrelated to this PR. We're looking into it!

[UPDATE] docs building CI error is fixed.

[github-actions]

📝 Docs preview for commit 19319c6 at: https://99282d37.typertiangolo.pages.dev

[pypae]

Looks great, I'd love to see this get merged!

Could we somehow also support custom types defined by users like pydantic?

[lachaib]

Looks great, I'd love to see this get merged!

Me too 😁

Could we somehow also support custom types defined by users like pydantic?

TBH I think this PR covers most of cases we need for now and I prefer to keep it minimalistic to get a chance for it to be merged soon.
On a personal project I managed to go a bit further and I'd really be glad to see Typer include all the features I made (some from inspiration of existing PRs) but small steps are always better.

[github-actions]

📝 Docs preview for commit fde3d16 at: https://6fef5bb9.typertiangolo.pages.dev

[github-actions]

📝 Docs preview for commit 2166319 at: https://ddf226eb.typertiangolo.pages.dev

[github-actions]

📝 Docs preview for commit 0ac6ec0 at: https://d8df500d.typertiangolo.pages.dev

[github-actions]

📝 Docs preview for commit 707839e at: https://ad610314.typertiangolo.pages.dev

[benglewis]

@tiangolo Is this PR being considered?

[svlandeg]

@lachaib : I've internally solicited feedback from @tiangolo to decide on the direction of this work. The PR is in a good state to review and to assess what the added functionality would offer. But he'll need to decide whether we want to add this optional Pydantic dependency to Typer. I basically see three options:

1. Add Pydantic as default, but optional dependency together with rich and shellingham (as in this PR)
2. Add Pydantic as non-default, optional dependency through an additional install flag (this PR can be edited to do that)
3. Don't add Pydantic as a dependency and not have this built-in support

If the third option is chosen, an alternative such as @pypae's recent WIP on pydantic-typer could be considered.

[lachaib]

Given this feature is listed in the roadmap #678 , I pray this won't end up in option 3.
I've had a hack in my company's project for around as long as this PR's been opened and I'm looking forward to see it streamlined.
@tiangolo, as everything seems in your hands, don't hesitate to make a statement. I'm also available on discord if you want to discuss it.

[github-actions]

📝 Docs preview for commit 795e8e4 at: https://7eb4439c.typertiangolo.pages.dev

Modified Pages

• https://7eb4439c.typertiangolo.pages.dev/
• https://7eb4439c.typertiangolo.pages.dev/release-notes/
• https://7eb4439c.typertiangolo.pages.dev/tutorial/
• https://7eb4439c.typertiangolo.pages.dev/tutorial/parameter-types/pydantic-types/

[github-actions]

📝 Docs preview for commit 9fa6717 at: https://b43ba1fa.typertiangolo.pages.dev

Modified Pages

• https://b43ba1fa.typertiangolo.pages.dev/
• https://b43ba1fa.typertiangolo.pages.dev/release-notes/
• https://b43ba1fa.typertiangolo.pages.dev/tutorial/
• https://b43ba1fa.typertiangolo.pages.dev/tutorial/parameter-types/pydantic-types/

[svlandeg]

Slightly tricky merge conflict - I'll look into this and get this branch back up-to-date and green 🤞

Update: the test failure came from reverting an edit in this PR that changed the imports for get_args and get_origin to typing_extensions instead of _typing.py. I'd like to revisit such changes separately from all the functionality added here, and suggest to break that bit out to the PR #805.

[github-actions]

📝 Docs preview for commit 39c7d45 at: https://198486ca.typertiangolo.pages.dev

Modified Pages

• https://198486ca.typertiangolo.pages.dev/
• https://198486ca.typertiangolo.pages.dev/release-notes/
• https://198486ca.typertiangolo.pages.dev/tutorial/parameter-types/pydantic-types/

[github-actions]

📝 Docs preview for commit 26d1120 at: https://0719d402.typertiangolo.pages.dev

Modified Pages

• https://0719d402.typertiangolo.pages.dev/
• https://0719d402.typertiangolo.pages.dev/release-notes/
• https://0719d402.typertiangolo.pages.dev/tutorial/parameter-types/pydantic-types/

[github-actions]

📝 Docs preview for commit b70d5a6 at: https://859d3187.typertiangolo.pages.dev

Modified Pages

• https://859d3187.typertiangolo.pages.dev/
• https://859d3187.typertiangolo.pages.dev/release-notes/
• https://859d3187.typertiangolo.pages.dev/tutorial/parameter-types/pydantic-types/

[github-actions]

📝 Docs preview for commit 9bd66be at: https://66487e33.typertiangolo.pages.dev

Modified Pages

• https://66487e33.typertiangolo.pages.dev/
• https://66487e33.typertiangolo.pages.dev/release-notes/
• https://66487e33.typertiangolo.pages.dev/tutorial/parameter-types/pydantic-types/

[github-actions]

📝 Docs preview for commit efa434b at: https://7790eb79.typertiangolo.pages.dev

Modified Pages

• https://7790eb79.typertiangolo.pages.dev/
• https://7790eb79.typertiangolo.pages.dev/release-notes/
• https://7790eb79.typertiangolo.pages.dev/tutorial/parameter-types/pydantic-types/

[github-actions]

📝 Docs preview for commit 0a793f6 at: https://86561e54.typertiangolo.pages.dev

Modified Pages

• https://86561e54.typertiangolo.pages.dev/
• https://86561e54.typertiangolo.pages.dev/release-notes/
• https://86561e54.typertiangolo.pages.dev/tutorial/parameter-types/pydantic-types/

[lachaib]

@pypae just so you know, I've tried to play a little bit yesterday night on getting this PR extended to support Custom Types, but the stack is stripping most annotations all the way down to the moment we're calling get_click_type and determine_type_convertor
There would be quite some additional changes to get there so I'm sticking with getting this PR done before extending it.