| 1 |
from django.db.models.signals import post_save, pre_save |
| 2 |
from django.test import TestCase |
| 3 |
from django.utils.deprecation import RemovedInDjango60Warning |
| 4 |
|
| 5 |
from .models import Account, Employee, Person, Profile, ProxyEmployee |
| 6 |
|
| 7 |
|
| 8 |
class UpdateOnlyFieldsTests(TestCase): |
| 9 |
msg = ( |
| 10 |
"The following fields do not exist in this model, are m2m " |
| 11 |
"fields, primary keys, or are non-concrete fields: %s" |
| 12 |
) |
| 13 |
|
| 14 |
def test_update_fields_basic(self): |
| 15 |
s = Person.objects.create(name="Sara", gender="F") |
| 16 |
self.assertEqual(s.gender, "F") |
| 17 |
|
| 18 |
s.gender = "M" |
| 19 |
s.name = "Ian" |
| 20 |
s.save(update_fields=["name"]) |
| 21 |
|
| 22 |
s = Person.objects.get(pk=s.pk) |
| 23 |
self.assertEqual(s.gender, "F") |
| 24 |
self.assertEqual(s.name, "Ian") |
| 25 |
|
| 26 |
def test_update_fields_deferred(self): |
| 27 |
s = Person.objects.create(name="Sara", gender="F", pid=22) |
| 28 |
self.assertEqual(s.gender, "F") |
| 29 |
|
| 30 |
s1 = Person.objects.defer("gender", "pid").get(pk=s.pk) |
| 31 |
s1.name = "Emily" |
| 32 |
s1.gender = "M" |
| 33 |
|
| 34 |
with self.assertNumQueries(1): |
| 35 |
s1.save() |
| 36 |
|
| 37 |
s2 = Person.objects.get(pk=s1.pk) |
| 38 |
self.assertEqual(s2.name, "Emily") |
| 39 |
self.assertEqual(s2.gender, "M") |
| 40 |
|
| 41 |
def test_update_fields_only_1(self): |
| 42 |
s = Person.objects.create(name="Sara", gender="F") |
| 43 |
self.assertEqual(s.gender, "F") |
| 44 |
|
| 45 |
s1 = Person.objects.only("name").get(pk=s.pk) |
| 46 |
s1.name = "Emily" |
| 47 |
s1.gender = "M" |
| 48 |
|
| 49 |
with self.assertNumQueries(1): |
| 50 |
s1.save() |
| 51 |
|
| 52 |
s2 = Person.objects.get(pk=s1.pk) |
| 53 |
self.assertEqual(s2.name, "Emily") |
| 54 |
self.assertEqual(s2.gender, "M") |
| 55 |
|
| 56 |
def test_update_fields_only_2(self): |
| 57 |
s = Person.objects.create(name="Sara", gender="F", pid=22) |
| 58 |
self.assertEqual(s.gender, "F") |
| 59 |
|
| 60 |
s1 = Person.objects.only("name").get(pk=s.pk) |
| 61 |
s1.name = "Emily" |
| 62 |
s1.gender = "M" |
| 63 |
|
| 64 |
with self.assertNumQueries(2): |
| 65 |
s1.save(update_fields=["pid"]) |
| 66 |
|
| 67 |
s2 = Person.objects.get(pk=s1.pk) |
| 68 |
self.assertEqual(s2.name, "Sara") |
| 69 |
self.assertEqual(s2.gender, "F") |
| 70 |
|
| 71 |
def test_update_fields_only_repeated(self): |
| 72 |
s = Person.objects.create(name="Sara", gender="F") |
| 73 |
self.assertEqual(s.gender, "F") |
| 74 |
|
| 75 |
s1 = Person.objects.only("name").get(pk=s.pk) |
| 76 |
s1.gender = "M" |
| 77 |
with self.assertNumQueries(1): |
| 78 |
s1.save() |
| 79 |
# save() should not fetch deferred fields |
| 80 |
s1 = Person.objects.only("name").get(pk=s.pk) |
| 81 |
with self.assertNumQueries(1): |
| 82 |
s1.save() |
| 83 |
|
| 84 |
def test_update_fields_inheritance_defer(self): |
| 85 |
profile_boss = Profile.objects.create(name="Boss", salary=3000) |
| 86 |
e1 = Employee.objects.create( |
| 87 |
name="Sara", gender="F", employee_num=1, profile=profile_boss |
| 88 |
) |
| 89 |
e1 = Employee.objects.only("name").get(pk=e1.pk) |
| 90 |
e1.name = "Linda" |
| 91 |
with self.assertNumQueries(1): |
| 92 |
e1.save() |
| 93 |
self.assertEqual(Employee.objects.get(pk=e1.pk).name, "Linda") |
| 94 |
|
| 95 |
def test_update_fields_fk_defer(self): |
| 96 |
profile_boss = Profile.objects.create(name="Boss", salary=3000) |
| 97 |
profile_receptionist = Profile.objects.create(name="Receptionist", salary=1000) |
| 98 |
e1 = Employee.objects.create( |
| 99 |
name="Sara", gender="F", employee_num=1, profile=profile_boss |
| 100 |
) |
| 101 |
e1 = Employee.objects.only("profile").get(pk=e1.pk) |
| 102 |
e1.profile = profile_receptionist |
| 103 |
with self.assertNumQueries(1): |
| 104 |
e1.save() |
| 105 |
self.assertEqual(Employee.objects.get(pk=e1.pk).profile, profile_receptionist) |
| 106 |
e1.profile_id = profile_boss.pk |
| 107 |
with self.assertNumQueries(1): |
| 108 |
e1.save() |
| 109 |
self.assertEqual(Employee.objects.get(pk=e1.pk).profile, profile_boss) |
| 110 |
|
| 111 |
def test_select_related_only_interaction(self): |
| 112 |
profile_boss = Profile.objects.create(name="Boss", salary=3000) |
| 113 |
e1 = Employee.objects.create( |
| 114 |
name="Sara", gender="F", employee_num=1, profile=profile_boss |
| 115 |
) |
| 116 |
e1 = ( |
| 117 |
Employee.objects.only("profile__salary") |
| 118 |
.select_related("profile") |
| 119 |
.get(pk=e1.pk) |
| 120 |
) |
| 121 |
profile_boss.name = "Clerk" |
| 122 |
profile_boss.salary = 1000 |
| 123 |
profile_boss.save() |
| 124 |
# The loaded salary of 3000 gets saved, the name of 'Clerk' isn't |
| 125 |
# overwritten. |
| 126 |
with self.assertNumQueries(1): |
| 127 |
e1.profile.save() |
| 128 |
reloaded_profile = Profile.objects.get(pk=profile_boss.pk) |
| 129 |
self.assertEqual(reloaded_profile.name, profile_boss.name) |
| 130 |
self.assertEqual(reloaded_profile.salary, 3000) |
| 131 |
|
| 132 |
def test_update_fields_m2m(self): |
| 133 |
profile_boss = Profile.objects.create(name="Boss", salary=3000) |
| 134 |
e1 = Employee.objects.create( |
| 135 |
name="Sara", gender="F", employee_num=1, profile=profile_boss |
| 136 |
) |
| 137 |
a1 = Account.objects.create(num=1) |
| 138 |
a2 = Account.objects.create(num=2) |
| 139 |
e1.accounts.set([a1, a2]) |
| 140 |
|
| 141 |
with self.assertRaisesMessage(ValueError, self.msg % "accounts"): |
| 142 |
e1.save(update_fields=["accounts"]) |
| 143 |
|
| 144 |
def test_update_fields_inheritance(self): |
| 145 |
profile_boss = Profile.objects.create(name="Boss", salary=3000) |
| 146 |
profile_receptionist = Profile.objects.create(name="Receptionist", salary=1000) |
| 147 |
e1 = Employee.objects.create( |
| 148 |
name="Sara", gender="F", employee_num=1, profile=profile_boss |
| 149 |
) |
| 150 |
|
| 151 |
e1.name = "Ian" |
| 152 |
e1.gender = "M" |
| 153 |
e1.save(update_fields=["name"]) |
| 154 |
|
| 155 |
e2 = Employee.objects.get(pk=e1.pk) |
| 156 |
self.assertEqual(e2.name, "Ian") |
| 157 |
self.assertEqual(e2.gender, "F") |
| 158 |
self.assertEqual(e2.profile, profile_boss) |
| 159 |
|
| 160 |
e2.profile = profile_receptionist |
| 161 |
e2.name = "Sara" |
| 162 |
e2.save(update_fields=["profile"]) |
| 163 |
|
| 164 |
e3 = Employee.objects.get(pk=e1.pk) |
| 165 |
self.assertEqual(e3.name, "Ian") |
| 166 |
self.assertEqual(e3.profile, profile_receptionist) |
| 167 |
|
| 168 |
with self.assertNumQueries(1): |
| 169 |
e3.profile = profile_boss |
| 170 |
e3.save(update_fields=["profile_id"]) |
| 171 |
|
| 172 |
e4 = Employee.objects.get(pk=e3.pk) |
| 173 |
self.assertEqual(e4.profile, profile_boss) |
| 174 |
self.assertEqual(e4.profile_id, profile_boss.pk) |
| 175 |
|
| 176 |
def test_update_fields_inheritance_with_proxy_model(self): |
| 177 |
profile_boss = Profile.objects.create(name="Boss", salary=3000) |
| 178 |
profile_receptionist = Profile.objects.create(name="Receptionist", salary=1000) |
| 179 |
e1 = ProxyEmployee.objects.create( |
| 180 |
name="Sara", gender="F", employee_num=1, profile=profile_boss |
| 181 |
) |
| 182 |
|
| 183 |
e1.name = "Ian" |
| 184 |
e1.gender = "M" |
| 185 |
e1.save(update_fields=["name"]) |
| 186 |
|
| 187 |
e2 = ProxyEmployee.objects.get(pk=e1.pk) |
| 188 |
self.assertEqual(e2.name, "Ian") |
| 189 |
self.assertEqual(e2.gender, "F") |
| 190 |
self.assertEqual(e2.profile, profile_boss) |
| 191 |
|
| 192 |
e2.profile = profile_receptionist |
| 193 |
e2.name = "Sara" |
| 194 |
e2.save(update_fields=["profile"]) |
| 195 |
|
| 196 |
e3 = ProxyEmployee.objects.get(pk=e1.pk) |
| 197 |
self.assertEqual(e3.name, "Ian") |
| 198 |
self.assertEqual(e3.profile, profile_receptionist) |
| 199 |
|
| 200 |
def test_update_fields_signals(self): |
| 201 |
p = Person.objects.create(name="Sara", gender="F") |
| 202 |
pre_save_data = [] |
| 203 |
|
| 204 |
def pre_save_receiver(**kwargs): |
| 205 |
pre_save_data.append(kwargs["update_fields"]) |
| 206 |
|
| 207 |
pre_save.connect(pre_save_receiver) |
| 208 |
post_save_data = [] |
| 209 |
|
| 210 |
def post_save_receiver(**kwargs): |
| 211 |
post_save_data.append(kwargs["update_fields"]) |
| 212 |
|
| 213 |
post_save.connect(post_save_receiver) |
| 214 |
p.save(update_fields=["name"]) |
| 215 |
self.assertEqual(len(pre_save_data), 1) |
| 216 |
self.assertEqual(len(pre_save_data[0]), 1) |
| 217 |
self.assertIn("name", pre_save_data[0]) |
| 218 |
self.assertEqual(len(post_save_data), 1) |
| 219 |
self.assertEqual(len(post_save_data[0]), 1) |
| 220 |
self.assertIn("name", post_save_data[0]) |
| 221 |
|
| 222 |
pre_save.disconnect(pre_save_receiver) |
| 223 |
post_save.disconnect(post_save_receiver) |
| 224 |
|
| 225 |
def test_update_fields_incorrect_params(self): |
| 226 |
s = Person.objects.create(name="Sara", gender="F") |
| 227 |
|
| 228 |
with self.assertRaisesMessage(ValueError, self.msg % "first_name"): |
| 229 |
s.save(update_fields=["first_name"]) |
| 230 |
|
| 231 |
# "name" is treated as an iterable so the output is something like |
| 232 |
# "n, a, m, e" but the order isn't deterministic. |
| 233 |
with self.assertRaisesMessage(ValueError, self.msg % ""): |
| 234 |
s.save(update_fields="name") |
| 235 |
|
| 236 |
def test_empty_update_fields(self): |
| 237 |
s = Person.objects.create(name="Sara", gender="F") |
| 238 |
pre_save_data = [] |
| 239 |
|
| 240 |
def pre_save_receiver(**kwargs): |
| 241 |
pre_save_data.append(kwargs["update_fields"]) |
| 242 |
|
| 243 |
pre_save.connect(pre_save_receiver) |
| 244 |
post_save_data = [] |
| 245 |
|
| 246 |
def post_save_receiver(**kwargs): |
| 247 |
post_save_data.append(kwargs["update_fields"]) |
| 248 |
|
| 249 |
post_save.connect(post_save_receiver) |
| 250 |
# Save is skipped. |
| 251 |
with self.assertNumQueries(0): |
| 252 |
s.save(update_fields=[]) |
| 253 |
# Signals were skipped, too... |
| 254 |
self.assertEqual(len(pre_save_data), 0) |
| 255 |
self.assertEqual(len(post_save_data), 0) |
| 256 |
|
| 257 |
pre_save.disconnect(pre_save_receiver) |
| 258 |
post_save.disconnect(post_save_receiver) |
| 259 |
|
| 260 |
def test_empty_update_fields_positional_save(self): |
| 261 |
s = Person.objects.create(name="Sara", gender="F") |
| 262 |
|
| 263 |
msg = "Passing positional arguments to save() is deprecated" |
| 264 |
with ( |
| 265 |
self.assertWarnsMessage(RemovedInDjango60Warning, msg) as ctx, |
| 266 |
self.assertNumQueries(0), |
| 267 |
): |
| 268 |
s.save(False, False, None, []) |
| 269 |
self.assertEqual(ctx.filename, __file__) |
| 270 |
|
| 271 |
async def test_empty_update_fields_positional_asave(self): |
| 272 |
s = await Person.objects.acreate(name="Sara", gender="F") |
| 273 |
# Workaround for a lack of async assertNumQueries. |
| 274 |
s.name = "Other" |
| 275 |
|
| 276 |
msg = "Passing positional arguments to asave() is deprecated" |
| 277 |
with self.assertWarnsMessage(RemovedInDjango60Warning, msg) as ctx: |
| 278 |
await s.asave(False, False, None, []) |
| 279 |
self.assertEqual(ctx.filename, __file__) |
| 280 |
|
| 281 |
# No save occurred for an empty update_fields. |
| 282 |
await s.arefresh_from_db() |
| 283 |
self.assertEqual(s.name, "Sara") |
| 284 |
|
| 285 |
def test_num_queries_inheritance(self): |
| 286 |
s = Employee.objects.create(name="Sara", gender="F") |
| 287 |
s.employee_num = 1 |
| 288 |
s.name = "Emily" |
| 289 |
with self.assertNumQueries(1): |
| 290 |
s.save(update_fields=["employee_num"]) |
| 291 |
s = Employee.objects.get(pk=s.pk) |
| 292 |
self.assertEqual(s.employee_num, 1) |
| 293 |
self.assertEqual(s.name, "Sara") |
| 294 |
s.employee_num = 2 |
| 295 |
s.name = "Emily" |
| 296 |
with self.assertNumQueries(1): |
| 297 |
s.save(update_fields=["name"]) |
| 298 |
s = Employee.objects.get(pk=s.pk) |
| 299 |
self.assertEqual(s.name, "Emily") |
| 300 |
self.assertEqual(s.employee_num, 1) |
| 301 |
# A little sanity check that we actually did updates... |
| 302 |
self.assertEqual(Employee.objects.count(), 1) |
| 303 |
self.assertEqual(Person.objects.count(), 1) |
| 304 |
with self.assertNumQueries(2): |
| 305 |
s.save(update_fields=["name", "employee_num"]) |
| 306 |
|
| 307 |
def test_update_non_concrete_field(self): |
| 308 |
profile_boss = Profile.objects.create(name="Boss", salary=3000) |
| 309 |
with self.assertRaisesMessage(ValueError, self.msg % "non_concrete"): |
| 310 |
profile_boss.save(update_fields=["non_concrete"]) |
| 311 |
|
| 312 |
def test_update_pk_field(self): |
| 313 |
person_boss = Person.objects.create(name="Boss", gender="F") |
| 314 |
with self.assertRaisesMessage(ValueError, self.msg % "id"): |
| 315 |
person_boss.save(update_fields=["id"]) |
| 316 |
|
| 317 |
def test_update_inherited_pk_field(self): |
| 318 |
employee_boss = Employee.objects.create(name="Boss", gender="F") |
| 319 |
with self.assertRaisesMessage(ValueError, self.msg % "id"): |
| 320 |
employee_boss.save(update_fields=["id"]) |