Support Pydantic root model as query parameter #11306
Open
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
9 tasks
MarkusSintonen
force-pushed
the
rootmodel
branch
from
509f795
to
d22d6e0
Compare
MarkusSintonen
changed the title
MarkusSintonen
commented
Mar 18, 2024
|
|
||
| return field_annotation_is_scalar( | ||
| field.field_info.annotation | ||
| ) and not isinstance(field.field_info, params.Body) |
There was a problem hiding this comment.
This check was missing from v1 side. Lifted the params.Body check out from this "scalar field check" into is_body_param check which is more appropriate for checking the params.Body case.
MarkusSintonen
commented
Mar 18, 2024
| elif not field_annotation_is_scalar(annotation=type_annotation): | ||
| elif ( | ||
| not field_annotation_is_scalar(type_annotation) | ||
| # Root models by default regarded as bodies |
There was a problem hiding this comment.
Backward compatibility. Root models have been regarded as body params by default eventhough they were scalar.
There was a problem hiding this comment.
Another option would be to explicitly require annotating by Body/Query,etc
MarkusSintonen
force-pushed
the
rootmodel
branch
from
5750f7f
to
52841df
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.
Fixes #11134
Adds support for Pydantic root model in query/path parameters. Supports PydaticV2
RootModel[X]and PydanticV1BaseModel.__root__. This is a non breaking change as previously root models usage threw errors on route initialization when they were not used as bodies.Adds lots of (previously missing) tests.