Update documentation for generics support in V2 #6685
Merged
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
PYD-107 New functionality: Generics improvements
|
Deploying with
|
| Latest commit: |
65e96f9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0c6cee65.pydantic-docs2.pages.dev |
| Branch Preview URL: | https://generics-updates.pydantic-docs2.pages.dev |
|
please review |
adriangb
approved these changes
Jul 14, 2023
| assert validator.validate_python({'x': None}).x is None | ||
| assert validator.validate_python({'x': 1}).x == 1 | ||
| assert validator.validate_python({'x': 'a'}).x == 'a' | ||
| ``` |
There was a problem hiding this comment.
Maybe worth noting that if you use the dataclass as a field of a BaseModel or via FastAPI you don't need a TypeAdapter
| @@ -158,6 +159,46 @@ print(m.model_dump()) | |||
|
|
|||
| For self-referencing models, see [postponed annotations](postponed_annotations.md#self-referencing-or-recursive-models). | |||
|
|
|||
| ## Rebuild model schema | |||
|
|
|||
| The model schema can be rebuilt using `model_rebuild()`. This is useful for building recursive generic models. | |||
There was a problem hiding this comment.
We need to tell users when it's useful. Something like "we try to determine when this is necessary and error if it wasn't done but you may want to call model_rebuild() proactively when dealing with recursive and/or generics.
adriangb
approved these changes
Jul 15, 2023
hramezani
force-pushed
the
generics-updates
branch
from
327a9ed
to
65e96f9
Compare
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.
Change Summary
Related issue number
Closes PYD-107
Checklist
Selected Reviewer: @adriangb