| 1 |
from django.db import connection |
| 2 |
from django.db.models import CharField, F, Max |
| 3 |
from django.db.models.functions import Lower |
| 4 |
from django.test import TestCase, skipUnlessDBFeature |
| 5 |
from django.test.utils import register_lookup |
| 6 |
|
| 7 |
from .models import Celebrity, Fan, Staff, StaffTag, Tag |
| 8 |
|
| 9 |
|
| 10 |
@skipUnlessDBFeature("can_distinct_on_fields") |
| 11 |
@skipUnlessDBFeature("supports_nullable_unique_constraints") |
| 12 |
class DistinctOnTests(TestCase): |
| 13 |
@classmethod |
| 14 |
def setUpTestData(cls): |
| 15 |
cls.t1 = Tag.objects.create(name="t1") |
| 16 |
cls.t2 = Tag.objects.create(name="t2", parent=cls.t1) |
| 17 |
cls.t3 = Tag.objects.create(name="t3", parent=cls.t1) |
| 18 |
cls.t4 = Tag.objects.create(name="t4", parent=cls.t3) |
| 19 |
cls.t5 = Tag.objects.create(name="t5", parent=cls.t3) |
| 20 |
|
| 21 |
cls.p1_o1 = Staff.objects.create(id=1, name="p1", organisation="o1") |
| 22 |
cls.p2_o1 = Staff.objects.create(id=2, name="p2", organisation="o1") |
| 23 |
cls.p3_o1 = Staff.objects.create(id=3, name="p3", organisation="o1") |
| 24 |
cls.p1_o2 = Staff.objects.create(id=4, name="p1", organisation="o2") |
| 25 |
cls.p1_o1.coworkers.add(cls.p2_o1, cls.p3_o1) |
| 26 |
cls.st1 = StaffTag.objects.create(staff=cls.p1_o1, tag=cls.t1) |
| 27 |
StaffTag.objects.create(staff=cls.p1_o1, tag=cls.t1) |
| 28 |
|
| 29 |
cls.celeb1 = Celebrity.objects.create(name="c1") |
| 30 |
cls.celeb2 = Celebrity.objects.create(name="c2") |
| 31 |
|
| 32 |
cls.fan1 = Fan.objects.create(fan_of=cls.celeb1) |
| 33 |
cls.fan2 = Fan.objects.create(fan_of=cls.celeb1) |
| 34 |
cls.fan3 = Fan.objects.create(fan_of=cls.celeb2) |
| 35 |
|
| 36 |
def test_basic_distinct_on(self): |
| 37 |
"""QuerySet.distinct('field', ...) works""" |
| 38 |
# (qset, expected) tuples |
| 39 |
qsets = ( |
| 40 |
( |
| 41 |
Staff.objects.distinct().order_by("name"), |
| 42 |
[self.p1_o1, self.p1_o2, self.p2_o1, self.p3_o1], |
| 43 |
), |
| 44 |
( |
| 45 |
Staff.objects.distinct("name").order_by("name"), |
| 46 |
[self.p1_o1, self.p2_o1, self.p3_o1], |
| 47 |
), |
| 48 |
( |
| 49 |
Staff.objects.distinct("organisation").order_by("organisation", "name"), |
| 50 |
[self.p1_o1, self.p1_o2], |
| 51 |
), |
| 52 |
( |
| 53 |
Staff.objects.distinct("name", "organisation").order_by( |
| 54 |
"name", "organisation" |
| 55 |
), |
| 56 |
[self.p1_o1, self.p1_o2, self.p2_o1, self.p3_o1], |
| 57 |
), |
| 58 |
( |
| 59 |
Celebrity.objects.filter(fan__in=[self.fan1, self.fan2, self.fan3]) |
| 60 |
.distinct("name") |
| 61 |
.order_by("name"), |
| 62 |
[self.celeb1, self.celeb2], |
| 63 |
), |
| 64 |
# Does combining querysets work? |
| 65 |
( |
| 66 |
( |
| 67 |
Celebrity.objects.filter(fan__in=[self.fan1, self.fan2]) |
| 68 |
.distinct("name") |
| 69 |
.order_by("name") |
| 70 |
| Celebrity.objects.filter(fan__in=[self.fan3]) |
| 71 |
.distinct("name") |
| 72 |
.order_by("name") |
| 73 |
), |
| 74 |
[self.celeb1, self.celeb2], |
| 75 |
), |
| 76 |
(StaffTag.objects.distinct("staff", "tag"), [self.st1]), |
| 77 |
( |
| 78 |
Tag.objects.order_by("parent__pk", "pk").distinct("parent"), |
| 79 |
( |
| 80 |
[self.t2, self.t4, self.t1] |
| 81 |
if connection.features.nulls_order_largest |
| 82 |
else [self.t1, self.t2, self.t4] |
| 83 |
), |
| 84 |
), |
| 85 |
( |
| 86 |
StaffTag.objects.select_related("staff") |
| 87 |
.distinct("staff__name") |
| 88 |
.order_by("staff__name"), |
| 89 |
[self.st1], |
| 90 |
), |
| 91 |
# Fetch the alphabetically first coworker for each worker |
| 92 |
( |
| 93 |
( |
| 94 |
Staff.objects.distinct("id") |
| 95 |
.order_by("id", "coworkers__name") |
| 96 |
.values_list("id", "coworkers__name") |
| 97 |
), |
| 98 |
[(1, "p2"), (2, "p1"), (3, "p1"), (4, None)], |
| 99 |
), |
| 100 |
) |
| 101 |
for qset, expected in qsets: |
| 102 |
self.assertSequenceEqual(qset, expected) |
| 103 |
self.assertEqual(qset.count(), len(expected)) |
| 104 |
|
| 105 |
# Combining queries with non-unique query is not allowed. |
| 106 |
base_qs = Celebrity.objects.all() |
| 107 |
msg = "Cannot combine a unique query with a non-unique query." |
| 108 |
with self.assertRaisesMessage(TypeError, msg): |
| 109 |
base_qs.distinct("id") & base_qs |
| 110 |
# Combining queries with different distinct_fields is not allowed. |
| 111 |
msg = "Cannot combine queries with different distinct fields." |
| 112 |
with self.assertRaisesMessage(TypeError, msg): |
| 113 |
base_qs.distinct("id") & base_qs.distinct("name") |
| 114 |
|
| 115 |
# Test join unreffing |
| 116 |
c1 = Celebrity.objects.distinct("greatest_fan__id", "greatest_fan__fan_of") |
| 117 |
self.assertIn("OUTER JOIN", str(c1.query)) |
| 118 |
c2 = c1.distinct("pk") |
| 119 |
self.assertNotIn("OUTER JOIN", str(c2.query)) |
| 120 |
|
| 121 |
def test_sliced_queryset(self): |
| 122 |
msg = "Cannot create distinct fields once a slice has been taken." |
| 123 |
with self.assertRaisesMessage(TypeError, msg): |
| 124 |
Staff.objects.all()[0:5].distinct("name") |
| 125 |
|
| 126 |
def test_transform(self): |
| 127 |
new_name = self.t1.name.upper() |
| 128 |
self.assertNotEqual(self.t1.name, new_name) |
| 129 |
Tag.objects.create(name=new_name) |
| 130 |
with register_lookup(CharField, Lower): |
| 131 |
self.assertCountEqual( |
| 132 |
Tag.objects.order_by().distinct("name__lower"), |
| 133 |
[self.t1, self.t2, self.t3, self.t4, self.t5], |
| 134 |
) |
| 135 |
|
| 136 |
def test_distinct_not_implemented_checks(self): |
| 137 |
# distinct + annotate not allowed |
| 138 |
msg = "annotate() + distinct(fields) is not implemented." |
| 139 |
with self.assertRaisesMessage(NotImplementedError, msg): |
| 140 |
Celebrity.objects.annotate(Max("id")).distinct("id")[0] |
| 141 |
with self.assertRaisesMessage(NotImplementedError, msg): |
| 142 |
Celebrity.objects.distinct("id").annotate(Max("id"))[0] |
| 143 |
|
| 144 |
# However this check is done only when the query executes, so you |
| 145 |
# can use distinct() to remove the fields before execution. |
| 146 |
Celebrity.objects.distinct("id").annotate(Max("id")).distinct()[0] |
| 147 |
# distinct + aggregate not allowed |
| 148 |
msg = "aggregate() + distinct(fields) not implemented." |
| 149 |
with self.assertRaisesMessage(NotImplementedError, msg): |
| 150 |
Celebrity.objects.distinct("id").aggregate(Max("id")) |
| 151 |
|
| 152 |
def test_distinct_on_in_ordered_subquery(self): |
| 153 |
qs = Staff.objects.distinct("name").order_by("name", "id") |
| 154 |
qs = Staff.objects.filter(pk__in=qs).order_by("name") |
| 155 |
self.assertSequenceEqual(qs, [self.p1_o1, self.p2_o1, self.p3_o1]) |
| 156 |
qs = Staff.objects.distinct("name").order_by("name", "-id") |
| 157 |
qs = Staff.objects.filter(pk__in=qs).order_by("name") |
| 158 |
self.assertSequenceEqual(qs, [self.p1_o2, self.p2_o1, self.p3_o1]) |
| 159 |
|
| 160 |
def test_distinct_on_get_ordering_preserved(self): |
| 161 |
""" |
| 162 |
Ordering shouldn't be cleared when distinct on fields are specified. |
| 163 |
refs #25081 |
| 164 |
""" |
| 165 |
staff = ( |
| 166 |
Staff.objects.distinct("name") |
| 167 |
.order_by("name", "-organisation") |
| 168 |
.get(name="p1") |
| 169 |
) |
| 170 |
self.assertEqual(staff.organisation, "o2") |
| 171 |
|
| 172 |
def test_distinct_on_mixed_case_annotation(self): |
| 173 |
qs = ( |
| 174 |
Staff.objects.annotate( |
| 175 |
nAmEAlIaS=F("name"), |
| 176 |
) |
| 177 |
.distinct("nAmEAlIaS") |
| 178 |
.order_by("nAmEAlIaS") |
| 179 |
) |
| 180 |
self.assertSequenceEqual(qs, [self.p1_o1, self.p2_o1, self.p3_o1]) |