Skip to content

Fix nested serializers with unique_together relations. #2975

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

Merged
xordoquy merged 4 commits into from
Jun 1, 2015
Merged

Fix nested serializers with unique_together relations. #2975

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
805a915
can't nest unique_together relations
sheppard May 28, 2015
8c7b5fc
pop required extra_kwargs if read_only is set
sheppard May 28, 2015
0b8b288
python2 compat
sheppard May 28, 2015
4a3c844
flake8
sheppard May 28, 2015
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
3 changes: 3 additions & 0 deletions rest_framework/serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1088,6 +1088,9 @@ def include_extra_kwargs(self, kwargs, extra_kwargs):
if extra_kwargs.get('default') and kwargs.get('required') is False:
kwargs.pop('required')

if kwargs.get('read_only', False):
extra_kwargs.pop('required', None)

kwargs.update(extra_kwargs)

return kwargs
Expand Down
26 changes: 26 additions & 0 deletions tests/test_model_serializer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,13 @@ class RelationalModel(models.Model):
through = models.ManyToManyField(ThroughTargetModel, through=Supplementary, related_name='reverse_through')


class UniqueTogetherModel(models.Model):
foreign_key = models.ForeignKey(ForeignKeyTargetModel, related_name='unique_foreign_key')
one_to_one = models.OneToOneField(OneToOneTargetModel, related_name='unique_one_to_one')
class Meta:
unique_together = ("foreign_key", "one_to_one")


class TestRelationalFieldMappings(TestCase):
def test_pk_relations(self):
class TestSerializer(serializers.ModelSerializer):
Expand Down Expand Up @@ -395,6 +402,25 @@ class Meta:
""")
self.assertEqual(unicode_repr(TestSerializer()), expected)

def test_nested_unique_together_relations(self):
class TestSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = UniqueTogetherModel
depth = 1
expected = dedent("""
TestSerializer():
url = HyperlinkedIdentityField(view_name='uniquetogethermodel-detail')
foreign_key = NestedSerializer(read_only=True):
url = HyperlinkedIdentityField(view_name='foreignkeytargetmodel-detail')
name = CharField(max_length=100)
one_to_one = NestedSerializer(read_only=True):
url = HyperlinkedIdentityField(view_name='onetoonetargetmodel-detail')
name = CharField(max_length=100)
class Meta:
validators = [<UniqueTogetherValidator(queryset=UniqueTogetherModel.objects.all(), fields=('foreign_key', 'one_to_one'))>]
""")
self.assertEqual(unicode_repr(TestSerializer()), expected)
Copy link
Copy Markdown
Contributor

@xordoquy xordoquy May 28, 2015

Choose a reason for hiding this comment

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

You'll likely want a slightly different representation for python 2.7.
See https://github.com/sheppard/django-rest-framework/blob/read-only-nested/tests/test_model_serializer.py#L172 for example.


def test_pk_reverse_foreign_key(self):
class TestSerializer(serializers.ModelSerializer):
class Meta:
Expand Down
⚡