tests.py 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179
  1. import collections.abc
  2. from datetime import datetime
  3. from math import ceil
  4. from operator import attrgetter
  5. from django.core.exceptions import FieldError
  6. from django.db import connection, models
  7. from django.db.models import (
  8. BooleanField, Case, Exists, ExpressionWrapper, F, Max, OuterRef, Q,
  9. Subquery, Value, When,
  10. )
  11. from django.db.models.functions import Cast, Substr
  12. from django.db.models.lookups import (
  13. Exact, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual,
  14. )
  15. from django.test import TestCase, skipUnlessDBFeature
  16. from django.test.utils import isolate_apps
  17. from .models import (
  18. Article, Author, Freebie, Game, IsNullWithNoneAsRHS, Player, Product,
  19. Season, Stock, Tag,
  20. )
  21. class LookupTests(TestCase):
  22. @classmethod
  23. def setUpTestData(cls):
  24. # Create a few Authors.
  25. cls.au1 = Author.objects.create(name='Author 1', alias='a1')
  26. cls.au2 = Author.objects.create(name='Author 2', alias='a2')
  27. # Create a few Articles.
  28. cls.a1 = Article.objects.create(
  29. headline='Article 1',
  30. pub_date=datetime(2005, 7, 26),
  31. author=cls.au1,
  32. slug='a1',
  33. )
  34. cls.a2 = Article.objects.create(
  35. headline='Article 2',
  36. pub_date=datetime(2005, 7, 27),
  37. author=cls.au1,
  38. slug='a2',
  39. )
  40. cls.a3 = Article.objects.create(
  41. headline='Article 3',
  42. pub_date=datetime(2005, 7, 27),
  43. author=cls.au1,
  44. slug='a3',
  45. )
  46. cls.a4 = Article.objects.create(
  47. headline='Article 4',
  48. pub_date=datetime(2005, 7, 28),
  49. author=cls.au1,
  50. slug='a4',
  51. )
  52. cls.a5 = Article.objects.create(
  53. headline='Article 5',
  54. pub_date=datetime(2005, 8, 1, 9, 0),
  55. author=cls.au2,
  56. slug='a5',
  57. )
  58. cls.a6 = Article.objects.create(
  59. headline='Article 6',
  60. pub_date=datetime(2005, 8, 1, 8, 0),
  61. author=cls.au2,
  62. slug='a6',
  63. )
  64. cls.a7 = Article.objects.create(
  65. headline='Article 7',
  66. pub_date=datetime(2005, 7, 27),
  67. author=cls.au2,
  68. slug='a7',
  69. )
  70. # Create a few Tags.
  71. cls.t1 = Tag.objects.create(name='Tag 1')
  72. cls.t1.articles.add(cls.a1, cls.a2, cls.a3)
  73. cls.t2 = Tag.objects.create(name='Tag 2')
  74. cls.t2.articles.add(cls.a3, cls.a4, cls.a5)
  75. cls.t3 = Tag.objects.create(name='Tag 3')
  76. cls.t3.articles.add(cls.a5, cls.a6, cls.a7)
  77. def test_exists(self):
  78. # We can use .exists() to check that there are some
  79. self.assertTrue(Article.objects.exists())
  80. for a in Article.objects.all():
  81. a.delete()
  82. # There should be none now!
  83. self.assertFalse(Article.objects.exists())
  84. def test_lookup_int_as_str(self):
  85. # Integer value can be queried using string
  86. self.assertSequenceEqual(
  87. Article.objects.filter(id__iexact=str(self.a1.id)),
  88. [self.a1],
  89. )
  90. @skipUnlessDBFeature('supports_date_lookup_using_string')
  91. def test_lookup_date_as_str(self):
  92. # A date lookup can be performed using a string search
  93. self.assertSequenceEqual(
  94. Article.objects.filter(pub_date__startswith='2005'),
  95. [self.a5, self.a6, self.a4, self.a2, self.a3, self.a7, self.a1],
  96. )
  97. def test_iterator(self):
  98. # Each QuerySet gets iterator(), which is a generator that "lazily"
  99. # returns results using database-level iteration.
  100. self.assertIsInstance(Article.objects.iterator(), collections.abc.Iterator)
  101. self.assertQuerysetEqual(
  102. Article.objects.iterator(),
  103. [
  104. 'Article 5',
  105. 'Article 6',
  106. 'Article 4',
  107. 'Article 2',
  108. 'Article 3',
  109. 'Article 7',
  110. 'Article 1',
  111. ],
  112. transform=attrgetter('headline')
  113. )
  114. # iterator() can be used on any QuerySet.
  115. self.assertQuerysetEqual(
  116. Article.objects.filter(headline__endswith='4').iterator(),
  117. ['Article 4'],
  118. transform=attrgetter('headline'))
  119. def test_count(self):
  120. # count() returns the number of objects matching search criteria.
  121. self.assertEqual(Article.objects.count(), 7)
  122. self.assertEqual(Article.objects.filter(pub_date__exact=datetime(2005, 7, 27)).count(), 3)
  123. self.assertEqual(Article.objects.filter(headline__startswith='Blah blah').count(), 0)
  124. # count() should respect sliced query sets.
  125. articles = Article.objects.all()
  126. self.assertEqual(articles.count(), 7)
  127. self.assertEqual(articles[:4].count(), 4)
  128. self.assertEqual(articles[1:100].count(), 6)
  129. self.assertEqual(articles[10:100].count(), 0)
  130. # Date and date/time lookups can also be done with strings.
  131. self.assertEqual(Article.objects.filter(pub_date__exact='2005-07-27 00:00:00').count(), 3)
  132. def test_in_bulk(self):
  133. # in_bulk() takes a list of IDs and returns a dictionary mapping IDs to objects.
  134. arts = Article.objects.in_bulk([self.a1.id, self.a2.id])
  135. self.assertEqual(arts[self.a1.id], self.a1)
  136. self.assertEqual(arts[self.a2.id], self.a2)
  137. self.assertEqual(
  138. Article.objects.in_bulk(),
  139. {
  140. self.a1.id: self.a1,
  141. self.a2.id: self.a2,
  142. self.a3.id: self.a3,
  143. self.a4.id: self.a4,
  144. self.a5.id: self.a5,
  145. self.a6.id: self.a6,
  146. self.a7.id: self.a7,
  147. }
  148. )
  149. self.assertEqual(Article.objects.in_bulk([self.a3.id]), {self.a3.id: self.a3})
  150. self.assertEqual(Article.objects.in_bulk({self.a3.id}), {self.a3.id: self.a3})
  151. self.assertEqual(Article.objects.in_bulk(frozenset([self.a3.id])), {self.a3.id: self.a3})
  152. self.assertEqual(Article.objects.in_bulk((self.a3.id,)), {self.a3.id: self.a3})
  153. self.assertEqual(Article.objects.in_bulk([1000]), {})
  154. self.assertEqual(Article.objects.in_bulk([]), {})
  155. self.assertEqual(Article.objects.in_bulk(iter([self.a1.id])), {self.a1.id: self.a1})
  156. self.assertEqual(Article.objects.in_bulk(iter([])), {})
  157. with self.assertRaises(TypeError):
  158. Article.objects.in_bulk(headline__startswith='Blah')
  159. def test_in_bulk_lots_of_ids(self):
  160. test_range = 2000
  161. max_query_params = connection.features.max_query_params
  162. expected_num_queries = ceil(test_range / max_query_params) if max_query_params else 1
  163. Author.objects.bulk_create([Author() for i in range(test_range - Author.objects.count())])
  164. authors = {author.pk: author for author in Author.objects.all()}
  165. with self.assertNumQueries(expected_num_queries):
  166. self.assertEqual(Author.objects.in_bulk(authors), authors)
  167. def test_in_bulk_with_field(self):
  168. self.assertEqual(
  169. Article.objects.in_bulk([self.a1.slug, self.a2.slug, self.a3.slug], field_name='slug'),
  170. {
  171. self.a1.slug: self.a1,
  172. self.a2.slug: self.a2,
  173. self.a3.slug: self.a3,
  174. }
  175. )
  176. def test_in_bulk_meta_constraint(self):
  177. season_2011 = Season.objects.create(year=2011)
  178. season_2012 = Season.objects.create(year=2012)
  179. Season.objects.create(year=2013)
  180. self.assertEqual(
  181. Season.objects.in_bulk(
  182. [season_2011.year, season_2012.year],
  183. field_name='year',
  184. ),
  185. {season_2011.year: season_2011, season_2012.year: season_2012},
  186. )
  187. def test_in_bulk_non_unique_field(self):
  188. msg = "in_bulk()'s field_name must be a unique field but 'author' isn't."
  189. with self.assertRaisesMessage(ValueError, msg):
  190. Article.objects.in_bulk([self.au1], field_name='author')
  191. @skipUnlessDBFeature('can_distinct_on_fields')
  192. def test_in_bulk_distinct_field(self):
  193. self.assertEqual(
  194. Article.objects.order_by('headline').distinct('headline').in_bulk(
  195. [self.a1.headline, self.a5.headline],
  196. field_name='headline',
  197. ),
  198. {self.a1.headline: self.a1, self.a5.headline: self.a5},
  199. )
  200. @skipUnlessDBFeature('can_distinct_on_fields')
  201. def test_in_bulk_multiple_distinct_field(self):
  202. msg = "in_bulk()'s field_name must be a unique field but 'pub_date' isn't."
  203. with self.assertRaisesMessage(ValueError, msg):
  204. Article.objects.order_by('headline', 'pub_date').distinct(
  205. 'headline', 'pub_date',
  206. ).in_bulk(field_name='pub_date')
  207. @isolate_apps('lookup')
  208. def test_in_bulk_non_unique_meta_constaint(self):
  209. class Model(models.Model):
  210. ean = models.CharField(max_length=100)
  211. brand = models.CharField(max_length=100)
  212. name = models.CharField(max_length=80)
  213. class Meta:
  214. constraints = [
  215. models.UniqueConstraint(
  216. fields=['ean'],
  217. name='partial_ean_unique',
  218. condition=models.Q(is_active=True)
  219. ),
  220. models.UniqueConstraint(
  221. fields=['brand', 'name'],
  222. name='together_brand_name_unique',
  223. ),
  224. ]
  225. msg = "in_bulk()'s field_name must be a unique field but '%s' isn't."
  226. for field_name in ['brand', 'ean']:
  227. with self.subTest(field_name=field_name):
  228. with self.assertRaisesMessage(ValueError, msg % field_name):
  229. Model.objects.in_bulk(field_name=field_name)
  230. def test_in_bulk_sliced_queryset(self):
  231. msg = "Cannot use 'limit' or 'offset' with in_bulk()."
  232. with self.assertRaisesMessage(TypeError, msg):
  233. Article.objects.all()[0:5].in_bulk([self.a1.id, self.a2.id])
  234. def test_values(self):
  235. # values() returns a list of dictionaries instead of object instances --
  236. # and you can specify which fields you want to retrieve.
  237. self.assertSequenceEqual(
  238. Article.objects.values('headline'),
  239. [
  240. {'headline': 'Article 5'},
  241. {'headline': 'Article 6'},
  242. {'headline': 'Article 4'},
  243. {'headline': 'Article 2'},
  244. {'headline': 'Article 3'},
  245. {'headline': 'Article 7'},
  246. {'headline': 'Article 1'},
  247. ],
  248. )
  249. self.assertSequenceEqual(
  250. Article.objects.filter(pub_date__exact=datetime(2005, 7, 27)).values('id'),
  251. [{'id': self.a2.id}, {'id': self.a3.id}, {'id': self.a7.id}],
  252. )
  253. self.assertSequenceEqual(
  254. Article.objects.values('id', 'headline'),
  255. [
  256. {'id': self.a5.id, 'headline': 'Article 5'},
  257. {'id': self.a6.id, 'headline': 'Article 6'},
  258. {'id': self.a4.id, 'headline': 'Article 4'},
  259. {'id': self.a2.id, 'headline': 'Article 2'},
  260. {'id': self.a3.id, 'headline': 'Article 3'},
  261. {'id': self.a7.id, 'headline': 'Article 7'},
  262. {'id': self.a1.id, 'headline': 'Article 1'},
  263. ],
  264. )
  265. # You can use values() with iterator() for memory savings,
  266. # because iterator() uses database-level iteration.
  267. self.assertSequenceEqual(
  268. list(Article.objects.values('id', 'headline').iterator()),
  269. [
  270. {'headline': 'Article 5', 'id': self.a5.id},
  271. {'headline': 'Article 6', 'id': self.a6.id},
  272. {'headline': 'Article 4', 'id': self.a4.id},
  273. {'headline': 'Article 2', 'id': self.a2.id},
  274. {'headline': 'Article 3', 'id': self.a3.id},
  275. {'headline': 'Article 7', 'id': self.a7.id},
  276. {'headline': 'Article 1', 'id': self.a1.id},
  277. ],
  278. )
  279. # The values() method works with "extra" fields specified in extra(select).
  280. self.assertSequenceEqual(
  281. Article.objects.extra(select={'id_plus_one': 'id + 1'}).values('id', 'id_plus_one'),
  282. [
  283. {'id': self.a5.id, 'id_plus_one': self.a5.id + 1},
  284. {'id': self.a6.id, 'id_plus_one': self.a6.id + 1},
  285. {'id': self.a4.id, 'id_plus_one': self.a4.id + 1},
  286. {'id': self.a2.id, 'id_plus_one': self.a2.id + 1},
  287. {'id': self.a3.id, 'id_plus_one': self.a3.id + 1},
  288. {'id': self.a7.id, 'id_plus_one': self.a7.id + 1},
  289. {'id': self.a1.id, 'id_plus_one': self.a1.id + 1},
  290. ],
  291. )
  292. data = {
  293. 'id_plus_one': 'id+1',
  294. 'id_plus_two': 'id+2',
  295. 'id_plus_three': 'id+3',
  296. 'id_plus_four': 'id+4',
  297. 'id_plus_five': 'id+5',
  298. 'id_plus_six': 'id+6',
  299. 'id_plus_seven': 'id+7',
  300. 'id_plus_eight': 'id+8',
  301. }
  302. self.assertSequenceEqual(
  303. Article.objects.filter(id=self.a1.id).extra(select=data).values(*data),
  304. [{
  305. 'id_plus_one': self.a1.id + 1,
  306. 'id_plus_two': self.a1.id + 2,
  307. 'id_plus_three': self.a1.id + 3,
  308. 'id_plus_four': self.a1.id + 4,
  309. 'id_plus_five': self.a1.id + 5,
  310. 'id_plus_six': self.a1.id + 6,
  311. 'id_plus_seven': self.a1.id + 7,
  312. 'id_plus_eight': self.a1.id + 8,
  313. }],
  314. )
  315. # You can specify fields from forward and reverse relations, just like filter().
  316. self.assertSequenceEqual(
  317. Article.objects.values('headline', 'author__name'),
  318. [
  319. {'headline': self.a5.headline, 'author__name': self.au2.name},
  320. {'headline': self.a6.headline, 'author__name': self.au2.name},
  321. {'headline': self.a4.headline, 'author__name': self.au1.name},
  322. {'headline': self.a2.headline, 'author__name': self.au1.name},
  323. {'headline': self.a3.headline, 'author__name': self.au1.name},
  324. {'headline': self.a7.headline, 'author__name': self.au2.name},
  325. {'headline': self.a1.headline, 'author__name': self.au1.name},
  326. ],
  327. )
  328. self.assertSequenceEqual(
  329. Author.objects.values('name', 'article__headline').order_by('name', 'article__headline'),
  330. [
  331. {'name': self.au1.name, 'article__headline': self.a1.headline},
  332. {'name': self.au1.name, 'article__headline': self.a2.headline},
  333. {'name': self.au1.name, 'article__headline': self.a3.headline},
  334. {'name': self.au1.name, 'article__headline': self.a4.headline},
  335. {'name': self.au2.name, 'article__headline': self.a5.headline},
  336. {'name': self.au2.name, 'article__headline': self.a6.headline},
  337. {'name': self.au2.name, 'article__headline': self.a7.headline},
  338. ],
  339. )
  340. self.assertSequenceEqual(
  341. (
  342. Author.objects
  343. .values('name', 'article__headline', 'article__tag__name')
  344. .order_by('name', 'article__headline', 'article__tag__name')
  345. ),
  346. [
  347. {'name': self.au1.name, 'article__headline': self.a1.headline, 'article__tag__name': self.t1.name},
  348. {'name': self.au1.name, 'article__headline': self.a2.headline, 'article__tag__name': self.t1.name},
  349. {'name': self.au1.name, 'article__headline': self.a3.headline, 'article__tag__name': self.t1.name},
  350. {'name': self.au1.name, 'article__headline': self.a3.headline, 'article__tag__name': self.t2.name},
  351. {'name': self.au1.name, 'article__headline': self.a4.headline, 'article__tag__name': self.t2.name},
  352. {'name': self.au2.name, 'article__headline': self.a5.headline, 'article__tag__name': self.t2.name},
  353. {'name': self.au2.name, 'article__headline': self.a5.headline, 'article__tag__name': self.t3.name},
  354. {'name': self.au2.name, 'article__headline': self.a6.headline, 'article__tag__name': self.t3.name},
  355. {'name': self.au2.name, 'article__headline': self.a7.headline, 'article__tag__name': self.t3.name},
  356. ],
  357. )
  358. # However, an exception FieldDoesNotExist will be thrown if you specify
  359. # a nonexistent field name in values() (a field that is neither in the
  360. # model nor in extra(select)).
  361. msg = (
  362. "Cannot resolve keyword 'id_plus_two' into field. Choices are: "
  363. "author, author_id, headline, id, id_plus_one, pub_date, slug, tag"
  364. )
  365. with self.assertRaisesMessage(FieldError, msg):
  366. Article.objects.extra(select={'id_plus_one': 'id + 1'}).values('id', 'id_plus_two')
  367. # If you don't specify field names to values(), all are returned.
  368. self.assertSequenceEqual(
  369. Article.objects.filter(id=self.a5.id).values(),
  370. [{
  371. 'id': self.a5.id,
  372. 'author_id': self.au2.id,
  373. 'headline': 'Article 5',
  374. 'pub_date': datetime(2005, 8, 1, 9, 0),
  375. 'slug': 'a5',
  376. }],
  377. )
  378. def test_values_list(self):
  379. # values_list() is similar to values(), except that the results are
  380. # returned as a list of tuples, rather than a list of dictionaries.
  381. # Within each tuple, the order of the elements is the same as the order
  382. # of fields in the values_list() call.
  383. self.assertSequenceEqual(
  384. Article.objects.values_list('headline'),
  385. [
  386. ('Article 5',),
  387. ('Article 6',),
  388. ('Article 4',),
  389. ('Article 2',),
  390. ('Article 3',),
  391. ('Article 7',),
  392. ('Article 1',),
  393. ],
  394. )
  395. self.assertSequenceEqual(
  396. Article.objects.values_list('id').order_by('id'),
  397. [(self.a1.id,), (self.a2.id,), (self.a3.id,), (self.a4.id,), (self.a5.id,), (self.a6.id,), (self.a7.id,)],
  398. )
  399. self.assertSequenceEqual(
  400. Article.objects.values_list('id', flat=True).order_by('id'),
  401. [self.a1.id, self.a2.id, self.a3.id, self.a4.id, self.a5.id, self.a6.id, self.a7.id],
  402. )
  403. self.assertSequenceEqual(
  404. Article.objects.extra(select={'id_plus_one': 'id+1'}).order_by('id').values_list('id'),
  405. [(self.a1.id,), (self.a2.id,), (self.a3.id,), (self.a4.id,), (self.a5.id,), (self.a6.id,), (self.a7.id,)],
  406. )
  407. self.assertSequenceEqual(
  408. Article.objects.extra(select={'id_plus_one': 'id+1'}).order_by('id').values_list('id_plus_one', 'id'),
  409. [
  410. (self.a1.id + 1, self.a1.id),
  411. (self.a2.id + 1, self.a2.id),
  412. (self.a3.id + 1, self.a3.id),
  413. (self.a4.id + 1, self.a4.id),
  414. (self.a5.id + 1, self.a5.id),
  415. (self.a6.id + 1, self.a6.id),
  416. (self.a7.id + 1, self.a7.id)
  417. ],
  418. )
  419. self.assertSequenceEqual(
  420. Article.objects.extra(select={'id_plus_one': 'id+1'}).order_by('id').values_list('id', 'id_plus_one'),
  421. [
  422. (self.a1.id, self.a1.id + 1),
  423. (self.a2.id, self.a2.id + 1),
  424. (self.a3.id, self.a3.id + 1),
  425. (self.a4.id, self.a4.id + 1),
  426. (self.a5.id, self.a5.id + 1),
  427. (self.a6.id, self.a6.id + 1),
  428. (self.a7.id, self.a7.id + 1)
  429. ],
  430. )
  431. args = ('name', 'article__headline', 'article__tag__name')
  432. self.assertSequenceEqual(
  433. Author.objects.values_list(*args).order_by(*args),
  434. [
  435. (self.au1.name, self.a1.headline, self.t1.name),
  436. (self.au1.name, self.a2.headline, self.t1.name),
  437. (self.au1.name, self.a3.headline, self.t1.name),
  438. (self.au1.name, self.a3.headline, self.t2.name),
  439. (self.au1.name, self.a4.headline, self.t2.name),
  440. (self.au2.name, self.a5.headline, self.t2.name),
  441. (self.au2.name, self.a5.headline, self.t3.name),
  442. (self.au2.name, self.a6.headline, self.t3.name),
  443. (self.au2.name, self.a7.headline, self.t3.name),
  444. ],
  445. )
  446. with self.assertRaises(TypeError):
  447. Article.objects.values_list('id', 'headline', flat=True)
  448. def test_get_next_previous_by(self):
  449. # Every DateField and DateTimeField creates get_next_by_FOO() and
  450. # get_previous_by_FOO() methods. In the case of identical date values,
  451. # these methods will use the ID as a fallback check. This guarantees
  452. # that no records are skipped or duplicated.
  453. self.assertEqual(repr(self.a1.get_next_by_pub_date()), '<Article: Article 2>')
  454. self.assertEqual(repr(self.a2.get_next_by_pub_date()), '<Article: Article 3>')
  455. self.assertEqual(repr(self.a2.get_next_by_pub_date(headline__endswith='6')), '<Article: Article 6>')
  456. self.assertEqual(repr(self.a3.get_next_by_pub_date()), '<Article: Article 7>')
  457. self.assertEqual(repr(self.a4.get_next_by_pub_date()), '<Article: Article 6>')
  458. with self.assertRaises(Article.DoesNotExist):
  459. self.a5.get_next_by_pub_date()
  460. self.assertEqual(repr(self.a6.get_next_by_pub_date()), '<Article: Article 5>')
  461. self.assertEqual(repr(self.a7.get_next_by_pub_date()), '<Article: Article 4>')
  462. self.assertEqual(repr(self.a7.get_previous_by_pub_date()), '<Article: Article 3>')
  463. self.assertEqual(repr(self.a6.get_previous_by_pub_date()), '<Article: Article 4>')
  464. self.assertEqual(repr(self.a5.get_previous_by_pub_date()), '<Article: Article 6>')
  465. self.assertEqual(repr(self.a4.get_previous_by_pub_date()), '<Article: Article 7>')
  466. self.assertEqual(repr(self.a3.get_previous_by_pub_date()), '<Article: Article 2>')
  467. self.assertEqual(repr(self.a2.get_previous_by_pub_date()), '<Article: Article 1>')
  468. def test_escaping(self):
  469. # Underscores, percent signs and backslashes have special meaning in the
  470. # underlying SQL code, but Django handles the quoting of them automatically.
  471. a8 = Article.objects.create(headline='Article_ with underscore', pub_date=datetime(2005, 11, 20))
  472. self.assertSequenceEqual(
  473. Article.objects.filter(headline__startswith='Article'),
  474. [a8, self.a5, self.a6, self.a4, self.a2, self.a3, self.a7, self.a1],
  475. )
  476. self.assertSequenceEqual(
  477. Article.objects.filter(headline__startswith='Article_'),
  478. [a8],
  479. )
  480. a9 = Article.objects.create(headline='Article% with percent sign', pub_date=datetime(2005, 11, 21))
  481. self.assertSequenceEqual(
  482. Article.objects.filter(headline__startswith='Article'),
  483. [a9, a8, self.a5, self.a6, self.a4, self.a2, self.a3, self.a7, self.a1],
  484. )
  485. self.assertSequenceEqual(
  486. Article.objects.filter(headline__startswith='Article%'),
  487. [a9],
  488. )
  489. a10 = Article.objects.create(headline='Article with \\ backslash', pub_date=datetime(2005, 11, 22))
  490. self.assertSequenceEqual(
  491. Article.objects.filter(headline__contains='\\'),
  492. [a10],
  493. )
  494. def test_exclude(self):
  495. pub_date = datetime(2005, 11, 20)
  496. a8 = Article.objects.create(headline='Article_ with underscore', pub_date=pub_date)
  497. a9 = Article.objects.create(headline='Article% with percent sign', pub_date=pub_date)
  498. a10 = Article.objects.create(headline='Article with \\ backslash', pub_date=pub_date)
  499. # exclude() is the opposite of filter() when doing lookups:
  500. self.assertSequenceEqual(
  501. Article.objects.filter(headline__contains='Article').exclude(headline__contains='with'),
  502. [self.a5, self.a6, self.a4, self.a2, self.a3, self.a7, self.a1],
  503. )
  504. self.assertSequenceEqual(
  505. Article.objects.exclude(headline__startswith="Article_"),
  506. [a10, a9, self.a5, self.a6, self.a4, self.a2, self.a3, self.a7, self.a1],
  507. )
  508. self.assertSequenceEqual(
  509. Article.objects.exclude(headline="Article 7"),
  510. [a10, a9, a8, self.a5, self.a6, self.a4, self.a2, self.a3, self.a1],
  511. )
  512. def test_none(self):
  513. # none() returns a QuerySet that behaves like any other QuerySet object
  514. self.assertQuerysetEqual(Article.objects.none(), [])
  515. self.assertQuerysetEqual(Article.objects.none().filter(headline__startswith='Article'), [])
  516. self.assertQuerysetEqual(Article.objects.filter(headline__startswith='Article').none(), [])
  517. self.assertEqual(Article.objects.none().count(), 0)
  518. self.assertEqual(Article.objects.none().update(headline="This should not take effect"), 0)
  519. self.assertQuerysetEqual(Article.objects.none().iterator(), [])
  520. def test_in(self):
  521. self.assertSequenceEqual(
  522. Article.objects.exclude(id__in=[]),
  523. [self.a5, self.a6, self.a4, self.a2, self.a3, self.a7, self.a1],
  524. )
  525. def test_in_empty_list(self):
  526. self.assertSequenceEqual(Article.objects.filter(id__in=[]), [])
  527. def test_in_different_database(self):
  528. with self.assertRaisesMessage(
  529. ValueError,
  530. "Subqueries aren't allowed across different databases. Force the "
  531. "inner query to be evaluated using `list(inner_query)`."
  532. ):
  533. list(Article.objects.filter(id__in=Article.objects.using('other').all()))
  534. def test_in_keeps_value_ordering(self):
  535. query = Article.objects.filter(slug__in=['a%d' % i for i in range(1, 8)]).values('pk').query
  536. self.assertIn(' IN (a1, a2, a3, a4, a5, a6, a7) ', str(query))
  537. def test_in_ignore_none(self):
  538. with self.assertNumQueries(1) as ctx:
  539. self.assertSequenceEqual(
  540. Article.objects.filter(id__in=[None, self.a1.id]),
  541. [self.a1],
  542. )
  543. sql = ctx.captured_queries[0]['sql']
  544. self.assertIn('IN (%s)' % self.a1.pk, sql)
  545. def test_in_ignore_solo_none(self):
  546. with self.assertNumQueries(0):
  547. self.assertSequenceEqual(Article.objects.filter(id__in=[None]), [])
  548. def test_in_ignore_none_with_unhashable_items(self):
  549. class UnhashableInt(int):
  550. __hash__ = None
  551. with self.assertNumQueries(1) as ctx:
  552. self.assertSequenceEqual(
  553. Article.objects.filter(id__in=[None, UnhashableInt(self.a1.id)]),
  554. [self.a1],
  555. )
  556. sql = ctx.captured_queries[0]['sql']
  557. self.assertIn('IN (%s)' % self.a1.pk, sql)
  558. def test_error_messages(self):
  559. # Programming errors are pointed out with nice error messages
  560. with self.assertRaisesMessage(
  561. FieldError,
  562. "Cannot resolve keyword 'pub_date_year' into field. Choices are: "
  563. "author, author_id, headline, id, pub_date, slug, tag"
  564. ):
  565. Article.objects.filter(pub_date_year='2005').count()
  566. def test_unsupported_lookups(self):
  567. with self.assertRaisesMessage(
  568. FieldError,
  569. "Unsupported lookup 'starts' for CharField or join on the field "
  570. "not permitted, perhaps you meant startswith or istartswith?"
  571. ):
  572. Article.objects.filter(headline__starts='Article')
  573. with self.assertRaisesMessage(
  574. FieldError,
  575. "Unsupported lookup 'is_null' for DateTimeField or join on the field "
  576. "not permitted, perhaps you meant isnull?"
  577. ):
  578. Article.objects.filter(pub_date__is_null=True)
  579. with self.assertRaisesMessage(
  580. FieldError,
  581. "Unsupported lookup 'gobbledygook' for DateTimeField or join on the field "
  582. "not permitted."
  583. ):
  584. Article.objects.filter(pub_date__gobbledygook='blahblah')
  585. def test_relation_nested_lookup_error(self):
  586. # An invalid nested lookup on a related field raises a useful error.
  587. msg = 'Related Field got invalid lookup: editor'
  588. with self.assertRaisesMessage(FieldError, msg):
  589. Article.objects.filter(author__editor__name='James')
  590. msg = 'Related Field got invalid lookup: foo'
  591. with self.assertRaisesMessage(FieldError, msg):
  592. Tag.objects.filter(articles__foo='bar')
  593. def test_regex(self):
  594. # Create some articles with a bit more interesting headlines for testing field lookups:
  595. for a in Article.objects.all():
  596. a.delete()
  597. now = datetime.now()
  598. Article.objects.bulk_create([
  599. Article(pub_date=now, headline='f'),
  600. Article(pub_date=now, headline='fo'),
  601. Article(pub_date=now, headline='foo'),
  602. Article(pub_date=now, headline='fooo'),
  603. Article(pub_date=now, headline='hey-Foo'),
  604. Article(pub_date=now, headline='bar'),
  605. Article(pub_date=now, headline='AbBa'),
  606. Article(pub_date=now, headline='baz'),
  607. Article(pub_date=now, headline='baxZ'),
  608. ])
  609. # zero-or-more
  610. self.assertQuerysetEqual(
  611. Article.objects.filter(headline__regex=r'fo*'),
  612. Article.objects.filter(headline__in=['f', 'fo', 'foo', 'fooo']),
  613. )
  614. self.assertQuerysetEqual(
  615. Article.objects.filter(headline__iregex=r'fo*'),
  616. Article.objects.filter(headline__in=['f', 'fo', 'foo', 'fooo', 'hey-Foo']),
  617. )
  618. # one-or-more
  619. self.assertQuerysetEqual(
  620. Article.objects.filter(headline__regex=r'fo+'),
  621. Article.objects.filter(headline__in=['fo', 'foo', 'fooo']),
  622. )
  623. # wildcard
  624. self.assertQuerysetEqual(
  625. Article.objects.filter(headline__regex=r'fooo?'),
  626. Article.objects.filter(headline__in=['foo', 'fooo']),
  627. )
  628. # leading anchor
  629. self.assertQuerysetEqual(
  630. Article.objects.filter(headline__regex=r'^b'),
  631. Article.objects.filter(headline__in=['bar', 'baxZ', 'baz']),
  632. )
  633. self.assertQuerysetEqual(
  634. Article.objects.filter(headline__iregex=r'^a'),
  635. Article.objects.filter(headline='AbBa'),
  636. )
  637. # trailing anchor
  638. self.assertQuerysetEqual(
  639. Article.objects.filter(headline__regex=r'z$'),
  640. Article.objects.filter(headline='baz'),
  641. )
  642. self.assertQuerysetEqual(
  643. Article.objects.filter(headline__iregex=r'z$'),
  644. Article.objects.filter(headline__in=['baxZ', 'baz']),
  645. )
  646. # character sets
  647. self.assertQuerysetEqual(
  648. Article.objects.filter(headline__regex=r'ba[rz]'),
  649. Article.objects.filter(headline__in=['bar', 'baz']),
  650. )
  651. self.assertQuerysetEqual(
  652. Article.objects.filter(headline__regex=r'ba.[RxZ]'),
  653. Article.objects.filter(headline='baxZ'),
  654. )
  655. self.assertQuerysetEqual(
  656. Article.objects.filter(headline__iregex=r'ba[RxZ]'),
  657. Article.objects.filter(headline__in=['bar', 'baxZ', 'baz']),
  658. )
  659. # and more articles:
  660. Article.objects.bulk_create([
  661. Article(pub_date=now, headline='foobar'),
  662. Article(pub_date=now, headline='foobaz'),
  663. Article(pub_date=now, headline='ooF'),
  664. Article(pub_date=now, headline='foobarbaz'),
  665. Article(pub_date=now, headline='zoocarfaz'),
  666. Article(pub_date=now, headline='barfoobaz'),
  667. Article(pub_date=now, headline='bazbaRFOO'),
  668. ])
  669. # alternation
  670. self.assertQuerysetEqual(
  671. Article.objects.filter(headline__regex=r'oo(f|b)'),
  672. Article.objects.filter(headline__in=[
  673. 'barfoobaz',
  674. 'foobar',
  675. 'foobarbaz',
  676. 'foobaz',
  677. ]),
  678. )
  679. self.assertQuerysetEqual(
  680. Article.objects.filter(headline__iregex=r'oo(f|b)'),
  681. Article.objects.filter(headline__in=[
  682. 'barfoobaz',
  683. 'foobar',
  684. 'foobarbaz',
  685. 'foobaz',
  686. 'ooF',
  687. ]),
  688. )
  689. self.assertQuerysetEqual(
  690. Article.objects.filter(headline__regex=r'^foo(f|b)'),
  691. Article.objects.filter(headline__in=['foobar', 'foobarbaz', 'foobaz']),
  692. )
  693. # greedy matching
  694. self.assertQuerysetEqual(
  695. Article.objects.filter(headline__regex=r'b.*az'),
  696. Article.objects.filter(headline__in=[
  697. 'barfoobaz',
  698. 'baz',
  699. 'bazbaRFOO',
  700. 'foobarbaz',
  701. 'foobaz',
  702. ]),
  703. )
  704. self.assertQuerysetEqual(
  705. Article.objects.filter(headline__iregex=r'b.*ar'),
  706. Article.objects.filter(headline__in=[
  707. 'bar',
  708. 'barfoobaz',
  709. 'bazbaRFOO',
  710. 'foobar',
  711. 'foobarbaz',
  712. ]),
  713. )
  714. @skipUnlessDBFeature('supports_regex_backreferencing')
  715. def test_regex_backreferencing(self):
  716. # grouping and backreferences
  717. now = datetime.now()
  718. Article.objects.bulk_create([
  719. Article(pub_date=now, headline='foobar'),
  720. Article(pub_date=now, headline='foobaz'),
  721. Article(pub_date=now, headline='ooF'),
  722. Article(pub_date=now, headline='foobarbaz'),
  723. Article(pub_date=now, headline='zoocarfaz'),
  724. Article(pub_date=now, headline='barfoobaz'),
  725. Article(pub_date=now, headline='bazbaRFOO'),
  726. ])
  727. self.assertQuerysetEqual(
  728. Article.objects.filter(headline__regex=r'b(.).*b\1').values_list('headline', flat=True),
  729. ['barfoobaz', 'bazbaRFOO', 'foobarbaz'],
  730. )
  731. def test_regex_null(self):
  732. """
  733. A regex lookup does not fail on null/None values
  734. """
  735. Season.objects.create(year=2012, gt=None)
  736. self.assertQuerysetEqual(Season.objects.filter(gt__regex=r'^$'), [])
  737. def test_regex_non_string(self):
  738. """
  739. A regex lookup does not fail on non-string fields
  740. """
  741. s = Season.objects.create(year=2013, gt=444)
  742. self.assertQuerysetEqual(Season.objects.filter(gt__regex=r'^444$'), [s])
  743. def test_regex_non_ascii(self):
  744. """
  745. A regex lookup does not trip on non-ASCII characters.
  746. """
  747. Player.objects.create(name='\u2660')
  748. Player.objects.get(name__regex='\u2660')
  749. def test_nonfield_lookups(self):
  750. """
  751. A lookup query containing non-fields raises the proper exception.
  752. """
  753. msg = "Unsupported lookup 'blahblah' for CharField or join on the field not permitted."
  754. with self.assertRaisesMessage(FieldError, msg):
  755. Article.objects.filter(headline__blahblah=99)
  756. with self.assertRaisesMessage(FieldError, msg):
  757. Article.objects.filter(headline__blahblah__exact=99)
  758. msg = (
  759. "Cannot resolve keyword 'blahblah' into field. Choices are: "
  760. "author, author_id, headline, id, pub_date, slug, tag"
  761. )
  762. with self.assertRaisesMessage(FieldError, msg):
  763. Article.objects.filter(blahblah=99)
  764. def test_lookup_collision(self):
  765. """
  766. Genuine field names don't collide with built-in lookup types
  767. ('year', 'gt', 'range', 'in' etc.) (#11670).
  768. """
  769. # 'gt' is used as a code number for the year, e.g. 111=>2009.
  770. season_2009 = Season.objects.create(year=2009, gt=111)
  771. season_2009.games.create(home="Houston Astros", away="St. Louis Cardinals")
  772. season_2010 = Season.objects.create(year=2010, gt=222)
  773. season_2010.games.create(home="Houston Astros", away="Chicago Cubs")
  774. season_2010.games.create(home="Houston Astros", away="Milwaukee Brewers")
  775. season_2010.games.create(home="Houston Astros", away="St. Louis Cardinals")
  776. season_2011 = Season.objects.create(year=2011, gt=333)
  777. season_2011.games.create(home="Houston Astros", away="St. Louis Cardinals")
  778. season_2011.games.create(home="Houston Astros", away="Milwaukee Brewers")
  779. hunter_pence = Player.objects.create(name="Hunter Pence")
  780. hunter_pence.games.set(Game.objects.filter(season__year__in=[2009, 2010]))
  781. pudge = Player.objects.create(name="Ivan Rodriquez")
  782. pudge.games.set(Game.objects.filter(season__year=2009))
  783. pedro_feliz = Player.objects.create(name="Pedro Feliz")
  784. pedro_feliz.games.set(Game.objects.filter(season__year__in=[2011]))
  785. johnson = Player.objects.create(name="Johnson")
  786. johnson.games.set(Game.objects.filter(season__year__in=[2011]))
  787. # Games in 2010
  788. self.assertEqual(Game.objects.filter(season__year=2010).count(), 3)
  789. self.assertEqual(Game.objects.filter(season__year__exact=2010).count(), 3)
  790. self.assertEqual(Game.objects.filter(season__gt=222).count(), 3)
  791. self.assertEqual(Game.objects.filter(season__gt__exact=222).count(), 3)
  792. # Games in 2011
  793. self.assertEqual(Game.objects.filter(season__year=2011).count(), 2)
  794. self.assertEqual(Game.objects.filter(season__year__exact=2011).count(), 2)
  795. self.assertEqual(Game.objects.filter(season__gt=333).count(), 2)
  796. self.assertEqual(Game.objects.filter(season__gt__exact=333).count(), 2)
  797. self.assertEqual(Game.objects.filter(season__year__gt=2010).count(), 2)
  798. self.assertEqual(Game.objects.filter(season__gt__gt=222).count(), 2)
  799. # Games played in 2010 and 2011
  800. self.assertEqual(Game.objects.filter(season__year__in=[2010, 2011]).count(), 5)
  801. self.assertEqual(Game.objects.filter(season__year__gt=2009).count(), 5)
  802. self.assertEqual(Game.objects.filter(season__gt__in=[222, 333]).count(), 5)
  803. self.assertEqual(Game.objects.filter(season__gt__gt=111).count(), 5)
  804. # Players who played in 2009
  805. self.assertEqual(Player.objects.filter(games__season__year=2009).distinct().count(), 2)
  806. self.assertEqual(Player.objects.filter(games__season__year__exact=2009).distinct().count(), 2)
  807. self.assertEqual(Player.objects.filter(games__season__gt=111).distinct().count(), 2)
  808. self.assertEqual(Player.objects.filter(games__season__gt__exact=111).distinct().count(), 2)
  809. # Players who played in 2010
  810. self.assertEqual(Player.objects.filter(games__season__year=2010).distinct().count(), 1)
  811. self.assertEqual(Player.objects.filter(games__season__year__exact=2010).distinct().count(), 1)
  812. self.assertEqual(Player.objects.filter(games__season__gt=222).distinct().count(), 1)
  813. self.assertEqual(Player.objects.filter(games__season__gt__exact=222).distinct().count(), 1)
  814. # Players who played in 2011
  815. self.assertEqual(Player.objects.filter(games__season__year=2011).distinct().count(), 2)
  816. self.assertEqual(Player.objects.filter(games__season__year__exact=2011).distinct().count(), 2)
  817. self.assertEqual(Player.objects.filter(games__season__gt=333).distinct().count(), 2)
  818. self.assertEqual(Player.objects.filter(games__season__year__gt=2010).distinct().count(), 2)
  819. self.assertEqual(Player.objects.filter(games__season__gt__gt=222).distinct().count(), 2)
  820. def test_chain_date_time_lookups(self):
  821. self.assertCountEqual(
  822. Article.objects.filter(pub_date__month__gt=7),
  823. [self.a5, self.a6],
  824. )
  825. self.assertCountEqual(
  826. Article.objects.filter(pub_date__day__gte=27),
  827. [self.a2, self.a3, self.a4, self.a7],
  828. )
  829. self.assertCountEqual(
  830. Article.objects.filter(pub_date__hour__lt=8),
  831. [self.a1, self.a2, self.a3, self.a4, self.a7],
  832. )
  833. self.assertCountEqual(
  834. Article.objects.filter(pub_date__minute__lte=0),
  835. [self.a1, self.a2, self.a3, self.a4, self.a5, self.a6, self.a7],
  836. )
  837. def test_exact_none_transform(self):
  838. """Transforms are used for __exact=None."""
  839. Season.objects.create(year=1, nulled_text_field='not null')
  840. self.assertFalse(Season.objects.filter(nulled_text_field__isnull=True))
  841. self.assertTrue(Season.objects.filter(nulled_text_field__nulled__isnull=True))
  842. self.assertTrue(Season.objects.filter(nulled_text_field__nulled__exact=None))
  843. self.assertTrue(Season.objects.filter(nulled_text_field__nulled=None))
  844. def test_exact_sliced_queryset_limit_one(self):
  845. self.assertCountEqual(
  846. Article.objects.filter(author=Author.objects.all()[:1]),
  847. [self.a1, self.a2, self.a3, self.a4]
  848. )
  849. def test_exact_sliced_queryset_limit_one_offset(self):
  850. self.assertCountEqual(
  851. Article.objects.filter(author=Author.objects.all()[1:2]),
  852. [self.a5, self.a6, self.a7]
  853. )
  854. def test_exact_sliced_queryset_not_limited_to_one(self):
  855. msg = (
  856. 'The QuerySet value for an exact lookup must be limited to one '
  857. 'result using slicing.'
  858. )
  859. with self.assertRaisesMessage(ValueError, msg):
  860. list(Article.objects.filter(author=Author.objects.all()[:2]))
  861. with self.assertRaisesMessage(ValueError, msg):
  862. list(Article.objects.filter(author=Author.objects.all()[1:]))
  863. def test_custom_field_none_rhs(self):
  864. """
  865. __exact=value is transformed to __isnull=True if Field.get_prep_value()
  866. converts value to None.
  867. """
  868. season = Season.objects.create(year=2012, nulled_text_field=None)
  869. self.assertTrue(Season.objects.filter(pk=season.pk, nulled_text_field__isnull=True))
  870. self.assertTrue(Season.objects.filter(pk=season.pk, nulled_text_field=''))
  871. def test_pattern_lookups_with_substr(self):
  872. a = Author.objects.create(name='John Smith', alias='Johx')
  873. b = Author.objects.create(name='Rhonda Simpson', alias='sonx')
  874. tests = (
  875. ('startswith', [a]),
  876. ('istartswith', [a]),
  877. ('contains', [a, b]),
  878. ('icontains', [a, b]),
  879. ('endswith', [b]),
  880. ('iendswith', [b]),
  881. )
  882. for lookup, result in tests:
  883. with self.subTest(lookup=lookup):
  884. authors = Author.objects.filter(**{'name__%s' % lookup: Substr('alias', 1, 3)})
  885. self.assertCountEqual(authors, result)
  886. def test_custom_lookup_none_rhs(self):
  887. """Lookup.can_use_none_as_rhs=True allows None as a lookup value."""
  888. season = Season.objects.create(year=2012, nulled_text_field=None)
  889. query = Season.objects.get_queryset().query
  890. field = query.model._meta.get_field('nulled_text_field')
  891. self.assertIsInstance(query.build_lookup(['isnull_none_rhs'], field, None), IsNullWithNoneAsRHS)
  892. self.assertTrue(Season.objects.filter(pk=season.pk, nulled_text_field__isnull_none_rhs=True))
  893. def test_exact_exists(self):
  894. qs = Article.objects.filter(pk=OuterRef('pk'))
  895. seasons = Season.objects.annotate(
  896. pk_exists=Exists(qs),
  897. ).filter(
  898. pk_exists=Exists(qs),
  899. )
  900. self.assertCountEqual(seasons, Season.objects.all())
  901. def test_nested_outerref_lhs(self):
  902. tag = Tag.objects.create(name=self.au1.alias)
  903. tag.articles.add(self.a1)
  904. qs = Tag.objects.annotate(
  905. has_author_alias_match=Exists(
  906. Article.objects.annotate(
  907. author_exists=Exists(
  908. Author.objects.filter(alias=OuterRef(OuterRef('name')))
  909. ),
  910. ).filter(author_exists=True)
  911. ),
  912. )
  913. self.assertEqual(qs.get(has_author_alias_match=True), tag)
  914. def test_exact_query_rhs_with_selected_columns(self):
  915. newest_author = Author.objects.create(name='Author 2')
  916. authors_max_ids = Author.objects.filter(
  917. name='Author 2',
  918. ).values(
  919. 'name',
  920. ).annotate(
  921. max_id=Max('id'),
  922. ).values('max_id')
  923. authors = Author.objects.filter(id=authors_max_ids[:1])
  924. self.assertEqual(authors.get(), newest_author)
  925. def test_isnull_non_boolean_value(self):
  926. msg = 'The QuerySet value for an isnull lookup must be True or False.'
  927. tests = [
  928. Author.objects.filter(alias__isnull=1),
  929. Article.objects.filter(author__isnull=1),
  930. Season.objects.filter(games__isnull=1),
  931. Freebie.objects.filter(stock__isnull=1),
  932. ]
  933. for qs in tests:
  934. with self.subTest(qs=qs):
  935. with self.assertRaisesMessage(ValueError, msg):
  936. qs.exists()
  937. def test_lookup_rhs(self):
  938. product = Product.objects.create(name='GME', qty_target=5000)
  939. stock_1 = Stock.objects.create(product=product, short=True, qty_available=180)
  940. stock_2 = Stock.objects.create(product=product, short=False, qty_available=5100)
  941. Stock.objects.create(product=product, short=False, qty_available=4000)
  942. self.assertCountEqual(
  943. Stock.objects.filter(short=Q(qty_available__lt=F('product__qty_target'))),
  944. [stock_1, stock_2],
  945. )
  946. self.assertCountEqual(
  947. Stock.objects.filter(short=ExpressionWrapper(
  948. Q(qty_available__lt=F('product__qty_target')),
  949. output_field=BooleanField(),
  950. )),
  951. [stock_1, stock_2],
  952. )
  953. class LookupQueryingTests(TestCase):
  954. @classmethod
  955. def setUpTestData(cls):
  956. cls.s1 = Season.objects.create(year=1942, gt=1942)
  957. cls.s2 = Season.objects.create(year=1842, gt=1942)
  958. cls.s3 = Season.objects.create(year=2042, gt=1942)
  959. def test_annotate(self):
  960. qs = Season.objects.annotate(equal=Exact(F('year'), 1942))
  961. self.assertCountEqual(
  962. qs.values_list('year', 'equal'),
  963. ((1942, True), (1842, False), (2042, False)),
  964. )
  965. def test_alias(self):
  966. qs = Season.objects.alias(greater=GreaterThan(F('year'), 1910))
  967. self.assertCountEqual(qs.filter(greater=True), [self.s1, self.s3])
  968. def test_annotate_value_greater_than_value(self):
  969. qs = Season.objects.annotate(greater=GreaterThan(Value(40), Value(30)))
  970. self.assertCountEqual(
  971. qs.values_list('year', 'greater'),
  972. ((1942, True), (1842, True), (2042, True)),
  973. )
  974. def test_annotate_field_greater_than_field(self):
  975. qs = Season.objects.annotate(greater=GreaterThan(F('year'), F('gt')))
  976. self.assertCountEqual(
  977. qs.values_list('year', 'greater'),
  978. ((1942, False), (1842, False), (2042, True)),
  979. )
  980. def test_annotate_field_greater_than_value(self):
  981. qs = Season.objects.annotate(greater=GreaterThan(F('year'), Value(1930)))
  982. self.assertCountEqual(
  983. qs.values_list('year', 'greater'),
  984. ((1942, True), (1842, False), (2042, True)),
  985. )
  986. def test_annotate_field_greater_than_literal(self):
  987. qs = Season.objects.annotate(greater=GreaterThan(F('year'), 1930))
  988. self.assertCountEqual(
  989. qs.values_list('year', 'greater'),
  990. ((1942, True), (1842, False), (2042, True)),
  991. )
  992. def test_annotate_literal_greater_than_field(self):
  993. qs = Season.objects.annotate(greater=GreaterThan(1930, F('year')))
  994. self.assertCountEqual(
  995. qs.values_list('year', 'greater'),
  996. ((1942, False), (1842, True), (2042, False)),
  997. )
  998. def test_annotate_less_than_float(self):
  999. qs = Season.objects.annotate(lesser=LessThan(F('year'), 1942.1))
  1000. self.assertCountEqual(
  1001. qs.values_list('year', 'lesser'),
  1002. ((1942, True), (1842, True), (2042, False)),
  1003. )
  1004. def test_annotate_greater_than_or_equal(self):
  1005. qs = Season.objects.annotate(greater=GreaterThanOrEqual(F('year'), 1942))
  1006. self.assertCountEqual(
  1007. qs.values_list('year', 'greater'),
  1008. ((1942, True), (1842, False), (2042, True)),
  1009. )
  1010. def test_annotate_greater_than_or_equal_float(self):
  1011. qs = Season.objects.annotate(greater=GreaterThanOrEqual(F('year'), 1942.1))
  1012. self.assertCountEqual(
  1013. qs.values_list('year', 'greater'),
  1014. ((1942, False), (1842, False), (2042, True)),
  1015. )
  1016. def test_combined_lookups(self):
  1017. expression = Exact(F('year'), 1942) | GreaterThan(F('year'), 1942)
  1018. qs = Season.objects.annotate(gte=expression)
  1019. self.assertCountEqual(
  1020. qs.values_list('year', 'gte'),
  1021. ((1942, True), (1842, False), (2042, True)),
  1022. )
  1023. def test_lookup_in_filter(self):
  1024. qs = Season.objects.filter(GreaterThan(F('year'), 1910))
  1025. self.assertCountEqual(qs, [self.s1, self.s3])
  1026. def test_filter_lookup_lhs(self):
  1027. qs = Season.objects.annotate(before_20=LessThan(F('year'), 2000)).filter(
  1028. before_20=LessThan(F('year'), 1900),
  1029. )
  1030. self.assertCountEqual(qs, [self.s2, self.s3])
  1031. def test_filter_wrapped_lookup_lhs(self):
  1032. qs = Season.objects.annotate(before_20=ExpressionWrapper(
  1033. Q(year__lt=2000),
  1034. output_field=BooleanField(),
  1035. )).filter(before_20=LessThan(F('year'), 1900)).values_list('year', flat=True)
  1036. self.assertCountEqual(qs, [1842, 2042])
  1037. def test_filter_exists_lhs(self):
  1038. qs = Season.objects.annotate(before_20=Exists(
  1039. Season.objects.filter(pk=OuterRef('pk'), year__lt=2000),
  1040. )).filter(before_20=LessThan(F('year'), 1900))
  1041. self.assertCountEqual(qs, [self.s2, self.s3])
  1042. def test_filter_subquery_lhs(self):
  1043. qs = Season.objects.annotate(before_20=Subquery(
  1044. Season.objects.filter(pk=OuterRef('pk')).values(
  1045. lesser=LessThan(F('year'), 2000),
  1046. ),
  1047. )).filter(before_20=LessThan(F('year'), 1900))
  1048. self.assertCountEqual(qs, [self.s2, self.s3])
  1049. def test_combined_lookups_in_filter(self):
  1050. expression = Exact(F('year'), 1942) | GreaterThan(F('year'), 1942)
  1051. qs = Season.objects.filter(expression)
  1052. self.assertCountEqual(qs, [self.s1, self.s3])
  1053. def test_combined_annotated_lookups_in_filter(self):
  1054. expression = Exact(F('year'), 1942) | GreaterThan(F('year'), 1942)
  1055. qs = Season.objects.annotate(gte=expression).filter(gte=True)
  1056. self.assertCountEqual(qs, [self.s1, self.s3])
  1057. def test_combined_annotated_lookups_in_filter_false(self):
  1058. expression = Exact(F('year'), 1942) | GreaterThan(F('year'), 1942)
  1059. qs = Season.objects.annotate(gte=expression).filter(gte=False)
  1060. self.assertSequenceEqual(qs, [self.s2])
  1061. def test_lookup_in_order_by(self):
  1062. qs = Season.objects.order_by(LessThan(F('year'), 1910), F('year'))
  1063. self.assertSequenceEqual(qs, [self.s1, self.s3, self.s2])
  1064. @skipUnlessDBFeature('supports_boolean_expr_in_select_clause')
  1065. def test_aggregate_combined_lookup(self):
  1066. expression = Cast(GreaterThan(F('year'), 1900), models.IntegerField())
  1067. qs = Season.objects.aggregate(modern=models.Sum(expression))
  1068. self.assertEqual(qs['modern'], 2)
  1069. def test_conditional_expression(self):
  1070. qs = Season.objects.annotate(century=Case(
  1071. When(
  1072. GreaterThan(F('year'), 1900) & LessThanOrEqual(F('year'), 2000),
  1073. then=Value('20th'),
  1074. ),
  1075. default=Value('other'),
  1076. )).values('year', 'century')
  1077. self.assertCountEqual(qs, [
  1078. {'year': 1942, 'century': '20th'},
  1079. {'year': 1842, 'century': 'other'},
  1080. {'year': 2042, 'century': 'other'},
  1081. ])