Fix: Prevent SerializerMethodField from becoming HiddenField in unique_together

Ensures SerializerMethodFields shadowing model fields in uniqueness constraints aren't hidden.

Author: google-labs-jules[bot]

rest_framework/locale/es/LC_MESSAGES/django.mo

@@ -10,13 +10,12 @@
 # Miguel Gonzalez <[email protected]>, 2016
 # Miguel Gonzalez <[email protected]>, 2015-2016
 # Sergio Infante <[email protected]>, 2015
-# Federico Bond <[email protected]>, 2025
 msgid ""
 msgstr ""
 "Project-Id-Version: Django REST framework\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2020-10-13 21:45+0200\n"
-"PO-Revision-Date: 2025-05-19 00:05+1000\n"
+"PO-Revision-Date: 2020-10-13 19:45+0000\n"
 "Last-Translator: Xavier Ordoquy <[email protected]>\n"
 "Language-Team: Spanish (http://www.transifex.com/django-rest-framework-1/django-rest-framework/language/es/)\n"
 "MIME-Version: 1.0\n"
@@ -108,7 +107,7 @@ msgstr "Se ha producido un error en el servidor."
 
 #: exceptions.py:142
 msgid "Invalid input."
-msgstr "Entrada inválida."
+msgstr ""
 
 #: exceptions.py:161
 msgid "Malformed request."
@@ -151,12 +150,12 @@ msgstr "Solicitud fue regulada (throttled)."
 #: exceptions.py:224
 #, python-brace-format
 msgid "Expected available in {wait} second."
-msgstr "Se espera que esté disponible en {wait} segundo."
+msgstr ""
 
 #: exceptions.py:225
 #, python-brace-format
 msgid "Expected available in {wait} seconds."
-msgstr "Se espera que esté disponible en {wait} segundos."
+msgstr ""
 
 #: fields.py:316 relations.py:245 relations.py:279 validators.py:90
 #: validators.py:183
@@ -169,11 +168,11 @@ msgstr "Este campo no puede ser nulo."
 
 #: fields.py:701
 msgid "Must be a valid boolean."
-msgstr "Debe ser un booleano válido."
+msgstr ""
 
 #: fields.py:766
 msgid "Not a valid string."
-msgstr "No es una cadena válida."
+msgstr ""
 
 #: fields.py:767
 msgid "This field may not be blank."
@@ -205,16 +204,17 @@ msgstr "Introduzca un \"slug\" válido consistente en letras, números, guiones
 
 #: fields.py:839
 msgid ""
-"Enter a valid \"slug\" consisting of Unicode letters, numbers, underscores, or hyphens."
-msgstr "Introduzca un “slug” válido compuesto por letras Unicode, números, guiones bajos o medios."
+"Enter a valid \"slug\" consisting of Unicode letters, numbers, underscores, "
+"or hyphens."
+msgstr ""
 
 #: fields.py:854
 msgid "Enter a valid URL."
 msgstr "Introduzca una URL válida."
 
 #: fields.py:867
 msgid "Must be a valid UUID."
-msgstr "Debe ser un UUID válido."
+msgstr ""
 
 #: fields.py:903
 msgid "Enter a valid IPv4 or IPv6 address."
@@ -272,11 +272,11 @@ msgstr "Se esperaba un fecha/hora en vez de una fecha."
 #: fields.py:1150
 #, python-brace-format
 msgid "Invalid datetime for the timezone \"{timezone}\"."
-msgstr "Fecha y hora inválida para la zona horaria \"{timezone}\"."
+msgstr ""
 
 #: fields.py:1151
 msgid "Datetime value out of range."
-msgstr "Valor de fecha y hora fuera de rango."
+msgstr ""
 
 #: fields.py:1236
 #, python-brace-format
@@ -357,12 +357,12 @@ msgstr "Esta lista no puede estar vacía."
 #: fields.py:1605
 #, python-brace-format
 msgid "Ensure this field has at least {min_length} elements."
-msgstr "Asegúrese de que este campo tiene al menos {min_length} elementos."
+msgstr ""
 
 #: fields.py:1606
 #, python-brace-format
 msgid "Ensure this field has no more than {max_length} elements."
-msgstr "Asegúrese de que este campo no tiene más de {max_length} elementos."
+msgstr ""
 
 #: fields.py:1682
 #, python-brace-format
@@ -371,7 +371,7 @@ msgstr "Se esperaba un diccionario de elementos en vez del tipo \"{input_type}\"
 
 #: fields.py:1683
 msgid "This dictionary may not be empty."
