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