-
-
Notifications
You must be signed in to change notification settings - Fork 7k
Add support for source with attributes in extra_kwargs of ModelSerializer #9077
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
Open
BergLucas
wants to merge
7
commits into
encode:master
Choose a base branch
from
BergLucas:improvement/source-attributes-in-extra_kwargs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
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
7 commits
Select commit
Hold shift + click to select a range
dd0bb97
Add support for source with attributes in extra_kwargs
BergLucas 705e277
Add test case for source with attributes in extra_kwargs
BergLucas c1ccc37
Add a real world example
BergLucas a5b239e
Fix test for Django 3.0
BergLucas 2fc08b2
Add some documentation about source in extra_kwargs
BergLucas 05b2e3b
Merge branch 'master' into improvement/source-attributes-in-extra_kwargs
BergLucas b4ce3e5
Change the test "test_source_with_attributes" to target django 4.2-5.2
BergLucas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1101,9 +1101,36 @@ def get_fields(self): | |
if source == '*': | ||
source = field_name | ||
|
||
# Get the right model and info for source with attributes | ||
source_attrs = source.split('.') | ||
source_info = info | ||
source_model = model | ||
|
||
if len(source_attrs) > 1: | ||
attr_info = info | ||
attr_model = model | ||
|
||
for attr in source_attrs[:-1]: | ||
if attr not in attr_info.relations: | ||
break | ||
Comment on lines
+1114
to
+1115
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. This seems to cause trailing attributes to be ignored if they are "after" other relation attributes, but are not a relation themselves. Is this intended? If so, I think this scenario should also have a test case. |
||
|
||
attr_model = attr_info.relations[attr].related_model | ||
attr_info = model_meta.get_field_info(attr_model) | ||
else: | ||
attr = source_attrs[-1] | ||
if ( | ||
attr in attr_info.fields_and_pk | ||
or attr in attr_info.relations | ||
or hasattr(attr_model, attr) | ||
or attr == self.url_field_name | ||
): | ||
source = attr | ||
source_info = attr_info | ||
source_model = attr_model | ||
|
||
# Determine the serializer field class and keyword arguments. | ||
field_class, field_kwargs = self.build_field( | ||
source, info, model, depth | ||
source, source_info, source_model, depth | ||
) | ||
|
||
# Include any kwargs defined in `Meta.extra_kwargs` | ||
|
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
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.
It looks like this code can be simplified by removing this condition, and running the loop independently of
len(source_attrs)
. If the length is 1, thefor
loop will not iterate, but itselse
clause will; I believe that a minor adjustment in theelse
branch will then allow the same functionality.