-
-
Notifications
You must be signed in to change notification settings - Fork 6.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support Pydantic root model as query parameter #11306
Open
MarkusSintonen
wants to merge
4
commits into
tiangolo:master
Choose a base branch
from
MarkusSintonen:rootmodel
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3b0362e
Support Pydantic root model as query parameter
MarkusSintonen 2df55f2
Root model by default again as body
MarkusSintonen 52841df
Add PYDANTIC_V2 check to __root__ check. Use type alias in basic test
MarkusSintonen d54c749
Remove no longer needed pydantic url test check
MarkusSintonen File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,7 @@ | |
copy_field_info, | ||
create_body_model, | ||
evaluate_forwardref, | ||
field_annotation_is_root_model, | ||
field_annotation_is_scalar, | ||
get_annotation_from_field_info, | ||
get_missing_field_error, | ||
|
@@ -414,7 +415,11 @@ def analyze_param( | |
type_annotation | ||
) or is_uploadfile_sequence_annotation(type_annotation): | ||
field_info = params.File(annotation=use_annotation, default=default_value) | ||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Backward compatibility. Root models have been regarded as body params by default eventhough they were scalar. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Another option would be to explicitly require annotating by |
||
or field_annotation_is_root_model(type_annotation) | ||
): | ||
field_info = params.Body(annotation=use_annotation, default=default_value) | ||
else: | ||
field_info = params.Query(annotation=use_annotation, default=default_value) | ||
|
@@ -459,7 +464,9 @@ def is_body_param(*, param_field: ModelField, is_path_param: bool) -> bool: | |
field=param_field | ||
), "Path params must be of one of the supported types" | ||
return False | ||
elif is_scalar_field(field=param_field): | ||
elif is_scalar_field(field=param_field) and not isinstance( | ||
param_field.field_info, params.Body | ||
): | ||
return False | ||
elif isinstance( | ||
param_field.field_info, (params.Query, params.Header) | ||
|
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This check was missing from v1 side. Lifted the
params.Body
check out from this "scalar field check" intois_body_param
check which is more appropriate for checking theparams.Body
case.