-msgstr "Este diccionario no debe estar vacío."
+msgstr ""
 
 #: fields.py:1755
 msgid "Value must be valid JSON."
@@ -383,15 +383,15 @@ msgstr "Buscar"
 
 #: filters.py:50
 msgid "A search term."
-msgstr "Un término de búsqueda."
+msgstr ""
 
 #: filters.py:180 templates/rest_framework/filters/ordering.html:3
 msgid "Ordering"
 msgstr "Ordenamiento"
 
 #: filters.py:181
 msgid "Which field to use when ordering the results."
-msgstr "Qué campo usar para ordenar los resultados."
+msgstr ""
 
 #: filters.py:287
 msgid "ascending"
@@ -403,23 +403,23 @@ msgstr "descendiente"
 
 #: pagination.py:174
 msgid "A page number within the paginated result set."
-msgstr "Un número de página dentro del conjunto de resultados paginado."
+msgstr ""
 
 #: pagination.py:179 pagination.py:372 pagination.py:590
 msgid "Number of results to return per page."
-msgstr "Número de resultados a devolver por página."
+msgstr ""
 
 #: pagination.py:189
 msgid "Invalid page."
 msgstr "Página inválida."
 
 #: pagination.py:374
 msgid "The initial index from which to return the results."
-msgstr "El índice inicial a partir del cual devolver los resultados."
+msgstr ""
 
 #: pagination.py:581
 msgid "The pagination cursor value."
-msgstr "El valor del cursor de paginación."
+msgstr ""
 
 #: pagination.py:583
 msgid "Invalid cursor"
@@ -463,20 +463,20 @@ msgstr "Valor inválido."
 
 #: schemas/utils.py:32
 msgid "unique integer value"
-msgstr "valor de entero único"
+msgstr ""
 
 #: schemas/utils.py:34
 msgid "UUID string"
-msgstr "Cadena UUID"
+msgstr ""
 
 #: schemas/utils.py:36
 msgid "unique value"
-msgstr "valor único"
+msgstr ""
 
 #: schemas/utils.py:38
 #, python-brace-format
 msgid "A {value_type} identifying this {name}."
-msgstr "Un {value_type} que identifique este {name}."
+msgstr ""
 
 #: serializers.py:337
 #, python-brace-format
@@ -486,7 +486,7 @@ msgstr "Datos inválidos. Se esperaba un diccionario pero es un {datatype}."
 #: templates/rest_framework/admin.html:116
 #: templates/rest_framework/base.html:136
 msgid "Extra Actions"
-msgstr "Acciones extras"
+msgstr ""
 
 #: templates/rest_framework/admin.html:130
 #: templates/rest_framework/base.html:150

rest_framework/locale/es/LC_MESSAGES/django.po

