Skip to content

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.

Sign up for GitHub

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
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Add support for source with attributes in extra_kwargs of ModelSerializer #9077

Changes from 1 commit
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 Aug 16, 2023
705e277
Add test case for source with attributes in extra_kwargs
BergLucas Aug 23, 2023
c1ccc37
Add a real world example
BergLucas Sep 13, 2023
a5b239e
Fix test for Django 3.0
BergLucas Sep 14, 2023
2fc08b2
Add some documentation about source in extra_kwargs
BergLucas Oct 6, 2023
05b2e3b
Merge branch 'master' into improvement/source-attributes-in-extra_kwargs
BergLucas Apr 27, 2025
b4ce3e5
Change the test "test_source_with_attributes" to target django 4.2-5.2
BergLucas Apr 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion rest_framework/serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1117,9 +1117,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:
Copy link
Contributor

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, the for loop will not iterate, but its else clause will; I believe that a minor adjustment in the else branch will then allow the same functionality.

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
Copy link
Contributor

Choose a reason for hiding this comment

The 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`
Expand Down