Do not cache parametrized models when in the process of parametrizing another model #10704
Conversation
This file contains hidden or 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
Deploying pydantic-docs with
|
| Latest commit: |
6194229
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://24ecaaa2.pydantic-docs.pages.dev |
| Branch Preview URL: | https://10279-2.pydantic-docs.pages.dev |
CodSpeed Performance ReportMerging #10704 will not alter performanceComparing Summary
|
|
@Viicos, this should be unblocked now :) |
Viicos
commented
Jan 6, 2025
Comment on lines
-761
to
-762
| assert module.Foo.model_fields['bar'].annotation == typing.Optional[module.Bar[str]] | ||
| assert module.Foo.model_fields['bar2'].annotation == typing.Union[int, module.Bar[float]] |
There was a problem hiding this comment.
These assertions are not valid anymore, as the Bar[str] class on the annotation is no longer the same that the one we create by calling module.Bar[str] here (as it isn't cached anymore).
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
1 task
sydney-runkle
approved these changes
Jan 7, 2025
This was referenced Apr 14, 2025
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
Fixes #10279, partially fixes #9887.
We avoid caching parametrized models when in the process of parametrizing another model, as the result of
BaseModel.__class_getitem__can returnPydanticRecursiveRefinstances in this case. In the model core schema generation logic, we mutateFieldInfoinstances if the annotation wasn't evaluated yet, meaning we could set the annotation to some typing construct containing aPydanticRecursiveRef, e.g. with:Because these
FieldInfoinstances come from themodel_fieldsattribute of the model class, having the caching logic here can result in a parametrized model class with aFieldInfocontainingPydanticRecursiveRefinstances when we later parametrize a model (e.g.Model1[str]).Note that is hopefully not a long term solution, as this doesn't fix what is an even simpler repro: #9969.
Related issue number
Checklist