Fix validation_alias behavior with model_construct for AliasChoices and AliasPath
#9223
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
Deploying pydantic-docs with
|
| Latest commit: |
c1d585f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9d295dfb.pydantic-docs2.pages.dev |
| Branch Preview URL: | https://full-alias-fix.pydantic-docs2.pages.dev |
CodSpeed Performance ReportMerging #9223 will not alter performanceComparing Summary
|
|
Please review |
adriangb
approved these changes
Apr 12, 2024
This was referenced Apr 12, 2024
|
One potential issue with this approach — the following code errors for normal validation: from pydantic import BaseModel, AliasPath, Field
class MyModel(BaseModel):
x: str = Field(alias=AliasPath('y', 1))
print(MyModel(y=['abc', 'def']))
print(MyModel(y='abc'))
"""
y.1
Field required [type=missing, input_value={'y': 'abc'}, input_type=dict]
"""and if you add a default, you get the default: from pydantic import BaseModel, AliasPath, Field
class MyModel(BaseModel):
x: str = Field(default='xyz', alias=AliasPath('y', 1))
print(MyModel(y=['abc', 'def']))
#> x='def'
print(MyModel(y='abc'))
#> x='xyz'However, with your current implementation, if you use from pydantic import BaseModel, AliasPath, Field
class MyModel(BaseModel):
x: str = Field(default='xyz', alias=AliasPath('y', 1))
print(MyModel.model_construct(y=['abc', 'def']))
#> x='def' (as expected)
print(MyModel.model_construct(y='abc'))
#> x='b' (not expected)Not sure if this is a blocking-level problem, or if it's worth the overhead it would add to prevent this misbehavior. |
|
Just added an from pydantic import BaseModel, AliasPath, Field
class MyModel(BaseModel):
x: str = Field(default='xyz', validation_alias=AliasPath('y', 1))
print(MyModel.model_construct(y=['abc', 'def']))
#> x='def' (as expected)
print(MyModel.model_construct(y='abc'))
#> x='xyz' (as expected) |
dmontagu
approved these changes
Apr 12, 2024
sydney-runkle
changed the title
validation_alias behavior with model_construct for AliasChoices and AliasPath
1 task
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.
Fix #9216
Fix #9220
Initially introduced in #9144 because we forgot to account for
AliasPathandAliasChoicesvalidation aliases!Selected Reviewer: @adriangb