From 4e7e728ab92241bbaeba3ffdaf0eb81ecef6dab3 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Wed, 15 Nov 2017 16:28:49 -0500 Subject: [PATCH] Assert declared fields are not present in exclude --- rest_framework/serializers.py | 11 +++++++++++ tests/test_model_serializer.py | 8 +++++++- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 994d0273f..0952e190c 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -1102,6 +1102,17 @@ class ModelSerializer(Serializer): if exclude is not None: # If `Meta.exclude` is included, then remove those fields. for field_name in exclude: + assert field_name not in self._declared_fields, ( + "Cannot both declare the field '{field_name}' and include " + "it in the {serializer_class} 'exclude' option. Remove the " + "field or, if inherited from a parent serializer, disable " + "with `{field_name} = None`." + .format( + field_name=field_name, + serializer_class=self.__class__.__name__ + ) + ) + assert field_name in fields, ( "The field '{field_name}' was included on serializer " "{serializer_class} in the 'exclude' option, but does " diff --git a/tests/test_model_serializer.py b/tests/test_model_serializer.py index 065d60548..98586b971 100644 --- a/tests/test_model_serializer.py +++ b/tests/test_model_serializer.py @@ -908,7 +908,13 @@ class TestSerializerMetaClass(TestCase): model = MetaClassTestModel exclude = ('text',) - assert list(ExampleSerializer().fields) == ['id', 'text'] + expected = ( + "Cannot both declare the field 'text' and include it in the " + "ExampleSerializer 'exclude' option. Remove the field or, if " + "inherited from a parent serializer, disable with `text = None`." + ) + with self.assertRaisesMessage(AssertionError, expected): + ExampleSerializer().fields class Issue2704TestCase(TestCase):