summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVIZZARD-X <vigneshanandmay13@gmail.com>2025-12-27 13:54:14 +0530
committerJacob Walls <jacobtylerwalls@gmail.com>2026-02-26 07:46:35 -0500
commite6108b7388775f4996a5906e0525fbdd40d2df51 (patch)
treecc84128dc376980dac983f369193d3f3309f530f
parentf991a1883889a520679fe41112281435581211e1 (diff)
Fixed #36750 -- Made ordering of M2M objects deterministic in serializers.
Co-authored-by: Simon Charette <charette.s@gmail.com> Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
-rw-r--r--django/core/serializers/python.py17
-rw-r--r--django/core/serializers/xml_serializer.py17
-rw-r--r--tests/serializers/test_natural.py23
3 files changed, 54 insertions, 3 deletions
diff --git a/django/core/serializers/python.py b/django/core/serializers/python.py
index 53a73e19e5..73ba24368b 100644
--- a/django/core/serializers/python.py
+++ b/django/core/serializers/python.py
@@ -77,7 +77,15 @@ class Serializer(base.Serializer):
chunk_size = (
2000 if getattr(attr, "prefetch_cache_name", None) else None
)
- return attr.iterator(chunk_size)
+ query_set = attr.all()
+ if not query_set.totally_ordered:
+ current_ordering = (
+ query_set.query.order_by
+ or query_set.model._meta.ordering
+ or []
+ )
+ query_set = query_set.order_by(*current_ordering, "pk")
+ return query_set.iterator(chunk_size)
else:
@@ -86,6 +94,13 @@ class Serializer(base.Serializer):
def queryset_iterator(obj, field):
query_set = getattr(obj, field.name).select_related(None).only("pk")
+ if not query_set.totally_ordered:
+ current_ordering = (
+ query_set.query.order_by
+ or query_set.model._meta.ordering
+ or []
+ )
+ query_set = query_set.order_by(*current_ordering, "pk")
chunk_size = 2000 if query_set._prefetch_related_lookups else None
return query_set.iterator(chunk_size=chunk_size)
diff --git a/django/core/serializers/xml_serializer.py b/django/core/serializers/xml_serializer.py
index d8ffbdf00a..3d1f79ea0d 100644
--- a/django/core/serializers/xml_serializer.py
+++ b/django/core/serializers/xml_serializer.py
@@ -177,7 +177,15 @@ class Serializer(base.Serializer):
chunk_size = (
2000 if getattr(attr, "prefetch_cache_name", None) else None
)
- return attr.iterator(chunk_size)
+ query_set = attr.all()
+ if not query_set.totally_ordered:
+ current_ordering = (
+ query_set.query.order_by
+ or query_set.model._meta.ordering
+ or []
+ )
+ query_set = query_set.order_by(*current_ordering, "pk")
+ return query_set.iterator(chunk_size)
else:
@@ -186,6 +194,13 @@ class Serializer(base.Serializer):
def queryset_iterator(obj, field):
query_set = getattr(obj, field.name).select_related(None).only("pk")
+ if not query_set.totally_ordered:
+ current_ordering = (
+ query_set.query.order_by
+ or query_set.model._meta.ordering
+ or []
+ )
+ query_set = query_set.order_by(*current_ordering, "pk")
chunk_size = 2000 if query_set._prefetch_related_lookups else None
return query_set.iterator(chunk_size=chunk_size)
diff --git a/tests/serializers/test_natural.py b/tests/serializers/test_natural.py
index b405dc3e28..4dff100cc7 100644
--- a/tests/serializers/test_natural.py
+++ b/tests/serializers/test_natural.py
@@ -1,5 +1,7 @@
+from unittest import mock
+
from django.core import serializers
-from django.db import connection
+from django.db import connection, models
from django.test import TestCase
from .models import (
@@ -336,6 +338,20 @@ def nullable_natural_key_m2m_test(self, format):
)
+def natural_key_m2m_totally_ordered_test(self, format):
+ t1 = NaturalKeyThing.objects.create(key="t1")
+ t2 = NaturalKeyThing.objects.create(key="t2")
+ t3 = NaturalKeyThing.objects.create(key="t3")
+ t1.other_things.add(t2, t3)
+
+ with mock.patch.object(models.QuerySet, "order_by") as mock_order_by:
+ serializers.serialize(format, [t1], use_natural_foreign_keys=True)
+ mock_order_by.assert_called_once_with("pk")
+ mock_order_by.reset_mock()
+ serializers.serialize(format, [t1], use_natural_foreign_keys=False)
+ mock_order_by.assert_called_once_with("pk")
+
+
# Dynamically register tests for each serializer
register_tests(
NaturalKeySerializerTests,
@@ -385,3 +401,8 @@ register_tests(
"test_%s_nullable_natural_key_m2m",
nullable_natural_key_m2m_test,
)
+register_tests(
+ NaturalKeySerializerTests,
+ "test_%s_natural_key_m2m_totally_ordered",
+ natural_key_m2m_totally_ordered_test,
+)