tests.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736
  1. import copy
  2. import datetime
  3. import pickle
  4. from operator import attrgetter
  5. from django.core.exceptions import FieldError
  6. from django.db import models
  7. from django.test import SimpleTestCase, TestCase, skipUnlessDBFeature
  8. from django.test.utils import isolate_apps
  9. from django.utils import translation
  10. from django.utils.deprecation import RemovedInDjango60Warning
  11. from .models import (
  12. Article,
  13. ArticleIdea,
  14. ArticleTag,
  15. ArticleTranslation,
  16. Country,
  17. Friendship,
  18. Group,
  19. Membership,
  20. NewsArticle,
  21. Person,
  22. )
  23. # Note that these tests are testing internal implementation details.
  24. # ForeignObject is not part of public API.
  25. class MultiColumnFKTests(TestCase):
  26. @classmethod
  27. def setUpTestData(cls):
  28. # Creating countries
  29. cls.usa = Country.objects.create(name="United States of America")
  30. cls.soviet_union = Country.objects.create(name="Soviet Union")
  31. # Creating People
  32. cls.bob = Person.objects.create(name="Bob", person_country=cls.usa)
  33. cls.jim = Person.objects.create(name="Jim", person_country=cls.usa)
  34. cls.george = Person.objects.create(name="George", person_country=cls.usa)
  35. cls.jane = Person.objects.create(name="Jane", person_country=cls.soviet_union)
  36. cls.mark = Person.objects.create(name="Mark", person_country=cls.soviet_union)
  37. cls.sam = Person.objects.create(name="Sam", person_country=cls.soviet_union)
  38. # Creating Groups
  39. cls.kgb = Group.objects.create(name="KGB", group_country=cls.soviet_union)
  40. cls.cia = Group.objects.create(name="CIA", group_country=cls.usa)
  41. cls.republican = Group.objects.create(name="Republican", group_country=cls.usa)
  42. cls.democrat = Group.objects.create(name="Democrat", group_country=cls.usa)
  43. def test_get_succeeds_on_multicolumn_match(self):
  44. # Membership objects have access to their related Person if both
  45. # country_ids match between them
  46. membership = Membership.objects.create(
  47. membership_country_id=self.usa.id,
  48. person_id=self.bob.id,
  49. group_id=self.cia.id,
  50. )
  51. person = membership.person
  52. self.assertEqual((person.id, person.name), (self.bob.id, "Bob"))
  53. def test_get_fails_on_multicolumn_mismatch(self):
  54. # Membership objects returns DoesNotExist error when there is no
  55. # Person with the same id and country_id
  56. membership = Membership.objects.create(
  57. membership_country_id=self.usa.id,
  58. person_id=self.jane.id,
  59. group_id=self.cia.id,
  60. )
  61. with self.assertRaises(Person.DoesNotExist):
  62. getattr(membership, "person")
  63. def test_reverse_query_returns_correct_result(self):
  64. # Creating a valid membership because it has the same country has the person
  65. Membership.objects.create(
  66. membership_country_id=self.usa.id,
  67. person_id=self.bob.id,
  68. group_id=self.cia.id,
  69. )
  70. # Creating an invalid membership because it has a different country has
  71. # the person.
  72. Membership.objects.create(
  73. membership_country_id=self.soviet_union.id,
  74. person_id=self.bob.id,
  75. group_id=self.republican.id,
  76. )
  77. with self.assertNumQueries(1):
  78. membership = self.bob.membership_set.get()
  79. self.assertEqual(membership.group_id, self.cia.id)
  80. self.assertIs(membership.person, self.bob)
  81. def test_query_filters_correctly(self):
  82. # Creating a to valid memberships
  83. Membership.objects.create(
  84. membership_country_id=self.usa.id,
  85. person_id=self.bob.id,
  86. group_id=self.cia.id,
  87. )
  88. Membership.objects.create(
  89. membership_country_id=self.usa.id,
  90. person_id=self.jim.id,
  91. group_id=self.cia.id,
  92. )
  93. # Creating an invalid membership
  94. Membership.objects.create(
  95. membership_country_id=self.soviet_union.id,
  96. person_id=self.george.id,
  97. group_id=self.cia.id,
  98. )
  99. self.assertQuerySetEqual(
  100. Membership.objects.filter(person__name__contains="o"),
  101. [self.bob.id],
  102. attrgetter("person_id"),
  103. )
  104. def test_reverse_query_filters_correctly(self):
  105. timemark = datetime.datetime.now(tz=datetime.timezone.utc).replace(tzinfo=None)
  106. timedelta = datetime.timedelta(days=1)
  107. # Creating a to valid memberships
  108. Membership.objects.create(
  109. membership_country_id=self.usa.id,
  110. person_id=self.bob.id,
  111. group_id=self.cia.id,
  112. date_joined=timemark - timedelta,
  113. )
  114. Membership.objects.create(
  115. membership_country_id=self.usa.id,
  116. person_id=self.jim.id,
  117. group_id=self.cia.id,
  118. date_joined=timemark + timedelta,
  119. )
  120. # Creating an invalid membership
  121. Membership.objects.create(
  122. membership_country_id=self.soviet_union.id,
  123. person_id=self.george.id,
  124. group_id=self.cia.id,
  125. date_joined=timemark + timedelta,
  126. )
  127. self.assertQuerySetEqual(
  128. Person.objects.filter(membership__date_joined__gte=timemark),
  129. ["Jim"],
  130. attrgetter("name"),
  131. )
  132. def test_forward_in_lookup_filters_correctly(self):
  133. Membership.objects.create(
  134. membership_country_id=self.usa.id,
  135. person_id=self.bob.id,
  136. group_id=self.cia.id,
  137. )
  138. Membership.objects.create(
  139. membership_country_id=self.usa.id,
  140. person_id=self.jim.id,
  141. group_id=self.cia.id,
  142. )
  143. # Creating an invalid membership
  144. Membership.objects.create(
  145. membership_country_id=self.soviet_union.id,
  146. person_id=self.george.id,
  147. group_id=self.cia.id,
  148. )
  149. self.assertQuerySetEqual(
  150. Membership.objects.filter(person__in=[self.george, self.jim]),
  151. [
  152. self.jim.id,
  153. ],
  154. attrgetter("person_id"),
  155. )
  156. self.assertQuerySetEqual(
  157. Membership.objects.filter(person__in=Person.objects.filter(name="Jim")),
  158. [
  159. self.jim.id,
  160. ],
  161. attrgetter("person_id"),
  162. )
  163. def test_double_nested_query(self):
  164. m1 = Membership.objects.create(
  165. membership_country_id=self.usa.id,
  166. person_id=self.bob.id,
  167. group_id=self.cia.id,
  168. )
  169. m2 = Membership.objects.create(
  170. membership_country_id=self.usa.id,
  171. person_id=self.jim.id,
  172. group_id=self.cia.id,
  173. )
  174. Friendship.objects.create(
  175. from_friend_country_id=self.usa.id,
  176. from_friend_id=self.bob.id,
  177. to_friend_country_id=self.usa.id,
  178. to_friend_id=self.jim.id,
  179. )
  180. self.assertSequenceEqual(
  181. Membership.objects.filter(
  182. person__in=Person.objects.filter(
  183. from_friend__in=Friendship.objects.filter(
  184. to_friend__in=Person.objects.all()
  185. )
  186. )
  187. ),
  188. [m1],
  189. )
  190. self.assertSequenceEqual(
  191. Membership.objects.exclude(
  192. person__in=Person.objects.filter(
  193. from_friend__in=Friendship.objects.filter(
  194. to_friend__in=Person.objects.all()
  195. )
  196. )
  197. ),
  198. [m2],
  199. )
  200. def test_select_related_foreignkey_forward_works(self):
  201. Membership.objects.create(
  202. membership_country=self.usa, person=self.bob, group=self.cia
  203. )
  204. Membership.objects.create(
  205. membership_country=self.usa, person=self.jim, group=self.democrat
  206. )
  207. with self.assertNumQueries(1):
  208. people = [
  209. m.person
  210. for m in Membership.objects.select_related("person").order_by("pk")
  211. ]
  212. normal_people = [m.person for m in Membership.objects.order_by("pk")]
  213. self.assertEqual(people, normal_people)
  214. def test_prefetch_foreignkey_forward_works(self):
  215. Membership.objects.create(
  216. membership_country=self.usa, person=self.bob, group=self.cia
  217. )
  218. Membership.objects.create(
  219. membership_country=self.usa, person=self.jim, group=self.democrat
  220. )
  221. with self.assertNumQueries(2):
  222. people = [
  223. m.person
  224. for m in Membership.objects.prefetch_related("person").order_by("pk")
  225. ]
  226. normal_people = [m.person for m in Membership.objects.order_by("pk")]
  227. self.assertEqual(people, normal_people)
  228. def test_prefetch_foreignkey_reverse_works(self):
  229. Membership.objects.create(
  230. membership_country=self.usa, person=self.bob, group=self.cia
  231. )
  232. Membership.objects.create(
  233. membership_country=self.usa, person=self.jim, group=self.democrat
  234. )
  235. with self.assertNumQueries(2):
  236. membership_sets = [
  237. list(p.membership_set.all())
  238. for p in Person.objects.prefetch_related("membership_set").order_by(
  239. "pk"
  240. )
  241. ]
  242. with self.assertNumQueries(7):
  243. normal_membership_sets = [
  244. list(p.membership_set.all()) for p in Person.objects.order_by("pk")
  245. ]
  246. self.assertEqual(membership_sets, normal_membership_sets)
  247. def test_m2m_through_forward_returns_valid_members(self):
  248. # We start out by making sure that the Group 'CIA' has no members.
  249. self.assertQuerySetEqual(self.cia.members.all(), [])
  250. Membership.objects.create(
  251. membership_country=self.usa, person=self.bob, group=self.cia
  252. )
  253. Membership.objects.create(
  254. membership_country=self.usa, person=self.jim, group=self.cia
  255. )
  256. # Bob and Jim should be members of the CIA.
  257. self.assertQuerySetEqual(
  258. self.cia.members.all(), ["Bob", "Jim"], attrgetter("name")
  259. )
  260. def test_m2m_through_reverse_returns_valid_members(self):
  261. # We start out by making sure that Bob is in no groups.
  262. self.assertQuerySetEqual(self.bob.groups.all(), [])
  263. Membership.objects.create(
  264. membership_country=self.usa, person=self.bob, group=self.cia
  265. )
  266. Membership.objects.create(
  267. membership_country=self.usa, person=self.bob, group=self.republican
  268. )
  269. # Bob should be in the CIA and a Republican
  270. self.assertQuerySetEqual(
  271. self.bob.groups.all(), ["CIA", "Republican"], attrgetter("name")
  272. )
  273. def test_m2m_through_forward_ignores_invalid_members(self):
  274. # We start out by making sure that the Group 'CIA' has no members.
  275. self.assertQuerySetEqual(self.cia.members.all(), [])
  276. # Something adds jane to group CIA but Jane is in Soviet Union which
  277. # isn't CIA's country.
  278. Membership.objects.create(
  279. membership_country=self.usa, person=self.jane, group=self.cia
  280. )
  281. # There should still be no members in CIA
  282. self.assertQuerySetEqual(self.cia.members.all(), [])
  283. def test_m2m_through_reverse_ignores_invalid_members(self):
  284. # We start out by making sure that Jane has no groups.
  285. self.assertQuerySetEqual(self.jane.groups.all(), [])
  286. # Something adds jane to group CIA but Jane is in Soviet Union which
  287. # isn't CIA's country.
  288. Membership.objects.create(
  289. membership_country=self.usa, person=self.jane, group=self.cia
  290. )
  291. # Jane should still not be in any groups
  292. self.assertQuerySetEqual(self.jane.groups.all(), [])
  293. def test_m2m_through_on_self_works(self):
  294. self.assertQuerySetEqual(self.jane.friends.all(), [])
  295. Friendship.objects.create(
  296. from_friend_country=self.jane.person_country,
  297. from_friend=self.jane,
  298. to_friend_country=self.george.person_country,
  299. to_friend=self.george,
  300. )
  301. self.assertQuerySetEqual(
  302. self.jane.friends.all(), ["George"], attrgetter("name")
  303. )
  304. def test_m2m_through_on_self_ignores_mismatch_columns(self):
  305. self.assertQuerySetEqual(self.jane.friends.all(), [])
  306. # Note that we use ids instead of instances. This is because instances
  307. # on ForeignObject properties will set all related field off of the
  308. # given instance.
  309. Friendship.objects.create(
  310. from_friend_id=self.jane.id,
  311. to_friend_id=self.george.id,
  312. to_friend_country_id=self.jane.person_country_id,
  313. from_friend_country_id=self.george.person_country_id,
  314. )
  315. self.assertQuerySetEqual(self.jane.friends.all(), [])
  316. def test_prefetch_related_m2m_forward_works(self):
  317. Membership.objects.create(
  318. membership_country=self.usa, person=self.bob, group=self.cia
  319. )
  320. Membership.objects.create(
  321. membership_country=self.usa, person=self.jim, group=self.democrat
  322. )
  323. with self.assertNumQueries(2):
  324. members_lists = [
  325. list(g.members.all()) for g in Group.objects.prefetch_related("members")
  326. ]
  327. normal_members_lists = [list(g.members.all()) for g in Group.objects.all()]
  328. self.assertEqual(members_lists, normal_members_lists)
  329. def test_prefetch_related_m2m_reverse_works(self):
  330. Membership.objects.create(
  331. membership_country=self.usa, person=self.bob, group=self.cia
  332. )
  333. Membership.objects.create(
  334. membership_country=self.usa, person=self.jim, group=self.democrat
  335. )
  336. with self.assertNumQueries(2):
  337. groups_lists = [
  338. list(p.groups.all()) for p in Person.objects.prefetch_related("groups")
  339. ]
  340. normal_groups_lists = [list(p.groups.all()) for p in Person.objects.all()]
  341. self.assertEqual(groups_lists, normal_groups_lists)
  342. @translation.override("fi")
  343. def test_translations(self):
  344. a1 = Article.objects.create(pub_date=datetime.date.today())
  345. at1_fi = ArticleTranslation(
  346. article=a1, lang="fi", title="Otsikko", body="Diipadaapa"
  347. )
  348. at1_fi.save()
  349. at2_en = ArticleTranslation(
  350. article=a1, lang="en", title="Title", body="Lalalalala"
  351. )
  352. at2_en.save()
  353. self.assertEqual(Article.objects.get(pk=a1.pk).active_translation, at1_fi)
  354. with self.assertNumQueries(1):
  355. fetched = Article.objects.select_related("active_translation").get(
  356. active_translation__title="Otsikko"
  357. )
  358. self.assertEqual(fetched.active_translation.title, "Otsikko")
  359. a2 = Article.objects.create(pub_date=datetime.date.today())
  360. at2_fi = ArticleTranslation(
  361. article=a2, lang="fi", title="Atsikko", body="Diipadaapa", abstract="dipad"
  362. )
  363. at2_fi.save()
  364. a3 = Article.objects.create(pub_date=datetime.date.today())
  365. at3_en = ArticleTranslation(
  366. article=a3, lang="en", title="A title", body="lalalalala", abstract="lala"
  367. )
  368. at3_en.save()
  369. # Test model initialization with active_translation field.
  370. a3 = Article(id=a3.id, pub_date=a3.pub_date, active_translation=at3_en)
  371. a3.save()
  372. self.assertEqual(
  373. list(Article.objects.filter(active_translation__abstract=None)), [a1, a3]
  374. )
  375. self.assertEqual(
  376. list(
  377. Article.objects.filter(
  378. active_translation__abstract=None,
  379. active_translation__pk__isnull=False,
  380. )
  381. ),
  382. [a1],
  383. )
  384. with translation.override("en"):
  385. self.assertEqual(
  386. list(Article.objects.filter(active_translation__abstract=None)),
  387. [a1, a2],
  388. )
  389. def test_foreign_key_raises_informative_does_not_exist(self):
  390. referrer = ArticleTranslation()
  391. with self.assertRaisesMessage(
  392. Article.DoesNotExist, "ArticleTranslation has no article"
  393. ):
  394. referrer.article
  395. def test_foreign_key_related_query_name(self):
  396. a1 = Article.objects.create(pub_date=datetime.date.today())
  397. ArticleTag.objects.create(article=a1, name="foo")
  398. self.assertEqual(Article.objects.filter(tag__name="foo").count(), 1)
  399. self.assertEqual(Article.objects.filter(tag__name="bar").count(), 0)
  400. msg = (
  401. "Cannot resolve keyword 'tags' into field. Choices are: "
  402. "active_translation, active_translation_q, articletranslation, "
  403. "id, idea_things, newsarticle, pub_date, tag"
  404. )
  405. with self.assertRaisesMessage(FieldError, msg):
  406. Article.objects.filter(tags__name="foo")
  407. def test_many_to_many_related_query_name(self):
  408. a1 = Article.objects.create(pub_date=datetime.date.today())
  409. i1 = ArticleIdea.objects.create(name="idea1")
  410. a1.ideas.add(i1)
  411. self.assertEqual(Article.objects.filter(idea_things__name="idea1").count(), 1)
  412. self.assertEqual(Article.objects.filter(idea_things__name="idea2").count(), 0)
  413. msg = (
  414. "Cannot resolve keyword 'ideas' into field. Choices are: "
  415. "active_translation, active_translation_q, articletranslation, "
  416. "id, idea_things, newsarticle, pub_date, tag"
  417. )
  418. with self.assertRaisesMessage(FieldError, msg):
  419. Article.objects.filter(ideas__name="idea1")
  420. @translation.override("fi")
  421. def test_inheritance(self):
  422. na = NewsArticle.objects.create(pub_date=datetime.date.today())
  423. ArticleTranslation.objects.create(
  424. article=na, lang="fi", title="foo", body="bar"
  425. )
  426. self.assertSequenceEqual(
  427. NewsArticle.objects.select_related("active_translation"), [na]
  428. )
  429. with self.assertNumQueries(1):
  430. self.assertEqual(
  431. NewsArticle.objects.select_related("active_translation")[
  432. 0
  433. ].active_translation.title,
  434. "foo",
  435. )
  436. @skipUnlessDBFeature("has_bulk_insert")
  437. def test_batch_create_foreign_object(self):
  438. objs = [
  439. Person(name="abcd_%s" % i, person_country=self.usa) for i in range(0, 5)
  440. ]
  441. Person.objects.bulk_create(objs, 10)
  442. def test_isnull_lookup(self):
  443. m1 = Membership.objects.create(
  444. membership_country=self.usa, person=self.bob, group_id=None
  445. )
  446. m2 = Membership.objects.create(
  447. membership_country=self.usa, person=self.bob, group=self.cia
  448. )
  449. self.assertSequenceEqual(
  450. Membership.objects.filter(group__isnull=True),
  451. [m1],
  452. )
  453. self.assertSequenceEqual(
  454. Membership.objects.filter(group__isnull=False),
  455. [m2],
  456. )
  457. class TestModelCheckTests(SimpleTestCase):
  458. @isolate_apps("foreign_object")
  459. def test_check_composite_foreign_object(self):
  460. class Parent(models.Model):
  461. a = models.PositiveIntegerField()
  462. b = models.PositiveIntegerField()
  463. class Meta:
  464. unique_together = (("a", "b"),)
  465. class Child(models.Model):
  466. a = models.PositiveIntegerField()
  467. b = models.PositiveIntegerField()
  468. value = models.CharField(max_length=255)
  469. parent = models.ForeignObject(
  470. Parent,
  471. on_delete=models.SET_NULL,
  472. from_fields=("a", "b"),
  473. to_fields=("a", "b"),
  474. related_name="children",
  475. )
  476. self.assertEqual(Child._meta.get_field("parent").check(from_model=Child), [])
  477. @isolate_apps("foreign_object")
  478. def test_check_subset_composite_foreign_object(self):
  479. class Parent(models.Model):
  480. a = models.PositiveIntegerField()
  481. b = models.PositiveIntegerField()
  482. c = models.PositiveIntegerField()
  483. class Meta:
  484. unique_together = (("a", "b"),)
  485. class Child(models.Model):
  486. a = models.PositiveIntegerField()
  487. b = models.PositiveIntegerField()
  488. c = models.PositiveIntegerField()
  489. d = models.CharField(max_length=255)
  490. parent = models.ForeignObject(
  491. Parent,
  492. on_delete=models.SET_NULL,
  493. from_fields=("a", "b", "c"),
  494. to_fields=("a", "b", "c"),
  495. related_name="children",
  496. )
  497. self.assertEqual(Child._meta.get_field("parent").check(from_model=Child), [])
  498. class TestExtraJoinFilterQ(TestCase):
  499. @translation.override("fi")
  500. def test_extra_join_filter_q(self):
  501. a = Article.objects.create(pub_date=datetime.datetime.today())
  502. ArticleTranslation.objects.create(
  503. article=a, lang="fi", title="title", body="body"
  504. )
  505. qs = Article.objects.all()
  506. with self.assertNumQueries(2):
  507. self.assertEqual(qs[0].active_translation_q.title, "title")
  508. qs = qs.select_related("active_translation_q")
  509. with self.assertNumQueries(1):
  510. self.assertEqual(qs[0].active_translation_q.title, "title")
  511. class TestCachedPathInfo(TestCase):
  512. def test_equality(self):
  513. """
  514. The path_infos and reverse_path_infos attributes are equivalent to
  515. calling the get_<method>() with no arguments.
  516. """
  517. foreign_object = Membership._meta.get_field("person")
  518. self.assertEqual(
  519. foreign_object.path_infos,
  520. foreign_object.get_path_info(),
  521. )
  522. self.assertEqual(
  523. foreign_object.reverse_path_infos,
  524. foreign_object.get_reverse_path_info(),
  525. )
  526. def test_copy_removes_direct_cached_values(self):
  527. """
  528. Shallow copying a ForeignObject (or a ForeignObjectRel) removes the
  529. object's direct cached PathInfo values.
  530. """
  531. foreign_object = Membership._meta.get_field("person")
  532. # Trigger storage of cached_property into ForeignObject's __dict__.
  533. foreign_object.path_infos
  534. foreign_object.reverse_path_infos
  535. # The ForeignObjectRel doesn't have reverse_path_infos.
  536. foreign_object.remote_field.path_infos
  537. self.assertIn("path_infos", foreign_object.__dict__)
  538. self.assertIn("reverse_path_infos", foreign_object.__dict__)
  539. self.assertIn("path_infos", foreign_object.remote_field.__dict__)
  540. # Cached value is removed via __getstate__() on ForeignObjectRel
  541. # because no __copy__() method exists, so __reduce_ex__() is used.
  542. remote_field_copy = copy.copy(foreign_object.remote_field)
  543. self.assertNotIn("path_infos", remote_field_copy.__dict__)
  544. # Cached values are removed via __copy__() on ForeignObject for
  545. # consistency of behavior.
  546. foreign_object_copy = copy.copy(foreign_object)
  547. self.assertNotIn("path_infos", foreign_object_copy.__dict__)
  548. self.assertNotIn("reverse_path_infos", foreign_object_copy.__dict__)
  549. # ForeignObjectRel's remains because it's part of a shallow copy.
  550. self.assertIn("path_infos", foreign_object_copy.remote_field.__dict__)
  551. def test_deepcopy_removes_cached_values(self):
  552. """
  553. Deep copying a ForeignObject removes the object's cached PathInfo
  554. values, including those of the related ForeignObjectRel.
  555. """
  556. foreign_object = Membership._meta.get_field("person")
  557. # Trigger storage of cached_property into ForeignObject's __dict__.
  558. foreign_object.path_infos
  559. foreign_object.reverse_path_infos
  560. # The ForeignObjectRel doesn't have reverse_path_infos.
  561. foreign_object.remote_field.path_infos
  562. self.assertIn("path_infos", foreign_object.__dict__)
  563. self.assertIn("reverse_path_infos", foreign_object.__dict__)
  564. self.assertIn("path_infos", foreign_object.remote_field.__dict__)
  565. # Cached value is removed via __getstate__() on ForeignObjectRel
  566. # because no __deepcopy__() method exists, so __reduce_ex__() is used.
  567. remote_field_copy = copy.deepcopy(foreign_object.remote_field)
  568. self.assertNotIn("path_infos", remote_field_copy.__dict__)
  569. # Field.__deepcopy__() internally uses __copy__() on both the
  570. # ForeignObject and ForeignObjectRel, so all cached values are removed.
  571. foreign_object_copy = copy.deepcopy(foreign_object)
  572. self.assertNotIn("path_infos", foreign_object_copy.__dict__)
  573. self.assertNotIn("reverse_path_infos", foreign_object_copy.__dict__)
  574. self.assertNotIn("path_infos", foreign_object_copy.remote_field.__dict__)
  575. def test_pickling_foreignobjectrel(self):
  576. """
  577. Pickling a ForeignObjectRel removes the path_infos attribute.
  578. ForeignObjectRel implements __getstate__(), so copy and pickle modules
  579. both use that, but ForeignObject implements __reduce__() and __copy__()
  580. separately, so doesn't share the same behaviour.
  581. """
  582. foreign_object_rel = Membership._meta.get_field("person").remote_field
  583. # Trigger storage of cached_property into ForeignObjectRel's __dict__.
  584. foreign_object_rel.path_infos
  585. self.assertIn("path_infos", foreign_object_rel.__dict__)
  586. foreign_object_rel_restored = pickle.loads(pickle.dumps(foreign_object_rel))
  587. self.assertNotIn("path_infos", foreign_object_rel_restored.__dict__)
  588. def test_pickling_foreignobject(self):
  589. """
  590. Pickling a ForeignObject does not remove the cached PathInfo values.
  591. ForeignObject will always keep the path_infos and reverse_path_infos
  592. attributes within the same process, because of the way
  593. Field.__reduce__() is used for restoring values.
  594. """
  595. foreign_object = Membership._meta.get_field("person")
  596. # Trigger storage of cached_property into ForeignObjectRel's __dict__
  597. foreign_object.path_infos
  598. foreign_object.reverse_path_infos
  599. self.assertIn("path_infos", foreign_object.__dict__)
  600. self.assertIn("reverse_path_infos", foreign_object.__dict__)
  601. foreign_object_restored = pickle.loads(pickle.dumps(foreign_object))
  602. self.assertIn("path_infos", foreign_object_restored.__dict__)
  603. self.assertIn("reverse_path_infos", foreign_object_restored.__dict__)
  604. class GetJoiningDeprecationTests(TestCase):
  605. def test_foreign_object_get_joining_columns_warning(self):
  606. msg = (
  607. "ForeignObject.get_joining_columns() is deprecated. Use "
  608. "get_joining_fields() instead."
  609. )
  610. with self.assertWarnsMessage(RemovedInDjango60Warning, msg):
  611. Membership.person.field.get_joining_columns()
  612. def test_foreign_object_get_reverse_joining_columns_warning(self):
  613. msg = (
  614. "ForeignObject.get_reverse_joining_columns() is deprecated. Use "
  615. "get_reverse_joining_fields() instead."
  616. )
  617. with self.assertWarnsMessage(RemovedInDjango60Warning, msg):
  618. Membership.person.field.get_reverse_joining_columns()
  619. def test_foreign_object_rel_get_joining_columns_warning(self):
  620. msg = (
  621. "ForeignObjectRel.get_joining_columns() is deprecated. Use "
  622. "get_joining_fields() instead."
  623. )
  624. with self.assertWarnsMessage(RemovedInDjango60Warning, msg):
  625. Membership.person.field.remote_field.get_joining_columns()
  626. def test_join_get_joining_columns_warning(self):
  627. class CustomForeignKey(models.ForeignKey):
  628. def __getattribute__(self, attr):
  629. if attr == "get_joining_fields":
  630. raise AttributeError
  631. return super().__getattribute__(attr)
  632. class CustomParent(models.Model):
  633. value = models.CharField(max_length=255)
  634. class CustomChild(models.Model):
  635. links = CustomForeignKey(CustomParent, models.CASCADE)
  636. msg = (
  637. "The usage of get_joining_columns() in Join is deprecated. Implement "
  638. "get_joining_fields() instead."
  639. )
  640. with self.assertWarnsMessage(RemovedInDjango60Warning, msg):
  641. CustomChild.objects.filter(links__value="value")