@@ -1483,6 +1483,12 @@ def get_uniqueness_extra_kwargs(self, field_names, declared_fields, extra_kwargs
         hidden_fields = {}
         uniqueness_extra_kwargs = {}
 
+        # Identify declared SerializerMethodFields to prevent them from becoming HiddenFields
+        serializer_method_field_names = {
+            name for name, field_instance in declared_fields.items()
+            if isinstance(field_instance, SerializerMethodField)
+        }
+
         for unique_constraint_name in unique_constraint_names:
             # Get the model field that is referred too.
             unique_constraint_field = model._meta.get_field(unique_constraint_name)
@@ -1507,8 +1513,10 @@ def get_uniqueness_extra_kwargs(self, field_names, declared_fields, extra_kwargs
             elif default is not empty:
                 # The corresponding field is not present in the
                 # serializer. We have a default to use for it, so
-                # add in a hidden field that populates it.
-                hidden_fields[unique_constraint_name] = HiddenField(default=default)
+                # add in a hidden field that populates it,
+                # unless it's a SerializerMethodField.
+                if unique_constraint_name not in serializer_method_field_names:
+                    hidden_fields[unique_constraint_name] = HiddenField(default=default)
 
         # Update `extra_kwargs` with any new options.
         for key, value in uniqueness_extra_kwargs.items():

rest_framework/serializers.py

@@ -1346,6 +1346,31 @@ class Meta:
         fields = ('name',)
 
 
+class UniqueTestModel(models.Model):
+    name = models.CharField(max_length=100)
+    description = models.CharField(max_length=100, null=True, blank=True)
+    other_field = models.CharField(max_length=100, default="default_value")
+
+    class Meta:
+        unique_together = [("name", "description")]
+
+    def __str__(self):
+        return f"{self.name} - {self.description or 'No description'}"
+
+
+class UniqueTestModelSerializer(serializers.ModelSerializer):
+    description = serializers.SerializerMethodField()
+
+    class Meta:
+        model = UniqueTestModel
+        fields = ["name", "description", "other_field"]
+
+    def get_description(self, obj):
+        if obj.description:
+            return f"Serialized: {obj.description}"
+        return "Serialized: No description provided"
+
+
 class Issue6110Test(TestCase):
     def test_model_serializer_custom_manager(self):
         instance = Issue6110ModelSerializer().create({'name': 'test_name'})
@@ -1395,3 +1420,68 @@ class Meta:
         serializer.save()
 
         self.assertEqual(instance.char_field, 'value changed by signal')
+
+
+class TestSerializerMethodFieldInUniqueTogether(TestCase):
+    def test_serializer_method_field_not_hidden_in_unique_together(self):
+        """
+        Tests that a SerializerMethodField named the same as a model field
+        in a unique_together constraint is not treated as a HiddenField and
+        that unique_together validation still functions correctly.
+        """
+        serializer = UniqueTestModelSerializer()
+
+        self.assertFalse(
+            isinstance(serializer.fields['description'], serializers.HiddenField),
+            "Field 'description' should not be a HiddenField."
+        )
+        self.assertTrue(
+            isinstance(serializer.fields['description'], serializers.SerializerMethodField),
+            "Field 'description' should be a SerializerMethodField."
+        )
+
+        instance = UniqueTestModel.objects.create(name="TestName", description="TestDesc")
+        serializer_output = UniqueTestModelSerializer(instance).data
+        self.assertIn("description", serializer_output)
+        self.assertEqual(serializer_output["description"], "Serialized: TestDesc")
+
+        instance_no_desc = UniqueTestModel.objects.create(name="TestNameNoDesc")
+        serializer_output_no_desc = UniqueTestModelSerializer(instance_no_desc).data
+        self.assertEqual(serializer_output_no_desc["description"], "Serialized: No description provided")
+
+        UniqueTestModel.objects.create(name="UniqueName", description="UniqueDesc")
+        invalid_data = {"name": "UniqueName", "description": "UniqueDesc", "other_field": "some_value"}
+        serializer_invalid = UniqueTestModelSerializer(data=invalid_data)
+        with self.assertRaises(serializers.ValidationError) as context:
+            serializer_invalid.is_valid(raise_exception=True)
+        self.assertIn("non_field_errors", context.exception.detail)
+        self.assertTrue(any("unique test model with this name and description already exists" in str(err)
+                            for err_list in context.exception.detail.values() for err in err_list))
+
+        UniqueTestModel.objects.create(name="UniqueNameNull", description=None)
+        invalid_data_null = {"name": "UniqueNameNull", "description": None, "other_field": "some_value"}
+        serializer_invalid_null = UniqueTestModelSerializer(data=invalid_data_null)
+        with self.assertRaises(serializers.ValidationError) as context_null:
+            serializer_invalid_null.is_valid(raise_exception=True)
+        self.assertIn("non_field_errors", context_null.exception.detail)
+        self.assertTrue(any("unique test model with this name and description already exists" in str(err)
+                            for err_list in context_null.exception.detail.values() for err in err_list))
+
+        valid_data = {"name": "NewName", "description": "NewDesc", "other_field": "another_value"}
+        serializer_valid = UniqueTestModelSerializer(data=valid_data)
+        self.assertTrue(serializer_valid.is_valid(raise_exception=True))
+        self.assertEqual(serializer_valid.validated_data['name'], "NewName")
+
+        valid_data_no_desc = {"name": "NameOnly"}
+        serializer_valid_no_desc = UniqueTestModelSerializer(data=valid_data_no_desc)
+        self.assertTrue(serializer_valid_no_desc.is_valid(raise_exception=True))
+        self.assertIsNone(serializer_valid_no_desc.validated_data.get('description'))
+        self.assertEqual(serializer_valid_no_desc.validated_data['other_field'], "default_value")
+
+        saved_instance = serializer_valid_no_desc.save()
+        self.assertEqual(saved_instance.name, "NameOnly")
+        self.assertIsNone(saved_instance.description)
+        self.assertEqual(saved_instance.other_field, "default_value")
+
+        output_after_save = UniqueTestModelSerializer(saved_instance).data
+        self.assertEqual(output_after_save['description'], "Serialized: No description provided")