Skip to content

Fixed #3674 -- Refactored _get_reverse_relationships() to use correct to_field. #3852

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

Closed
xordoquy wants to merge 6 commits into from
Closed

Fixed #3674 -- Refactored _get_reverse_relationships() to use correct to_field. #3852

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ce98c3d
Refactored _get_reverse_relationships() to use related object's pk fi…
Dec 2, 2015
21839e4
Modified build_relational_field() to change its behaviour if relation…
Dec 3, 2015
dae5a5c
Fixed Django1.9 compatibility and added test.
Dec 7, 2015
b7b6ba3
Merge remote-tracking branch 'reference/master' into 3674-ID-DoesNotE…
xordoquy Jan 20, 2016
15ec87c
Add a non ID PK test (thanks to @benred42)
xordoquy Jan 20, 2016
e670284
Add an explicit name to the models.
xordoquy Jan 21, 2016
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
Prev Previous commit
Next Next commit
Modified build_relational_field() to change its behaviour if relation… 
…ship is reverse vs forward to ensure correct field checking
  • Loading branch information
bphillips committed Dec 3, 2015
commit 21839e45c6da35ea8c2155b7840d0d0cd863f0b0
11 changes: 8 additions & 3 deletions rest_framework/serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1131,9 +1131,14 @@ def build_relational_field(self, field_name, relation_info):
field_kwargs = get_relation_kwargs(field_name, relation_info)

to_field = field_kwargs.pop('to_field', None)
if to_field and not relation_info.related_model._meta.get_field(to_field).primary_key:
field_kwargs['slug_field'] = to_field
field_class = self.serializer_related_to_field
if relation_info.reverse:
if to_field and not relation_info.related_model_field.related_field.primary_key:
field_kwargs['slug_field'] = to_field
field_class = self.serializer_related_to_field
Copy link
Contributor

@lovelydinosaur lovelydinosaur Jun 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tests don't appear to hit this branch, so hard to verify on first sight - some more digging may be required.

Copy link

@benred42 benred42 Jul 19, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it looks like we need to add a test case where the to_field argument on the foreign key relationship is set to a non-pk field in order to cover this branch. I hope to get a chance to work on this soon.

else:
if to_field and not relation_info.related_model._meta.get_field(to_field).primary_key:
field_kwargs['slug_field'] = to_field
field_class = self.serializer_related_to_field

# `view_name` is only valid for hyperlinked relationships.
if not issubclass(field_class, HyperlinkedRelatedField):
Expand Down
2 changes: 1 addition & 1 deletion rest_framework/utils/field_mapping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ def get_relation_kwargs(field_name, relation_info):
"""
Creates a default instance of a flat relational field.
"""
model_field, related_model, to_many, to_field, has_through_model = relation_info
model_field, related_model, related_model_field, to_many, to_field, has_through_model, reverse = relation_info
kwargs = {
'queryset': related_model._default_manager,
'view_name': get_detail_view_name(related_model)
Expand Down
22 changes: 16 additions & 6 deletions rest_framework/utils/model_meta.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@
RelationInfo = namedtuple('RelationInfo', [
'model_field',
'related_model',
'related_model_field',
'to_many',
'to_field',
'has_through_model'
'has_through_model',
'reverse'
])


Expand Down Expand Up @@ -108,22 +110,26 @@ def _get_forward_relationships(opts):
forward_relations[field.name] = RelationInfo(
model_field=field,
related_model=_resolve_model(field.rel.to),
related_model_field=None,
to_many=False,
to_field=_get_to_field(field),
has_through_model=False
has_through_model=False,
reverse=False
)

# Deal with forward many-to-many relationships.
for field in [field for field in opts.many_to_many if field.serialize]:
forward_relations[field.name] = RelationInfo(
model_field=field,
related_model=_resolve_model(field.rel.to),
related_model_field=None,
to_many=True,
# manytomany do not have to_fields
to_field=None,
has_through_model=(
not field.rel.through._meta.auto_created
)
),
reverse=False
)

return forward_relations
Expand All @@ -144,9 +150,11 @@ def _get_reverse_relationships(opts):
reverse_relations[accessor_name] = RelationInfo(
model_field=None,
related_model=related,
related_model_field=relation.field,
to_many=relation.field.rel.multiple,
to_field=_get_to_field(relation.field.model._meta.pk),
has_through_model=False
to_field=_get_to_field(relation.field),
has_through_model=False,
reverse=True
)

# Deal with reverse many-to-many relationships.
Expand All @@ -156,13 +164,15 @@ def _get_reverse_relationships(opts):
reverse_relations[accessor_name] = RelationInfo(
model_field=None,
related_model=related,
related_model_field=relation.field,
to_many=True,
# manytomany do not have to_fields
to_field=None,
has_through_model=(
(getattr(relation.field.rel, 'through', None) is not None) and
not relation.field.rel.through._meta.auto_created
)
),
reverse=True
)

return reverse_relations
Expand Down