From 20d1fdba697a590307ef65626bfb574a0c92bc96 Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Tue, 16 Feb 2016 09:29:48 +0100 Subject: [PATCH] Fix None UUID ForeignKey serialization --- docs/topics/release-notes.md | 1 + rest_framework/fields.py | 2 ++ tests/models.py | 15 +++++++++++++++ tests/test_relations_pk.py | 21 ++++++++++++++++++++- 4 files changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/topics/release-notes.md b/docs/topics/release-notes.md index b6794a817..9c8d9e978 100644 --- a/docs/topics/release-notes.md +++ b/docs/topics/release-notes.md @@ -45,6 +45,7 @@ You can determine your currently installed version using `pip freeze`: **Unreleased** * Dropped support for EOL Django 1.7 ([#3933][gh3933]) +* Fixed null foreign keys targeting UUIDField primary keys. ([#3936][gh3936]) ### 3.3.2 diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 6d5962c8e..c700b85e8 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -778,6 +778,8 @@ class UUIDField(Field): return data def to_representation(self, value): + if value is None: + return None if self.uuid_format == 'hex_verbose': return str(value) else: diff --git a/tests/models.py b/tests/models.py index 8ec274d8b..5d5d40968 100644 --- a/tests/models.py +++ b/tests/models.py @@ -1,5 +1,7 @@ from __future__ import unicode_literals +import uuid + from django.db import models from django.utils.translation import ugettext_lazy as _ @@ -46,6 +48,11 @@ class ForeignKeyTarget(RESTFrameworkModel): name = models.CharField(max_length=100) +class UUIDForeignKeyTarget(RESTFrameworkModel): + uuid = models.UUIDField(primary_key=True, default=uuid.uuid4) + name = models.CharField(max_length=100) + + class ForeignKeySource(RESTFrameworkModel): name = models.CharField(max_length=100) target = models.ForeignKey(ForeignKeyTarget, related_name='sources', @@ -62,6 +69,14 @@ class NullableForeignKeySource(RESTFrameworkModel): on_delete=models.CASCADE) +class NullableUUIDForeignKeySource(RESTFrameworkModel): + name = models.CharField(max_length=100) + target = models.ForeignKey(ForeignKeyTarget, null=True, blank=True, + related_name='nullable_sources', + verbose_name='Optional target object', + on_delete=models.CASCADE) + + # OneToOne class OneToOneTarget(RESTFrameworkModel): name = models.CharField(max_length=100) diff --git a/tests/test_relations_pk.py b/tests/test_relations_pk.py index 169f7d9c5..658357b2f 100644 --- a/tests/test_relations_pk.py +++ b/tests/test_relations_pk.py @@ -6,7 +6,8 @@ from django.utils import six from rest_framework import serializers from tests.models import ( ForeignKeySource, ForeignKeyTarget, ManyToManySource, ManyToManyTarget, - NullableForeignKeySource, NullableOneToOneSource, OneToOneTarget + NullableForeignKeySource, NullableOneToOneSource, + NullableUUIDForeignKeySource, OneToOneTarget, UUIDForeignKeyTarget ) @@ -43,6 +44,18 @@ class NullableForeignKeySourceSerializer(serializers.ModelSerializer): fields = ('id', 'name', 'target') +# Nullable UUIDForeignKey +class NullableUUIDForeignKeySourceSerializer(serializers.ModelSerializer): + target = serializers.PrimaryKeyRelatedField( + pk_field=serializers.UUIDField(), + queryset=UUIDForeignKeyTarget.objects.all(), + allow_empty=True) + + class Meta: + model = NullableUUIDForeignKeySource + fields = ('id', 'name', 'target') + + # Nullable OneToOne class NullableOneToOneTargetSerializer(serializers.ModelSerializer): class Meta: @@ -432,6 +445,12 @@ class PKNullableForeignKeyTests(TestCase): ] self.assertEqual(serializer.data, expected) + def test_null_uuid_foreign_key_serializes_as_none(self): + source = NullableUUIDForeignKeySource(name='Source') + serializer = NullableUUIDForeignKeySourceSerializer(source) + data = serializer.data + self.assertEqual(data["target"], None) + class PKNullableOneToOneTests(TestCase): def setUp(self):