tests.py 109 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902
  1. import datetime
  2. import pickle
  3. import unittest
  4. import uuid
  5. from collections import namedtuple
  6. from copy import deepcopy
  7. from decimal import Decimal
  8. from unittest import mock
  9. from django.core.exceptions import FieldError
  10. from django.db import DatabaseError, NotSupportedError, connection
  11. from django.db.models import (
  12. AutoField,
  13. Avg,
  14. BinaryField,
  15. BooleanField,
  16. Case,
  17. CharField,
  18. Count,
  19. DateField,
  20. DateTimeField,
  21. DecimalField,
  22. DurationField,
  23. Exists,
  24. Expression,
  25. ExpressionList,
  26. ExpressionWrapper,
  27. F,
  28. FloatField,
  29. Func,
  30. IntegerField,
  31. Max,
  32. Min,
  33. Model,
  34. OrderBy,
  35. OuterRef,
  36. PositiveIntegerField,
  37. Q,
  38. StdDev,
  39. Subquery,
  40. Sum,
  41. TimeField,
  42. UUIDField,
  43. Value,
  44. Variance,
  45. When,
  46. )
  47. from django.db.models.expressions import (
  48. Col,
  49. ColPairs,
  50. Combinable,
  51. CombinedExpression,
  52. NegatedExpression,
  53. OutputFieldIsNoneError,
  54. RawSQL,
  55. Ref,
  56. )
  57. from django.db.models.functions import (
  58. Coalesce,
  59. Concat,
  60. Left,
  61. Length,
  62. Lower,
  63. Substr,
  64. Upper,
  65. )
  66. from django.db.models.sql import constants
  67. from django.db.models.sql.datastructures import Join
  68. from django.test import SimpleTestCase, TestCase, skipUnlessDBFeature
  69. from django.test.utils import (
  70. Approximate,
  71. CaptureQueriesContext,
  72. isolate_apps,
  73. register_lookup,
  74. )
  75. from django.utils.functional import SimpleLazyObject
  76. from .models import (
  77. UUID,
  78. UUIDPK,
  79. Company,
  80. Employee,
  81. Experiment,
  82. Manager,
  83. Number,
  84. RemoteEmployee,
  85. Result,
  86. SimulationRun,
  87. Text,
  88. Time,
  89. )
  90. class BasicExpressionsTests(TestCase):
  91. @classmethod
  92. def setUpTestData(cls):
  93. cls.example_inc = Company.objects.create(
  94. name="Example Inc.",
  95. num_employees=2300,
  96. num_chairs=5,
  97. ceo=Employee.objects.create(firstname="Joe", lastname="Smith", salary=10),
  98. )
  99. cls.foobar_ltd = Company.objects.create(
  100. name="Foobar Ltd.",
  101. num_employees=3,
  102. num_chairs=4,
  103. based_in_eu=True,
  104. ceo=Employee.objects.create(firstname="Frank", lastname="Meyer", salary=20),
  105. )
  106. cls.max = Employee.objects.create(
  107. firstname="Max", lastname="Mustermann", salary=30
  108. )
  109. cls.gmbh = Company.objects.create(
  110. name="Test GmbH", num_employees=32, num_chairs=1, ceo=cls.max
  111. )
  112. def setUp(self):
  113. self.company_query = Company.objects.values(
  114. "name", "num_employees", "num_chairs"
  115. ).order_by("name", "num_employees", "num_chairs")
  116. def test_annotate_values_aggregate(self):
  117. companies = (
  118. Company.objects.annotate(
  119. salaries=F("ceo__salary"),
  120. )
  121. .values("num_employees", "salaries")
  122. .aggregate(
  123. result=Sum(
  124. F("salaries") + F("num_employees"), output_field=IntegerField()
  125. ),
  126. )
  127. )
  128. self.assertEqual(companies["result"], 2395)
  129. def test_annotate_values_filter(self):
  130. companies = (
  131. Company.objects.annotate(
  132. foo=RawSQL("%s", ["value"]),
  133. )
  134. .filter(foo="value")
  135. .order_by("name")
  136. )
  137. self.assertSequenceEqual(
  138. companies,
  139. [self.example_inc, self.foobar_ltd, self.gmbh],
  140. )
  141. def test_annotate_values_count(self):
  142. companies = Company.objects.annotate(foo=RawSQL("%s", ["value"]))
  143. self.assertEqual(companies.count(), 3)
  144. @skipUnlessDBFeature("supports_boolean_expr_in_select_clause")
  145. def test_filtering_on_annotate_that_uses_q(self):
  146. self.assertEqual(
  147. Company.objects.annotate(
  148. num_employees_check=ExpressionWrapper(
  149. Q(num_employees__gt=3), output_field=BooleanField()
  150. )
  151. )
  152. .filter(num_employees_check=True)
  153. .count(),
  154. 2,
  155. )
  156. def test_filtering_on_q_that_is_boolean(self):
  157. self.assertEqual(
  158. Company.objects.filter(
  159. ExpressionWrapper(Q(num_employees__gt=3), output_field=BooleanField())
  160. ).count(),
  161. 2,
  162. )
  163. def test_filtering_on_rawsql_that_is_boolean(self):
  164. self.assertEqual(
  165. Company.objects.filter(
  166. RawSQL("num_employees > %s", (3,), output_field=BooleanField()),
  167. ).count(),
  168. 2,
  169. )
  170. def test_filter_inter_attribute(self):
  171. # We can filter on attribute relationships on same model obj, e.g.
  172. # find companies where the number of employees is greater
  173. # than the number of chairs.
  174. self.assertSequenceEqual(
  175. self.company_query.filter(num_employees__gt=F("num_chairs")),
  176. [
  177. {
  178. "num_chairs": 5,
  179. "name": "Example Inc.",
  180. "num_employees": 2300,
  181. },
  182. {"num_chairs": 1, "name": "Test GmbH", "num_employees": 32},
  183. ],
  184. )
  185. def test_update(self):
  186. # We can set one field to have the value of another field
  187. # Make sure we have enough chairs
  188. self.company_query.update(num_chairs=F("num_employees"))
  189. self.assertSequenceEqual(
  190. self.company_query,
  191. [
  192. {"num_chairs": 2300, "name": "Example Inc.", "num_employees": 2300},
  193. {"num_chairs": 3, "name": "Foobar Ltd.", "num_employees": 3},
  194. {"num_chairs": 32, "name": "Test GmbH", "num_employees": 32},
  195. ],
  196. )
  197. def _test_slicing_of_f_expressions(self, model):
  198. tests = [
  199. (F("name")[:], "Example Inc."),
  200. (F("name")[:7], "Example"),
  201. (F("name")[:6][:5], "Examp"), # Nested slicing.
  202. (F("name")[0], "E"),
  203. (F("name")[13], ""),
  204. (F("name")[8:], "Inc."),
  205. (F("name")[0:15], "Example Inc."),
  206. (F("name")[2:7], "ample"),
  207. (F("name")[1:][:3], "xam"),
  208. (F("name")[2:2], ""),
  209. ]
  210. for expression, expected in tests:
  211. with self.subTest(expression=expression, expected=expected):
  212. obj = model.objects.get(name="Example Inc.")
  213. try:
  214. obj.name = expression
  215. obj.save(update_fields=["name"])
  216. obj.refresh_from_db()
  217. self.assertEqual(obj.name, expected)
  218. finally:
  219. obj.name = "Example Inc."
  220. obj.save(update_fields=["name"])
  221. def test_slicing_of_f_expressions_charfield(self):
  222. self._test_slicing_of_f_expressions(Company)
  223. def test_slicing_of_f_expressions_textfield(self):
  224. Text.objects.bulk_create(
  225. [Text(name=company.name) for company in Company.objects.all()]
  226. )
  227. self._test_slicing_of_f_expressions(Text)
  228. def test_slicing_of_f_expressions_with_annotate(self):
  229. qs = Company.objects.annotate(
  230. first_three=F("name")[:3],
  231. after_three=F("name")[3:],
  232. random_four=F("name")[2:5],
  233. first_letter_slice=F("name")[:1],
  234. first_letter_index=F("name")[0],
  235. )
  236. tests = [
  237. ("first_three", ["Exa", "Foo", "Tes"]),
  238. ("after_three", ["mple Inc.", "bar Ltd.", "t GmbH"]),
  239. ("random_four", ["amp", "oba", "st "]),
  240. ("first_letter_slice", ["E", "F", "T"]),
  241. ("first_letter_index", ["E", "F", "T"]),
  242. ]
  243. for annotation, expected in tests:
  244. with self.subTest(annotation):
  245. self.assertCountEqual(qs.values_list(annotation, flat=True), expected)
  246. def test_slicing_of_f_expression_with_annotated_expression(self):
  247. qs = Company.objects.annotate(
  248. new_name=Case(
  249. When(based_in_eu=True, then=Concat(Value("EU:"), F("name"))),
  250. default=F("name"),
  251. ),
  252. first_two=F("new_name")[:3],
  253. )
  254. self.assertCountEqual(
  255. qs.values_list("first_two", flat=True),
  256. ["Exa", "EU:", "Tes"],
  257. )
  258. def test_slicing_of_f_expressions_with_negative_index(self):
  259. msg = "Negative indexing is not supported."
  260. indexes = [slice(0, -4), slice(-4, 0), slice(-4), -5]
  261. for i in indexes:
  262. with self.subTest(i=i), self.assertRaisesMessage(ValueError, msg):
  263. F("name")[i]
  264. def test_slicing_of_f_expressions_with_slice_stop_less_than_slice_start(self):
  265. msg = "Slice stop must be greater than slice start."
  266. with self.assertRaisesMessage(ValueError, msg):
  267. F("name")[4:2]
  268. def test_slicing_of_f_expressions_with_invalid_type(self):
  269. msg = "Argument to slice must be either int or slice instance."
  270. with self.assertRaisesMessage(TypeError, msg):
  271. F("name")["error"]
  272. def test_slicing_of_f_expressions_with_step(self):
  273. msg = "Step argument is not supported."
  274. with self.assertRaisesMessage(ValueError, msg):
  275. F("name")[::4]
  276. def test_slicing_of_f_unsupported_field(self):
  277. msg = "This field does not support slicing."
  278. with self.assertRaisesMessage(NotSupportedError, msg):
  279. Company.objects.update(num_chairs=F("num_chairs")[:4])
  280. def test_slicing_of_outerref(self):
  281. inner = Company.objects.filter(name__startswith=OuterRef("ceo__firstname")[0])
  282. outer = Company.objects.filter(Exists(inner)).values_list("name", flat=True)
  283. self.assertSequenceEqual(outer, ["Foobar Ltd."])
  284. def test_arithmetic(self):
  285. # We can perform arithmetic operations in expressions
  286. # Make sure we have 2 spare chairs
  287. self.company_query.update(num_chairs=F("num_employees") + 2)
  288. self.assertSequenceEqual(
  289. self.company_query,
  290. [
  291. {"num_chairs": 2302, "name": "Example Inc.", "num_employees": 2300},
  292. {"num_chairs": 5, "name": "Foobar Ltd.", "num_employees": 3},
  293. {"num_chairs": 34, "name": "Test GmbH", "num_employees": 32},
  294. ],
  295. )
  296. def test_order_of_operations(self):
  297. # Law of order of operations is followed
  298. self.company_query.update(
  299. num_chairs=F("num_employees") + 2 * F("num_employees")
  300. )
  301. self.assertSequenceEqual(
  302. self.company_query,
  303. [
  304. {"num_chairs": 6900, "name": "Example Inc.", "num_employees": 2300},
  305. {"num_chairs": 9, "name": "Foobar Ltd.", "num_employees": 3},
  306. {"num_chairs": 96, "name": "Test GmbH", "num_employees": 32},
  307. ],
  308. )
  309. def test_parenthesis_priority(self):
  310. # Law of order of operations can be overridden by parentheses
  311. self.company_query.update(
  312. num_chairs=(F("num_employees") + 2) * F("num_employees")
  313. )
  314. self.assertSequenceEqual(
  315. self.company_query,
  316. [
  317. {"num_chairs": 5294600, "name": "Example Inc.", "num_employees": 2300},
  318. {"num_chairs": 15, "name": "Foobar Ltd.", "num_employees": 3},
  319. {"num_chairs": 1088, "name": "Test GmbH", "num_employees": 32},
  320. ],
  321. )
  322. def test_update_with_fk(self):
  323. # ForeignKey can become updated with the value of another ForeignKey.
  324. self.assertEqual(Company.objects.update(point_of_contact=F("ceo")), 3)
  325. self.assertQuerySetEqual(
  326. Company.objects.all(),
  327. ["Joe Smith", "Frank Meyer", "Max Mustermann"],
  328. lambda c: str(c.point_of_contact),
  329. ordered=False,
  330. )
  331. def test_update_with_none(self):
  332. Number.objects.create(integer=1, float=1.0)
  333. Number.objects.create(integer=2)
  334. Number.objects.filter(float__isnull=False).update(float=Value(None))
  335. self.assertQuerySetEqual(
  336. Number.objects.all(), [None, None], lambda n: n.float, ordered=False
  337. )
  338. def test_filter_with_join(self):
  339. # F Expressions can also span joins
  340. Company.objects.update(point_of_contact=F("ceo"))
  341. c = Company.objects.first()
  342. c.point_of_contact = Employee.objects.create(
  343. firstname="Guido", lastname="van Rossum"
  344. )
  345. c.save()
  346. self.assertQuerySetEqual(
  347. Company.objects.filter(ceo__firstname=F("point_of_contact__firstname")),
  348. ["Foobar Ltd.", "Test GmbH"],
  349. lambda c: c.name,
  350. ordered=False,
  351. )
  352. Company.objects.exclude(ceo__firstname=F("point_of_contact__firstname")).update(
  353. name="foo"
  354. )
  355. self.assertEqual(
  356. Company.objects.exclude(ceo__firstname=F("point_of_contact__firstname"))
  357. .get()
  358. .name,
  359. "foo",
  360. )
  361. msg = "Joined field references are not permitted in this query"
  362. with self.assertRaisesMessage(FieldError, msg):
  363. Company.objects.exclude(
  364. ceo__firstname=F("point_of_contact__firstname")
  365. ).update(name=F("point_of_contact__lastname"))
  366. def test_object_update(self):
  367. # F expressions can be used to update attributes on single objects
  368. self.gmbh.num_employees = F("num_employees") + 4
  369. self.gmbh.save()
  370. self.gmbh.refresh_from_db()
  371. self.assertEqual(self.gmbh.num_employees, 36)
  372. def test_new_object_save(self):
  373. # We should be able to use Funcs when inserting new data
  374. test_co = Company(
  375. name=Lower(Value("UPPER")), num_employees=32, num_chairs=1, ceo=self.max
  376. )
  377. test_co.save()
  378. test_co.refresh_from_db()
  379. self.assertEqual(test_co.name, "upper")
  380. def test_new_object_create(self):
  381. test_co = Company.objects.create(
  382. name=Lower(Value("UPPER")), num_employees=32, num_chairs=1, ceo=self.max
  383. )
  384. test_co.refresh_from_db()
  385. self.assertEqual(test_co.name, "upper")
  386. def test_object_create_with_aggregate(self):
  387. # Aggregates are not allowed when inserting new data
  388. msg = (
  389. "Aggregate functions are not allowed in this query "
  390. "(num_employees=Max(Value(1)))."
  391. )
  392. with self.assertRaisesMessage(FieldError, msg):
  393. Company.objects.create(
  394. name="Company",
  395. num_employees=Max(Value(1)),
  396. num_chairs=1,
  397. ceo=Employee.objects.create(
  398. firstname="Just", lastname="Doit", salary=30
  399. ),
  400. )
  401. def test_object_update_fk(self):
  402. # F expressions cannot be used to update attributes which are foreign
  403. # keys, or attributes which involve joins.
  404. test_gmbh = Company.objects.get(pk=self.gmbh.pk)
  405. msg = 'F(ceo)": "Company.point_of_contact" must be a "Employee" instance.'
  406. with self.assertRaisesMessage(ValueError, msg):
  407. test_gmbh.point_of_contact = F("ceo")
  408. test_gmbh.point_of_contact = self.gmbh.ceo
  409. test_gmbh.save()
  410. test_gmbh.name = F("ceo__lastname")
  411. msg = "Joined field references are not permitted in this query"
  412. with self.assertRaisesMessage(FieldError, msg):
  413. test_gmbh.save()
  414. def test_update_inherited_field_value(self):
  415. msg = "Joined field references are not permitted in this query"
  416. with self.assertRaisesMessage(FieldError, msg):
  417. RemoteEmployee.objects.update(adjusted_salary=F("salary") * 5)
  418. def test_object_update_unsaved_objects(self):
  419. # F expressions cannot be used to update attributes on objects which do
  420. # not yet exist in the database
  421. acme = Company(
  422. name="The Acme Widget Co.", num_employees=12, num_chairs=5, ceo=self.max
  423. )
  424. acme.num_employees = F("num_employees") + 16
  425. msg = (
  426. 'Failed to insert expression "Col(expressions_company, '
  427. 'expressions.Company.num_employees) + Value(16)" on '
  428. "expressions.Company.num_employees. F() expressions can only be "
  429. "used to update, not to insert."
  430. )
  431. with self.assertRaisesMessage(ValueError, msg):
  432. acme.save()
  433. acme.num_employees = 12
  434. acme.name = Lower(F("name"))
  435. msg = (
  436. 'Failed to insert expression "Lower(Col(expressions_company, '
  437. 'expressions.Company.name))" on expressions.Company.name. F() '
  438. "expressions can only be used to update, not to insert."
  439. )
  440. with self.assertRaisesMessage(ValueError, msg):
  441. acme.save()
  442. def test_ticket_11722_iexact_lookup(self):
  443. Employee.objects.create(firstname="John", lastname="Doe")
  444. test = Employee.objects.create(firstname="Test", lastname="test")
  445. queryset = Employee.objects.filter(firstname__iexact=F("lastname"))
  446. self.assertSequenceEqual(queryset, [test])
  447. def test_ticket_16731_startswith_lookup(self):
  448. Employee.objects.create(firstname="John", lastname="Doe")
  449. e2 = Employee.objects.create(firstname="Jack", lastname="Jackson")
  450. e3 = Employee.objects.create(firstname="Jack", lastname="jackson")
  451. self.assertSequenceEqual(
  452. Employee.objects.filter(lastname__startswith=F("firstname")),
  453. [e2, e3] if connection.features.has_case_insensitive_like else [e2],
  454. )
  455. qs = Employee.objects.filter(lastname__istartswith=F("firstname")).order_by(
  456. "pk"
  457. )
  458. self.assertSequenceEqual(qs, [e2, e3])
  459. def test_ticket_18375_join_reuse(self):
  460. # Reverse multijoin F() references and the lookup target the same join.
  461. # Pre #18375 the F() join was generated first and the lookup couldn't
  462. # reuse that join.
  463. qs = Employee.objects.filter(
  464. company_ceo_set__num_chairs=F("company_ceo_set__num_employees")
  465. )
  466. self.assertEqual(str(qs.query).count("JOIN"), 1)
  467. def test_ticket_18375_kwarg_ordering(self):
  468. # The next query was dict-randomization dependent - if the "gte=1"
  469. # was seen first, then the F() will reuse the join generated by the
  470. # gte lookup, if F() was seen first, then it generated a join the
  471. # other lookups could not reuse.
  472. qs = Employee.objects.filter(
  473. company_ceo_set__num_chairs=F("company_ceo_set__num_employees"),
  474. company_ceo_set__num_chairs__gte=1,
  475. )
  476. self.assertEqual(str(qs.query).count("JOIN"), 1)
  477. def test_ticket_18375_kwarg_ordering_2(self):
  478. # Another similar case for F() than above. Now we have the same join
  479. # in two filter kwargs, one in the lhs lookup, one in F. Here pre
  480. # #18375 the amount of joins generated was random if dict
  481. # randomization was enabled, that is the generated query dependent
  482. # on which clause was seen first.
  483. qs = Employee.objects.filter(
  484. company_ceo_set__num_employees=F("pk"),
  485. pk=F("company_ceo_set__num_employees"),
  486. )
  487. self.assertEqual(str(qs.query).count("JOIN"), 1)
  488. def test_ticket_18375_chained_filters(self):
  489. # F() expressions do not reuse joins from previous filter.
  490. qs = Employee.objects.filter(company_ceo_set__num_employees=F("pk")).filter(
  491. company_ceo_set__num_employees=F("company_ceo_set__num_employees")
  492. )
  493. self.assertEqual(str(qs.query).count("JOIN"), 2)
  494. def test_order_by_exists(self):
  495. mary = Employee.objects.create(
  496. firstname="Mary", lastname="Mustermann", salary=20
  497. )
  498. mustermanns_by_seniority = Employee.objects.filter(
  499. lastname="Mustermann"
  500. ).order_by(
  501. # Order by whether the employee is the CEO of a company
  502. Exists(Company.objects.filter(ceo=OuterRef("pk"))).desc()
  503. )
  504. self.assertSequenceEqual(mustermanns_by_seniority, [self.max, mary])
  505. def test_order_by_multiline_sql(self):
  506. raw_order_by = (
  507. RawSQL(
  508. """
  509. CASE WHEN num_employees > 1000
  510. THEN num_chairs
  511. ELSE 0 END
  512. """,
  513. [],
  514. ).desc(),
  515. RawSQL(
  516. """
  517. CASE WHEN num_chairs > 1
  518. THEN 1
  519. ELSE 0 END
  520. """,
  521. [],
  522. ).asc(),
  523. )
  524. for qs in (
  525. Company.objects.all(),
  526. Company.objects.distinct(),
  527. ):
  528. with self.subTest(qs=qs):
  529. self.assertSequenceEqual(
  530. qs.order_by(*raw_order_by),
  531. [self.example_inc, self.gmbh, self.foobar_ltd],
  532. )
  533. def test_outerref(self):
  534. inner = Company.objects.filter(point_of_contact=OuterRef("pk"))
  535. msg = (
  536. "This queryset contains a reference to an outer query and may only "
  537. "be used in a subquery."
  538. )
  539. with self.assertRaisesMessage(ValueError, msg):
  540. inner.exists()
  541. outer = Employee.objects.annotate(is_point_of_contact=Exists(inner))
  542. self.assertIs(outer.exists(), True)
  543. def test_exist_single_field_output_field(self):
  544. queryset = Company.objects.values("pk")
  545. self.assertIsInstance(Exists(queryset).output_field, BooleanField)
  546. def test_subquery(self):
  547. Company.objects.filter(name="Example Inc.").update(
  548. point_of_contact=Employee.objects.get(firstname="Joe", lastname="Smith"),
  549. ceo=self.max,
  550. )
  551. Employee.objects.create(firstname="Bob", lastname="Brown", salary=40)
  552. qs = (
  553. Employee.objects.annotate(
  554. is_point_of_contact=Exists(
  555. Company.objects.filter(point_of_contact=OuterRef("pk"))
  556. ),
  557. is_not_point_of_contact=~Exists(
  558. Company.objects.filter(point_of_contact=OuterRef("pk"))
  559. ),
  560. is_ceo_of_small_company=Exists(
  561. Company.objects.filter(num_employees__lt=200, ceo=OuterRef("pk"))
  562. ),
  563. is_ceo_small_2=~~Exists(
  564. Company.objects.filter(num_employees__lt=200, ceo=OuterRef("pk"))
  565. ),
  566. largest_company=Subquery(
  567. Company.objects.order_by("-num_employees")
  568. .filter(Q(ceo=OuterRef("pk")) | Q(point_of_contact=OuterRef("pk")))
  569. .values("name")[:1],
  570. output_field=CharField(),
  571. ),
  572. )
  573. .values(
  574. "firstname",
  575. "is_point_of_contact",
  576. "is_not_point_of_contact",
  577. "is_ceo_of_small_company",
  578. "is_ceo_small_2",
  579. "largest_company",
  580. )
  581. .order_by("firstname")
  582. )
  583. results = list(qs)
  584. # Could use Coalesce(subq, Value('')) instead except for the bug in
  585. # oracledb mentioned in #23843.
  586. bob = results[0]
  587. if (
  588. bob["largest_company"] == ""
  589. and connection.features.interprets_empty_strings_as_nulls
  590. ):
  591. bob["largest_company"] = None
  592. self.assertEqual(
  593. results,
  594. [
  595. {
  596. "firstname": "Bob",
  597. "is_point_of_contact": False,
  598. "is_not_point_of_contact": True,
  599. "is_ceo_of_small_company": False,
  600. "is_ceo_small_2": False,
  601. "largest_company": None,
  602. },
  603. {
  604. "firstname": "Frank",
  605. "is_point_of_contact": False,
  606. "is_not_point_of_contact": True,
  607. "is_ceo_of_small_company": True,
  608. "is_ceo_small_2": True,
  609. "largest_company": "Foobar Ltd.",
  610. },
  611. {
  612. "firstname": "Joe",
  613. "is_point_of_contact": True,
  614. "is_not_point_of_contact": False,
  615. "is_ceo_of_small_company": False,
  616. "is_ceo_small_2": False,
  617. "largest_company": "Example Inc.",
  618. },
  619. {
  620. "firstname": "Max",
  621. "is_point_of_contact": False,
  622. "is_not_point_of_contact": True,
  623. "is_ceo_of_small_company": True,
  624. "is_ceo_small_2": True,
  625. "largest_company": "Example Inc.",
  626. },
  627. ],
  628. )
  629. # A less elegant way to write the same query: this uses a LEFT OUTER
  630. # JOIN and an IS NULL, inside a WHERE NOT IN which is probably less
  631. # efficient than EXISTS.
  632. self.assertCountEqual(
  633. qs.filter(is_point_of_contact=True).values("pk"),
  634. Employee.objects.exclude(company_point_of_contact_set=None).values("pk"),
  635. )
  636. def test_subquery_eq(self):
  637. qs = Employee.objects.annotate(
  638. is_ceo=Exists(Company.objects.filter(ceo=OuterRef("pk"))),
  639. is_point_of_contact=Exists(
  640. Company.objects.filter(point_of_contact=OuterRef("pk")),
  641. ),
  642. small_company=Exists(
  643. queryset=Company.objects.filter(num_employees__lt=200),
  644. ),
  645. ).filter(is_ceo=True, is_point_of_contact=False, small_company=True)
  646. self.assertNotEqual(
  647. qs.query.annotations["is_ceo"],
  648. qs.query.annotations["is_point_of_contact"],
  649. )
  650. self.assertNotEqual(
  651. qs.query.annotations["is_ceo"],
  652. qs.query.annotations["small_company"],
  653. )
  654. def test_subquery_sql(self):
  655. employees = Employee.objects.all()
  656. employees_subquery = Subquery(employees)
  657. self.assertIs(employees_subquery.query.subquery, True)
  658. self.assertIs(employees.query.subquery, False)
  659. compiler = employees_subquery.query.get_compiler(connection=connection)
  660. sql, _ = employees_subquery.as_sql(compiler, connection)
  661. self.assertIn("(SELECT ", sql)
  662. def test_in_subquery(self):
  663. # This is a contrived test (and you really wouldn't write this query),
  664. # but it is a succinct way to test the __in=Subquery() construct.
  665. small_companies = Company.objects.filter(num_employees__lt=200).values("pk")
  666. subquery_test = Company.objects.filter(pk__in=Subquery(small_companies))
  667. self.assertCountEqual(subquery_test, [self.foobar_ltd, self.gmbh])
  668. subquery_test2 = Company.objects.filter(
  669. pk=Subquery(small_companies.filter(num_employees=3))
  670. )
  671. self.assertCountEqual(subquery_test2, [self.foobar_ltd])
  672. def test_uuid_pk_subquery(self):
  673. u = UUIDPK.objects.create()
  674. UUID.objects.create(uuid_fk=u)
  675. qs = UUIDPK.objects.filter(id__in=Subquery(UUID.objects.values("uuid_fk__id")))
  676. self.assertCountEqual(qs, [u])
  677. def test_nested_subquery(self):
  678. inner = Company.objects.filter(point_of_contact=OuterRef("pk"))
  679. outer = Employee.objects.annotate(is_point_of_contact=Exists(inner))
  680. contrived = Employee.objects.annotate(
  681. is_point_of_contact=Subquery(
  682. outer.filter(pk=OuterRef("pk")).values("is_point_of_contact"),
  683. output_field=BooleanField(),
  684. ),
  685. )
  686. self.assertCountEqual(contrived.values_list(), outer.values_list())
  687. def test_nested_subquery_join_outer_ref(self):
  688. inner = Employee.objects.filter(pk=OuterRef("ceo__pk")).values("pk")
  689. qs = Employee.objects.annotate(
  690. ceo_company=Subquery(
  691. Company.objects.filter(
  692. ceo__in=inner,
  693. ceo__pk=OuterRef("pk"),
  694. ).values("pk"),
  695. ),
  696. )
  697. self.assertSequenceEqual(
  698. qs.values_list("ceo_company", flat=True),
  699. [self.example_inc.pk, self.foobar_ltd.pk, self.gmbh.pk],
  700. )
  701. def test_nested_subquery_outer_ref_2(self):
  702. first = Time.objects.create(time="09:00")
  703. second = Time.objects.create(time="17:00")
  704. third = Time.objects.create(time="21:00")
  705. SimulationRun.objects.bulk_create(
  706. [
  707. SimulationRun(start=first, end=second, midpoint="12:00"),
  708. SimulationRun(start=first, end=third, midpoint="15:00"),
  709. SimulationRun(start=second, end=first, midpoint="00:00"),
  710. ]
  711. )
  712. inner = Time.objects.filter(
  713. time=OuterRef(OuterRef("time")), pk=OuterRef("start")
  714. ).values("time")
  715. middle = SimulationRun.objects.annotate(other=Subquery(inner)).values("other")[
  716. :1
  717. ]
  718. outer = Time.objects.annotate(other=Subquery(middle, output_field=TimeField()))
  719. # This is a contrived example. It exercises the double OuterRef form.
  720. self.assertCountEqual(outer, [first, second, third])
  721. def test_nested_subquery_outer_ref_with_autofield(self):
  722. first = Time.objects.create(time="09:00")
  723. second = Time.objects.create(time="17:00")
  724. SimulationRun.objects.create(start=first, end=second, midpoint="12:00")
  725. inner = SimulationRun.objects.filter(start=OuterRef(OuterRef("pk"))).values(
  726. "start"
  727. )
  728. middle = Time.objects.annotate(other=Subquery(inner)).values("other")[:1]
  729. outer = Time.objects.annotate(
  730. other=Subquery(middle, output_field=IntegerField())
  731. )
  732. # This exercises the double OuterRef form with AutoField as pk.
  733. self.assertCountEqual(outer, [first, second])
  734. def test_annotations_within_subquery(self):
  735. Company.objects.filter(num_employees__lt=50).update(
  736. ceo=Employee.objects.get(firstname="Frank")
  737. )
  738. inner = (
  739. Company.objects.filter(ceo=OuterRef("pk"))
  740. .values("ceo")
  741. .annotate(total_employees=Sum("num_employees"))
  742. .values("total_employees")
  743. )
  744. outer = Employee.objects.annotate(total_employees=Subquery(inner)).filter(
  745. salary__lte=Subquery(inner)
  746. )
  747. self.assertSequenceEqual(
  748. outer.order_by("-total_employees").values("salary", "total_employees"),
  749. [
  750. {"salary": 10, "total_employees": 2300},
  751. {"salary": 20, "total_employees": 35},
  752. ],
  753. )
  754. def test_subquery_references_joined_table_twice(self):
  755. inner = Company.objects.filter(
  756. num_chairs__gte=OuterRef("ceo__salary"),
  757. num_employees__gte=OuterRef("point_of_contact__salary"),
  758. )
  759. # Another contrived example (there is no need to have a subquery here)
  760. outer = Company.objects.filter(pk__in=Subquery(inner.values("pk")))
  761. self.assertFalse(outer.exists())
  762. def test_subquery_filter_by_aggregate(self):
  763. Number.objects.create(integer=1000, float=1.2)
  764. Employee.objects.create(salary=1000)
  765. qs = Number.objects.annotate(
  766. min_valuable_count=Subquery(
  767. Employee.objects.filter(
  768. salary=OuterRef("integer"),
  769. )
  770. .annotate(cnt=Count("salary"))
  771. .filter(cnt__gt=0)
  772. .values("cnt")[:1]
  773. ),
  774. )
  775. self.assertEqual(qs.get().float, 1.2)
  776. def test_subquery_filter_by_lazy(self):
  777. self.max.manager = Manager.objects.create(name="Manager")
  778. self.max.save()
  779. max_manager = SimpleLazyObject(
  780. lambda: Manager.objects.get(pk=self.max.manager.pk)
  781. )
  782. qs = Company.objects.annotate(
  783. ceo_manager=Subquery(
  784. Employee.objects.filter(
  785. lastname=OuterRef("ceo__lastname"),
  786. ).values("manager"),
  787. ),
  788. ).filter(ceo_manager=max_manager)
  789. self.assertEqual(qs.get(), self.gmbh)
  790. def test_aggregate_subquery_annotation(self):
  791. with self.assertNumQueries(1) as ctx:
  792. aggregate = Company.objects.annotate(
  793. ceo_salary=Subquery(
  794. Employee.objects.filter(
  795. id=OuterRef("ceo_id"),
  796. ).values("salary")
  797. ),
  798. ).aggregate(
  799. ceo_salary_gt_20=Count("pk", filter=Q(ceo_salary__gt=20)),
  800. )
  801. self.assertEqual(aggregate, {"ceo_salary_gt_20": 1})
  802. # Aggregation over a subquery annotation doesn't annotate the subquery
  803. # twice in the inner query.
  804. sql = ctx.captured_queries[0]["sql"]
  805. self.assertLessEqual(sql.count("SELECT"), 3)
  806. # GROUP BY isn't required to aggregate over a query that doesn't
  807. # contain nested aggregates.
  808. self.assertNotIn("GROUP BY", sql)
  809. def test_object_create_with_f_expression_in_subquery(self):
  810. Company.objects.create(
  811. name="Big company", num_employees=100000, num_chairs=1, ceo=self.max
  812. )
  813. biggest_company = Company.objects.create(
  814. name="Biggest company",
  815. num_chairs=1,
  816. ceo=self.max,
  817. num_employees=Subquery(
  818. Company.objects.order_by("-num_employees")
  819. .annotate(max_num_employees=Max("num_employees"))
  820. .annotate(new_num_employees=F("max_num_employees") + 1)
  821. .values("new_num_employees")[:1]
  822. ),
  823. )
  824. biggest_company.refresh_from_db()
  825. self.assertEqual(biggest_company.num_employees, 100001)
  826. @skipUnlessDBFeature("supports_over_clause")
  827. def test_aggregate_rawsql_annotation(self):
  828. with self.assertNumQueries(1) as ctx:
  829. aggregate = Company.objects.annotate(
  830. salary=RawSQL("SUM(num_chairs) OVER (ORDER BY num_employees)", []),
  831. ).aggregate(
  832. count=Count("pk"),
  833. )
  834. self.assertEqual(aggregate, {"count": 3})
  835. sql = ctx.captured_queries[0]["sql"]
  836. self.assertNotIn("GROUP BY", sql)
  837. def test_explicit_output_field(self):
  838. class FuncA(Func):
  839. output_field = CharField()
  840. class FuncB(Func):
  841. pass
  842. expr = FuncB(FuncA())
  843. self.assertEqual(expr.output_field, FuncA.output_field)
  844. def test_outerref_mixed_case_table_name(self):
  845. inner = Result.objects.filter(result_time__gte=OuterRef("experiment__assigned"))
  846. outer = Result.objects.filter(pk__in=Subquery(inner.values("pk")))
  847. self.assertFalse(outer.exists())
  848. def test_outerref_with_operator(self):
  849. inner = Company.objects.filter(num_employees=OuterRef("ceo__salary") + 2)
  850. outer = Company.objects.filter(pk__in=Subquery(inner.values("pk")))
  851. self.assertEqual(outer.get().name, "Test GmbH")
  852. def test_nested_outerref_with_function(self):
  853. self.gmbh.point_of_contact = Employee.objects.get(lastname="Meyer")
  854. self.gmbh.save()
  855. inner = Employee.objects.filter(
  856. lastname__startswith=Left(OuterRef(OuterRef("lastname")), 1),
  857. )
  858. qs = Employee.objects.annotate(
  859. ceo_company=Subquery(
  860. Company.objects.filter(
  861. point_of_contact__in=inner,
  862. ceo__pk=OuterRef("pk"),
  863. ).values("name"),
  864. ),
  865. ).filter(ceo_company__isnull=False)
  866. self.assertEqual(qs.get().ceo_company, "Test GmbH")
  867. def test_annotation_with_outerref(self):
  868. gmbh_salary = Company.objects.annotate(
  869. max_ceo_salary_raise=Subquery(
  870. Company.objects.annotate(
  871. salary_raise=OuterRef("num_employees") + F("num_employees"),
  872. )
  873. .order_by("-salary_raise")
  874. .values("salary_raise")[:1],
  875. output_field=IntegerField(),
  876. ),
  877. ).get(pk=self.gmbh.pk)
  878. self.assertEqual(gmbh_salary.max_ceo_salary_raise, 2332)
  879. def test_annotation_with_nested_outerref(self):
  880. self.gmbh.point_of_contact = Employee.objects.get(lastname="Meyer")
  881. self.gmbh.save()
  882. inner = Employee.objects.annotate(
  883. outer_lastname=OuterRef(OuterRef("lastname")),
  884. ).filter(lastname__startswith=Left("outer_lastname", 1))
  885. qs = Employee.objects.annotate(
  886. ceo_company=Subquery(
  887. Company.objects.filter(
  888. point_of_contact__in=inner,
  889. ceo__pk=OuterRef("pk"),
  890. ).values("name"),
  891. ),
  892. ).filter(ceo_company__isnull=False)
  893. self.assertEqual(qs.get().ceo_company, "Test GmbH")
  894. def test_annotation_with_deeply_nested_outerref(self):
  895. bob = Employee.objects.create(firstname="Bob", based_in_eu=True)
  896. self.max.manager = Manager.objects.create(name="Rock", secretary=bob)
  897. self.max.save()
  898. qs = Employee.objects.filter(
  899. Exists(
  900. Manager.objects.filter(
  901. Exists(
  902. Employee.objects.filter(
  903. pk=OuterRef("secretary__pk"),
  904. )
  905. .annotate(
  906. secretary_based_in_eu=OuterRef(OuterRef("based_in_eu"))
  907. )
  908. .filter(
  909. Exists(
  910. Company.objects.filter(
  911. # Inner OuterRef refers to an outer
  912. # OuterRef (not ResolvedOuterRef).
  913. based_in_eu=OuterRef("secretary_based_in_eu")
  914. )
  915. )
  916. )
  917. ),
  918. secretary__pk=OuterRef("pk"),
  919. )
  920. )
  921. )
  922. self.assertEqual(qs.get(), bob)
  923. def test_pickle_expression(self):
  924. expr = Value(1)
  925. expr.convert_value # populate cached property
  926. self.assertEqual(pickle.loads(pickle.dumps(expr)), expr)
  927. def test_incorrect_field_in_F_expression(self):
  928. with self.assertRaisesMessage(
  929. FieldError, "Cannot resolve keyword 'nope' into field."
  930. ):
  931. list(Employee.objects.filter(firstname=F("nope")))
  932. def test_incorrect_joined_field_in_F_expression(self):
  933. with self.assertRaisesMessage(
  934. FieldError, "Cannot resolve keyword 'nope' into field."
  935. ):
  936. list(Company.objects.filter(ceo__pk=F("point_of_contact__nope")))
  937. def test_exists_in_filter(self):
  938. inner = Company.objects.filter(ceo=OuterRef("pk")).values("pk")
  939. qs1 = Employee.objects.filter(Exists(inner))
  940. qs2 = Employee.objects.annotate(found=Exists(inner)).filter(found=True)
  941. self.assertCountEqual(qs1, qs2)
  942. self.assertFalse(Employee.objects.exclude(Exists(inner)).exists())
  943. self.assertCountEqual(qs2, Employee.objects.exclude(~Exists(inner)))
  944. def test_subquery_in_filter(self):
  945. inner = Company.objects.filter(ceo=OuterRef("pk")).values("based_in_eu")
  946. self.assertSequenceEqual(
  947. Employee.objects.filter(Subquery(inner)),
  948. [self.foobar_ltd.ceo],
  949. )
  950. def test_subquery_group_by_outerref_in_filter(self):
  951. inner = (
  952. Company.objects.annotate(
  953. employee=OuterRef("pk"),
  954. )
  955. .values("employee")
  956. .annotate(
  957. min_num_chairs=Min("num_chairs"),
  958. )
  959. .values("ceo")
  960. )
  961. self.assertIs(Employee.objects.filter(pk__in=Subquery(inner)).exists(), True)
  962. def test_case_in_filter_if_boolean_output_field(self):
  963. is_ceo = Company.objects.filter(ceo=OuterRef("pk"))
  964. is_poc = Company.objects.filter(point_of_contact=OuterRef("pk"))
  965. qs = Employee.objects.filter(
  966. Case(
  967. When(Exists(is_ceo), then=True),
  968. When(Exists(is_poc), then=True),
  969. default=False,
  970. output_field=BooleanField(),
  971. ),
  972. )
  973. self.assertCountEqual(qs, [self.example_inc.ceo, self.foobar_ltd.ceo, self.max])
  974. def test_boolean_expression_combined(self):
  975. is_ceo = Company.objects.filter(ceo=OuterRef("pk"))
  976. is_poc = Company.objects.filter(point_of_contact=OuterRef("pk"))
  977. self.gmbh.point_of_contact = self.max
  978. self.gmbh.save()
  979. self.assertCountEqual(
  980. Employee.objects.filter(Exists(is_ceo) | Exists(is_poc)),
  981. [self.example_inc.ceo, self.foobar_ltd.ceo, self.max],
  982. )
  983. self.assertCountEqual(
  984. Employee.objects.filter(Exists(is_ceo) & Exists(is_poc)),
  985. [self.max],
  986. )
  987. self.assertCountEqual(
  988. Employee.objects.filter(Exists(is_ceo) & Q(salary__gte=30)),
  989. [self.max],
  990. )
  991. self.assertCountEqual(
  992. Employee.objects.filter(Exists(is_poc) | Q(salary__lt=15)),
  993. [self.example_inc.ceo, self.max],
  994. )
  995. self.assertCountEqual(
  996. Employee.objects.filter(Q(salary__gte=30) & Exists(is_ceo)),
  997. [self.max],
  998. )
  999. self.assertCountEqual(
  1000. Employee.objects.filter(Q(salary__lt=15) | Exists(is_poc)),
  1001. [self.example_inc.ceo, self.max],
  1002. )
  1003. def test_boolean_expression_combined_with_empty_Q(self):
  1004. is_poc = Company.objects.filter(point_of_contact=OuterRef("pk"))
  1005. self.gmbh.point_of_contact = self.max
  1006. self.gmbh.save()
  1007. tests = [
  1008. Exists(is_poc) & Q(),
  1009. Q() & Exists(is_poc),
  1010. Exists(is_poc) | Q(),
  1011. Q() | Exists(is_poc),
  1012. Q(Exists(is_poc)) & Q(),
  1013. Q() & Q(Exists(is_poc)),
  1014. Q(Exists(is_poc)) | Q(),
  1015. Q() | Q(Exists(is_poc)),
  1016. ]
  1017. for conditions in tests:
  1018. with self.subTest(conditions):
  1019. self.assertCountEqual(Employee.objects.filter(conditions), [self.max])
  1020. def test_boolean_expression_in_Q(self):
  1021. is_poc = Company.objects.filter(point_of_contact=OuterRef("pk"))
  1022. self.gmbh.point_of_contact = self.max
  1023. self.gmbh.save()
  1024. self.assertCountEqual(Employee.objects.filter(Q(Exists(is_poc))), [self.max])
  1025. class IterableLookupInnerExpressionsTests(TestCase):
  1026. @classmethod
  1027. def setUpTestData(cls):
  1028. ceo = Employee.objects.create(firstname="Just", lastname="Doit", salary=30)
  1029. # MySQL requires that the values calculated for expressions don't pass
  1030. # outside of the field's range, so it's inconvenient to use the values
  1031. # in the more general tests.
  1032. cls.c5020 = Company.objects.create(
  1033. name="5020 Ltd", num_employees=50, num_chairs=20, ceo=ceo
  1034. )
  1035. cls.c5040 = Company.objects.create(
  1036. name="5040 Ltd", num_employees=50, num_chairs=40, ceo=ceo
  1037. )
  1038. cls.c5050 = Company.objects.create(
  1039. name="5050 Ltd", num_employees=50, num_chairs=50, ceo=ceo
  1040. )
  1041. cls.c5060 = Company.objects.create(
  1042. name="5060 Ltd", num_employees=50, num_chairs=60, ceo=ceo
  1043. )
  1044. cls.c99300 = Company.objects.create(
  1045. name="99300 Ltd", num_employees=99, num_chairs=300, ceo=ceo
  1046. )
  1047. def test_in_lookup_allows_F_expressions_and_expressions_for_integers(self):
  1048. # __in lookups can use F() expressions for integers.
  1049. queryset = Company.objects.filter(num_employees__in=([F("num_chairs") - 10]))
  1050. self.assertSequenceEqual(queryset, [self.c5060])
  1051. self.assertCountEqual(
  1052. Company.objects.filter(
  1053. num_employees__in=([F("num_chairs") - 10, F("num_chairs") + 10])
  1054. ),
  1055. [self.c5040, self.c5060],
  1056. )
  1057. self.assertCountEqual(
  1058. Company.objects.filter(
  1059. num_employees__in=(
  1060. [F("num_chairs") - 10, F("num_chairs"), F("num_chairs") + 10]
  1061. )
  1062. ),
  1063. [self.c5040, self.c5050, self.c5060],
  1064. )
  1065. def test_expressions_range_lookups_join_choice(self):
  1066. midpoint = datetime.time(13, 0)
  1067. t1 = Time.objects.create(time=datetime.time(12, 0))
  1068. t2 = Time.objects.create(time=datetime.time(14, 0))
  1069. s1 = SimulationRun.objects.create(start=t1, end=t2, midpoint=midpoint)
  1070. SimulationRun.objects.create(start=t1, end=None, midpoint=midpoint)
  1071. SimulationRun.objects.create(start=None, end=t2, midpoint=midpoint)
  1072. SimulationRun.objects.create(start=None, end=None, midpoint=midpoint)
  1073. queryset = SimulationRun.objects.filter(
  1074. midpoint__range=[F("start__time"), F("end__time")]
  1075. )
  1076. self.assertSequenceEqual(queryset, [s1])
  1077. for alias in queryset.query.alias_map.values():
  1078. if isinstance(alias, Join):
  1079. self.assertEqual(alias.join_type, constants.INNER)
  1080. queryset = SimulationRun.objects.exclude(
  1081. midpoint__range=[F("start__time"), F("end__time")]
  1082. )
  1083. self.assertQuerySetEqual(queryset, [], ordered=False)
  1084. for alias in queryset.query.alias_map.values():
  1085. if isinstance(alias, Join):
  1086. self.assertEqual(alias.join_type, constants.LOUTER)
  1087. def test_range_lookup_allows_F_expressions_and_expressions_for_integers(self):
  1088. # Range lookups can use F() expressions for integers.
  1089. Company.objects.filter(num_employees__exact=F("num_chairs"))
  1090. self.assertCountEqual(
  1091. Company.objects.filter(num_employees__range=(F("num_chairs"), 100)),
  1092. [self.c5020, self.c5040, self.c5050],
  1093. )
  1094. self.assertCountEqual(
  1095. Company.objects.filter(
  1096. num_employees__range=(F("num_chairs") - 10, F("num_chairs") + 10)
  1097. ),
  1098. [self.c5040, self.c5050, self.c5060],
  1099. )
  1100. self.assertCountEqual(
  1101. Company.objects.filter(num_employees__range=(F("num_chairs") - 10, 100)),
  1102. [self.c5020, self.c5040, self.c5050, self.c5060],
  1103. )
  1104. self.assertCountEqual(
  1105. Company.objects.filter(num_employees__range=(1, 100)),
  1106. [self.c5020, self.c5040, self.c5050, self.c5060, self.c99300],
  1107. )
  1108. def test_range_lookup_namedtuple(self):
  1109. EmployeeRange = namedtuple("EmployeeRange", ["minimum", "maximum"])
  1110. qs = Company.objects.filter(
  1111. num_employees__range=EmployeeRange(minimum=51, maximum=100),
  1112. )
  1113. self.assertSequenceEqual(qs, [self.c99300])
  1114. @unittest.skipUnless(
  1115. connection.vendor == "sqlite",
  1116. "This defensive test only works on databases that don't validate parameter "
  1117. "types",
  1118. )
  1119. def test_expressions_not_introduce_sql_injection_via_untrusted_string_inclusion(
  1120. self,
  1121. ):
  1122. """
  1123. This tests that SQL injection isn't possible using compilation of
  1124. expressions in iterable filters, as their compilation happens before
  1125. the main query compilation. It's limited to SQLite, as PostgreSQL,
  1126. Oracle and other vendors have defense in depth against this by type
  1127. checking. Testing against SQLite (the most permissive of the built-in
  1128. databases) demonstrates that the problem doesn't exist while keeping
  1129. the test simple.
  1130. """
  1131. queryset = Company.objects.filter(name__in=[F("num_chairs") + "1)) OR ((1==1"])
  1132. self.assertQuerySetEqual(queryset, [], ordered=False)
  1133. def test_range_lookup_allows_F_expressions_and_expressions_for_dates(self):
  1134. start = datetime.datetime(2016, 2, 3, 15, 0, 0)
  1135. end = datetime.datetime(2016, 2, 5, 15, 0, 0)
  1136. experiment_1 = Experiment.objects.create(
  1137. name="Integrity testing",
  1138. assigned=start.date(),
  1139. start=start,
  1140. end=end,
  1141. completed=end.date(),
  1142. estimated_time=end - start,
  1143. )
  1144. experiment_2 = Experiment.objects.create(
  1145. name="Taste testing",
  1146. assigned=start.date(),
  1147. start=start,
  1148. end=end,
  1149. completed=end.date(),
  1150. estimated_time=end - start,
  1151. )
  1152. r1 = Result.objects.create(
  1153. experiment=experiment_1,
  1154. result_time=datetime.datetime(2016, 2, 4, 15, 0, 0),
  1155. )
  1156. Result.objects.create(
  1157. experiment=experiment_1,
  1158. result_time=datetime.datetime(2016, 3, 10, 2, 0, 0),
  1159. )
  1160. Result.objects.create(
  1161. experiment=experiment_2,
  1162. result_time=datetime.datetime(2016, 1, 8, 5, 0, 0),
  1163. )
  1164. tests = [
  1165. # Datetimes.
  1166. ([F("experiment__start"), F("experiment__end")], "result_time__range"),
  1167. # Dates.
  1168. (
  1169. [F("experiment__start__date"), F("experiment__end__date")],
  1170. "result_time__date__range",
  1171. ),
  1172. ]
  1173. for within_experiment_time, lookup in tests:
  1174. with self.subTest(lookup=lookup):
  1175. queryset = Result.objects.filter(**{lookup: within_experiment_time})
  1176. self.assertSequenceEqual(queryset, [r1])
  1177. def test_relabeled_clone_rhs(self):
  1178. Number.objects.bulk_create([Number(integer=1), Number(integer=2)])
  1179. self.assertIs(
  1180. Number.objects.filter(
  1181. # Ensure iterable of expressions are properly re-labelled on
  1182. # subquery pushdown. If the inner query __range right-hand-side
  1183. # members are not relabelled they will point at the outer query
  1184. # alias and this test will fail.
  1185. Exists(
  1186. Number.objects.exclude(pk=OuterRef("pk")).filter(
  1187. integer__range=(F("integer"), F("integer"))
  1188. )
  1189. )
  1190. ).exists(),
  1191. True,
  1192. )
  1193. class FTests(SimpleTestCase):
  1194. def test_deepcopy(self):
  1195. f = F("foo")
  1196. g = deepcopy(f)
  1197. self.assertEqual(f.name, g.name)
  1198. def test_deconstruct(self):
  1199. f = F("name")
  1200. path, args, kwargs = f.deconstruct()
  1201. self.assertEqual(path, "django.db.models.F")
  1202. self.assertEqual(args, (f.name,))
  1203. self.assertEqual(kwargs, {})
  1204. def test_equal(self):
  1205. f = F("name")
  1206. same_f = F("name")
  1207. other_f = F("username")
  1208. self.assertEqual(f, same_f)
  1209. self.assertNotEqual(f, other_f)
  1210. def test_hash(self):
  1211. d = {F("name"): "Bob"}
  1212. self.assertIn(F("name"), d)
  1213. self.assertEqual(d[F("name")], "Bob")
  1214. def test_not_equal_Value(self):
  1215. f = F("name")
  1216. value = Value("name")
  1217. self.assertNotEqual(f, value)
  1218. self.assertNotEqual(value, f)
  1219. def test_contains(self):
  1220. msg = "argument of type 'F' is not iterable"
  1221. with self.assertRaisesMessage(TypeError, msg):
  1222. "" in F("name")
  1223. class ExpressionsTests(TestCase):
  1224. def test_F_reuse(self):
  1225. f = F("id")
  1226. n = Number.objects.create(integer=-1)
  1227. c = Company.objects.create(
  1228. name="Example Inc.",
  1229. num_employees=2300,
  1230. num_chairs=5,
  1231. ceo=Employee.objects.create(firstname="Joe", lastname="Smith"),
  1232. )
  1233. c_qs = Company.objects.filter(id=f)
  1234. self.assertEqual(c_qs.get(), c)
  1235. # Reuse the same F-object for another queryset
  1236. n_qs = Number.objects.filter(id=f)
  1237. self.assertEqual(n_qs.get(), n)
  1238. # The original query still works correctly
  1239. self.assertEqual(c_qs.get(), c)
  1240. def test_patterns_escape(self):
  1241. r"""
  1242. Special characters (e.g. %, _ and \) stored in database are
  1243. properly escaped when using a pattern lookup with an expression
  1244. refs #16731
  1245. """
  1246. Employee.objects.bulk_create(
  1247. [
  1248. Employee(firstname="Johnny", lastname="%John"),
  1249. Employee(firstname="Jean-Claude", lastname="Claud_"),
  1250. Employee(firstname="Jean-Claude", lastname="Claude%"),
  1251. Employee(firstname="Johnny", lastname="Joh\\n"),
  1252. Employee(firstname="Johnny", lastname="_ohn"),
  1253. ]
  1254. )
  1255. claude = Employee.objects.create(firstname="Jean-Claude", lastname="Claude")
  1256. john = Employee.objects.create(firstname="Johnny", lastname="John")
  1257. john_sign = Employee.objects.create(firstname="%Joh\\nny", lastname="%Joh\\n")
  1258. self.assertCountEqual(
  1259. Employee.objects.filter(firstname__contains=F("lastname")),
  1260. [john_sign, john, claude],
  1261. )
  1262. self.assertCountEqual(
  1263. Employee.objects.filter(firstname__startswith=F("lastname")),
  1264. [john_sign, john],
  1265. )
  1266. self.assertSequenceEqual(
  1267. Employee.objects.filter(firstname__endswith=F("lastname")),
  1268. [claude],
  1269. )
  1270. def test_insensitive_patterns_escape(self):
  1271. r"""
  1272. Special characters (e.g. %, _ and \) stored in database are
  1273. properly escaped when using a case insensitive pattern lookup with an
  1274. expression -- refs #16731
  1275. """
  1276. Employee.objects.bulk_create(
  1277. [
  1278. Employee(firstname="Johnny", lastname="%john"),
  1279. Employee(firstname="Jean-Claude", lastname="claud_"),
  1280. Employee(firstname="Jean-Claude", lastname="claude%"),
  1281. Employee(firstname="Johnny", lastname="joh\\n"),
  1282. Employee(firstname="Johnny", lastname="_ohn"),
  1283. ]
  1284. )
  1285. claude = Employee.objects.create(firstname="Jean-Claude", lastname="claude")
  1286. john = Employee.objects.create(firstname="Johnny", lastname="john")
  1287. john_sign = Employee.objects.create(firstname="%Joh\\nny", lastname="%joh\\n")
  1288. self.assertCountEqual(
  1289. Employee.objects.filter(firstname__icontains=F("lastname")),
  1290. [john_sign, john, claude],
  1291. )
  1292. self.assertCountEqual(
  1293. Employee.objects.filter(firstname__istartswith=F("lastname")),
  1294. [john_sign, john],
  1295. )
  1296. self.assertSequenceEqual(
  1297. Employee.objects.filter(firstname__iendswith=F("lastname")),
  1298. [claude],
  1299. )
  1300. @isolate_apps("expressions")
  1301. class SimpleExpressionTests(SimpleTestCase):
  1302. def test_equal(self):
  1303. self.assertEqual(Expression(), Expression())
  1304. self.assertEqual(
  1305. Expression(IntegerField()), Expression(output_field=IntegerField())
  1306. )
  1307. self.assertEqual(Expression(IntegerField()), mock.ANY)
  1308. self.assertNotEqual(Expression(IntegerField()), Expression(CharField()))
  1309. class TestModel(Model):
  1310. field = IntegerField()
  1311. other_field = IntegerField()
  1312. self.assertNotEqual(
  1313. Expression(TestModel._meta.get_field("field")),
  1314. Expression(TestModel._meta.get_field("other_field")),
  1315. )
  1316. class InitCaptureExpression(Expression):
  1317. def __init__(self, *args, **kwargs):
  1318. super().__init__(*args, **kwargs)
  1319. # The identity of expressions that obscure their __init__() signature
  1320. # with *args and **kwargs cannot be determined when bound with
  1321. # different combinations or *args and **kwargs.
  1322. self.assertNotEqual(
  1323. InitCaptureExpression(IntegerField()),
  1324. InitCaptureExpression(output_field=IntegerField()),
  1325. )
  1326. # However, they should be considered equal when their bindings are
  1327. # equal.
  1328. self.assertEqual(
  1329. InitCaptureExpression(IntegerField()),
  1330. InitCaptureExpression(IntegerField()),
  1331. )
  1332. self.assertEqual(
  1333. InitCaptureExpression(output_field=IntegerField()),
  1334. InitCaptureExpression(output_field=IntegerField()),
  1335. )
  1336. def test_hash(self):
  1337. self.assertEqual(hash(Expression()), hash(Expression()))
  1338. self.assertEqual(
  1339. hash(Expression(IntegerField())),
  1340. hash(Expression(output_field=IntegerField())),
  1341. )
  1342. self.assertNotEqual(
  1343. hash(Expression(IntegerField())),
  1344. hash(Expression(CharField())),
  1345. )
  1346. class TestModel(Model):
  1347. field = IntegerField()
  1348. other_field = IntegerField()
  1349. self.assertNotEqual(
  1350. hash(Expression(TestModel._meta.get_field("field"))),
  1351. hash(Expression(TestModel._meta.get_field("other_field"))),
  1352. )
  1353. def test_get_expression_for_validation_only_one_source_expression(self):
  1354. expression = Expression()
  1355. expression.constraint_validation_compatible = False
  1356. msg = (
  1357. "Expressions with constraint_validation_compatible set to False must have "
  1358. "only one source expression."
  1359. )
  1360. with self.assertRaisesMessage(ValueError, msg):
  1361. expression.get_expression_for_validation()
  1362. class ExpressionsNumericTests(TestCase):
  1363. @classmethod
  1364. def setUpTestData(cls):
  1365. Number(integer=-1).save()
  1366. Number(integer=42).save()
  1367. Number(integer=1337).save()
  1368. Number.objects.update(float=F("integer"))
  1369. def test_fill_with_value_from_same_object(self):
  1370. """
  1371. We can fill a value in all objects with an other value of the
  1372. same object.
  1373. """
  1374. self.assertQuerySetEqual(
  1375. Number.objects.all(),
  1376. [(-1, -1), (42, 42), (1337, 1337)],
  1377. lambda n: (n.integer, round(n.float)),
  1378. ordered=False,
  1379. )
  1380. def test_increment_value(self):
  1381. """
  1382. We can increment a value of all objects in a query set.
  1383. """
  1384. self.assertEqual(
  1385. Number.objects.filter(integer__gt=0).update(integer=F("integer") + 1), 2
  1386. )
  1387. self.assertQuerySetEqual(
  1388. Number.objects.all(),
  1389. [(-1, -1), (43, 42), (1338, 1337)],
  1390. lambda n: (n.integer, round(n.float)),
  1391. ordered=False,
  1392. )
  1393. def test_filter_not_equals_other_field(self):
  1394. """
  1395. We can filter for objects, where a value is not equals the value
  1396. of an other field.
  1397. """
  1398. self.assertEqual(
  1399. Number.objects.filter(integer__gt=0).update(integer=F("integer") + 1), 2
  1400. )
  1401. self.assertQuerySetEqual(
  1402. Number.objects.exclude(float=F("integer")),
  1403. [(43, 42), (1338, 1337)],
  1404. lambda n: (n.integer, round(n.float)),
  1405. ordered=False,
  1406. )
  1407. def test_filter_decimal_expression(self):
  1408. obj = Number.objects.create(integer=0, float=1, decimal_value=Decimal("1"))
  1409. qs = Number.objects.annotate(
  1410. x=ExpressionWrapper(Value(1), output_field=DecimalField()),
  1411. ).filter(Q(x=1, integer=0) & Q(x=Decimal("1")))
  1412. self.assertSequenceEqual(qs, [obj])
  1413. def test_complex_expressions(self):
  1414. """
  1415. Complex expressions of different connection types are possible.
  1416. """
  1417. n = Number.objects.create(integer=10, float=123.45)
  1418. self.assertEqual(
  1419. Number.objects.filter(pk=n.pk).update(float=F("integer") + F("float") * 2),
  1420. 1,
  1421. )
  1422. self.assertEqual(Number.objects.get(pk=n.pk).integer, 10)
  1423. self.assertEqual(
  1424. Number.objects.get(pk=n.pk).float, Approximate(256.900, places=3)
  1425. )
  1426. def test_decimal_expression(self):
  1427. n = Number.objects.create(integer=1, decimal_value=Decimal("0.5"))
  1428. n.decimal_value = F("decimal_value") - Decimal("0.4")
  1429. n.save()
  1430. n.refresh_from_db()
  1431. self.assertEqual(n.decimal_value, Decimal("0.1"))
  1432. class ExpressionOperatorTests(TestCase):
  1433. @classmethod
  1434. def setUpTestData(cls):
  1435. cls.n = Number.objects.create(integer=42, float=15.5)
  1436. cls.n1 = Number.objects.create(integer=-42, float=-15.5)
  1437. def test_lefthand_addition(self):
  1438. # LH Addition of floats and integers
  1439. Number.objects.filter(pk=self.n.pk).update(
  1440. integer=F("integer") + 15, float=F("float") + 42.7
  1441. )
  1442. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 57)
  1443. self.assertEqual(
  1444. Number.objects.get(pk=self.n.pk).float, Approximate(58.200, places=3)
  1445. )
  1446. def test_lefthand_subtraction(self):
  1447. # LH Subtraction of floats and integers
  1448. Number.objects.filter(pk=self.n.pk).update(
  1449. integer=F("integer") - 15, float=F("float") - 42.7
  1450. )
  1451. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 27)
  1452. self.assertEqual(
  1453. Number.objects.get(pk=self.n.pk).float, Approximate(-27.200, places=3)
  1454. )
  1455. def test_lefthand_multiplication(self):
  1456. # Multiplication of floats and integers
  1457. Number.objects.filter(pk=self.n.pk).update(
  1458. integer=F("integer") * 15, float=F("float") * 42.7
  1459. )
  1460. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 630)
  1461. self.assertEqual(
  1462. Number.objects.get(pk=self.n.pk).float, Approximate(661.850, places=3)
  1463. )
  1464. def test_lefthand_division(self):
  1465. # LH Division of floats and integers
  1466. Number.objects.filter(pk=self.n.pk).update(
  1467. integer=F("integer") / 2, float=F("float") / 42.7
  1468. )
  1469. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 21)
  1470. self.assertEqual(
  1471. Number.objects.get(pk=self.n.pk).float, Approximate(0.363, places=3)
  1472. )
  1473. def test_lefthand_modulo(self):
  1474. # LH Modulo arithmetic on integers
  1475. Number.objects.filter(pk=self.n.pk).update(integer=F("integer") % 20)
  1476. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 2)
  1477. def test_lefthand_modulo_null(self):
  1478. # LH Modulo arithmetic on integers.
  1479. Employee.objects.create(firstname="John", lastname="Doe", salary=None)
  1480. qs = Employee.objects.annotate(modsalary=F("salary") % 20)
  1481. self.assertIsNone(qs.get().salary)
  1482. def test_lefthand_bitwise_and(self):
  1483. # LH Bitwise ands on integers
  1484. Number.objects.filter(pk=self.n.pk).update(integer=F("integer").bitand(56))
  1485. Number.objects.filter(pk=self.n1.pk).update(integer=F("integer").bitand(-56))
  1486. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 40)
  1487. self.assertEqual(Number.objects.get(pk=self.n1.pk).integer, -64)
  1488. def test_lefthand_bitwise_left_shift_operator(self):
  1489. Number.objects.update(integer=F("integer").bitleftshift(2))
  1490. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 168)
  1491. self.assertEqual(Number.objects.get(pk=self.n1.pk).integer, -168)
  1492. def test_lefthand_bitwise_right_shift_operator(self):
  1493. Number.objects.update(integer=F("integer").bitrightshift(2))
  1494. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 10)
  1495. self.assertEqual(Number.objects.get(pk=self.n1.pk).integer, -11)
  1496. def test_lefthand_bitwise_or(self):
  1497. # LH Bitwise or on integers
  1498. Number.objects.update(integer=F("integer").bitor(48))
  1499. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 58)
  1500. self.assertEqual(Number.objects.get(pk=self.n1.pk).integer, -10)
  1501. def test_lefthand_transformed_field_bitwise_or(self):
  1502. Employee.objects.create(firstname="Max", lastname="Mustermann")
  1503. with register_lookup(CharField, Length):
  1504. qs = Employee.objects.annotate(bitor=F("lastname__length").bitor(48))
  1505. self.assertEqual(qs.get().bitor, 58)
  1506. def test_lefthand_power(self):
  1507. # LH Power arithmetic operation on floats and integers
  1508. Number.objects.filter(pk=self.n.pk).update(
  1509. integer=F("integer") ** 2, float=F("float") ** 1.5
  1510. )
  1511. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 1764)
  1512. self.assertEqual(
  1513. Number.objects.get(pk=self.n.pk).float, Approximate(61.02, places=2)
  1514. )
  1515. def test_lefthand_bitwise_xor(self):
  1516. Number.objects.update(integer=F("integer").bitxor(48))
  1517. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 26)
  1518. self.assertEqual(Number.objects.get(pk=self.n1.pk).integer, -26)
  1519. def test_lefthand_bitwise_xor_null(self):
  1520. employee = Employee.objects.create(firstname="John", lastname="Doe")
  1521. Employee.objects.update(salary=F("salary").bitxor(48))
  1522. employee.refresh_from_db()
  1523. self.assertIsNone(employee.salary)
  1524. def test_lefthand_bitwise_xor_right_null(self):
  1525. employee = Employee.objects.create(firstname="John", lastname="Doe", salary=48)
  1526. Employee.objects.update(salary=F("salary").bitxor(None))
  1527. employee.refresh_from_db()
  1528. self.assertIsNone(employee.salary)
  1529. @unittest.skipUnless(
  1530. connection.vendor == "oracle", "Oracle doesn't support bitwise XOR."
  1531. )
  1532. def test_lefthand_bitwise_xor_not_supported(self):
  1533. msg = "Bitwise XOR is not supported in Oracle."
  1534. with self.assertRaisesMessage(NotSupportedError, msg):
  1535. Number.objects.update(integer=F("integer").bitxor(48))
  1536. def test_right_hand_addition(self):
  1537. # Right hand operators
  1538. Number.objects.filter(pk=self.n.pk).update(
  1539. integer=15 + F("integer"), float=42.7 + F("float")
  1540. )
  1541. # RH Addition of floats and integers
  1542. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 57)
  1543. self.assertEqual(
  1544. Number.objects.get(pk=self.n.pk).float, Approximate(58.200, places=3)
  1545. )
  1546. def test_right_hand_subtraction(self):
  1547. Number.objects.filter(pk=self.n.pk).update(
  1548. integer=15 - F("integer"), float=42.7 - F("float")
  1549. )
  1550. # RH Subtraction of floats and integers
  1551. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, -27)
  1552. self.assertEqual(
  1553. Number.objects.get(pk=self.n.pk).float, Approximate(27.200, places=3)
  1554. )
  1555. def test_right_hand_multiplication(self):
  1556. # RH Multiplication of floats and integers
  1557. Number.objects.filter(pk=self.n.pk).update(
  1558. integer=15 * F("integer"), float=42.7 * F("float")
  1559. )
  1560. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 630)
  1561. self.assertEqual(
  1562. Number.objects.get(pk=self.n.pk).float, Approximate(661.850, places=3)
  1563. )
  1564. def test_right_hand_division(self):
  1565. # RH Division of floats and integers
  1566. Number.objects.filter(pk=self.n.pk).update(
  1567. integer=640 / F("integer"), float=42.7 / F("float")
  1568. )
  1569. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 15)
  1570. self.assertEqual(
  1571. Number.objects.get(pk=self.n.pk).float, Approximate(2.755, places=3)
  1572. )
  1573. def test_right_hand_modulo(self):
  1574. # RH Modulo arithmetic on integers
  1575. Number.objects.filter(pk=self.n.pk).update(integer=69 % F("integer"))
  1576. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 27)
  1577. def test_righthand_power(self):
  1578. # RH Power arithmetic operation on floats and integers
  1579. Number.objects.filter(pk=self.n.pk).update(
  1580. integer=2 ** F("integer"), float=1.5 ** F("float")
  1581. )
  1582. self.assertEqual(Number.objects.get(pk=self.n.pk).integer, 4398046511104)
  1583. self.assertEqual(
  1584. Number.objects.get(pk=self.n.pk).float, Approximate(536.308, places=3)
  1585. )
  1586. class FTimeDeltaTests(TestCase):
  1587. @classmethod
  1588. def setUpTestData(cls):
  1589. cls.sday = sday = datetime.date(2010, 6, 25)
  1590. cls.stime = stime = datetime.datetime(2010, 6, 25, 12, 15, 30, 747000)
  1591. midnight = datetime.time(0)
  1592. delta0 = datetime.timedelta(0)
  1593. delta1 = datetime.timedelta(microseconds=253000)
  1594. delta2 = datetime.timedelta(seconds=44)
  1595. delta3 = datetime.timedelta(hours=21, minutes=8)
  1596. delta4 = datetime.timedelta(days=10)
  1597. delta5 = datetime.timedelta(days=90)
  1598. # Test data is set so that deltas and delays will be
  1599. # strictly increasing.
  1600. cls.deltas = []
  1601. cls.delays = []
  1602. cls.days_long = []
  1603. # e0: started same day as assigned, zero duration
  1604. end = stime + delta0
  1605. cls.e0 = Experiment.objects.create(
  1606. name="e0",
  1607. assigned=sday,
  1608. start=stime,
  1609. end=end,
  1610. completed=end.date(),
  1611. estimated_time=delta0,
  1612. )
  1613. cls.deltas.append(delta0)
  1614. cls.delays.append(
  1615. cls.e0.start - datetime.datetime.combine(cls.e0.assigned, midnight)
  1616. )
  1617. cls.days_long.append(cls.e0.completed - cls.e0.assigned)
  1618. # e1: started one day after assigned, tiny duration, data
  1619. # set so that end time has no fractional seconds, which
  1620. # tests an edge case on sqlite.
  1621. delay = datetime.timedelta(1)
  1622. end = stime + delay + delta1
  1623. e1 = Experiment.objects.create(
  1624. name="e1",
  1625. assigned=sday,
  1626. start=stime + delay,
  1627. end=end,
  1628. completed=end.date(),
  1629. estimated_time=delta1,
  1630. )
  1631. cls.deltas.append(delta1)
  1632. cls.delays.append(e1.start - datetime.datetime.combine(e1.assigned, midnight))
  1633. cls.days_long.append(e1.completed - e1.assigned)
  1634. # e2: started three days after assigned, small duration
  1635. end = stime + delta2
  1636. e2 = Experiment.objects.create(
  1637. name="e2",
  1638. assigned=sday - datetime.timedelta(3),
  1639. start=stime,
  1640. end=end,
  1641. completed=end.date(),
  1642. estimated_time=datetime.timedelta(hours=1),
  1643. )
  1644. cls.deltas.append(delta2)
  1645. cls.delays.append(e2.start - datetime.datetime.combine(e2.assigned, midnight))
  1646. cls.days_long.append(e2.completed - e2.assigned)
  1647. # e3: started four days after assigned, medium duration
  1648. delay = datetime.timedelta(4)
  1649. end = stime + delay + delta3
  1650. e3 = Experiment.objects.create(
  1651. name="e3",
  1652. assigned=sday,
  1653. start=stime + delay,
  1654. end=end,
  1655. completed=end.date(),
  1656. estimated_time=delta3,
  1657. )
  1658. cls.deltas.append(delta3)
  1659. cls.delays.append(e3.start - datetime.datetime.combine(e3.assigned, midnight))
  1660. cls.days_long.append(e3.completed - e3.assigned)
  1661. # e4: started 10 days after assignment, long duration
  1662. end = stime + delta4
  1663. e4 = Experiment.objects.create(
  1664. name="e4",
  1665. assigned=sday - datetime.timedelta(10),
  1666. start=stime,
  1667. end=end,
  1668. completed=end.date(),
  1669. estimated_time=delta4 - datetime.timedelta(1),
  1670. )
  1671. cls.deltas.append(delta4)
  1672. cls.delays.append(e4.start - datetime.datetime.combine(e4.assigned, midnight))
  1673. cls.days_long.append(e4.completed - e4.assigned)
  1674. # e5: started a month after assignment, very long duration
  1675. delay = datetime.timedelta(30)
  1676. end = stime + delay + delta5
  1677. e5 = Experiment.objects.create(
  1678. name="e5",
  1679. assigned=sday,
  1680. start=stime + delay,
  1681. end=end,
  1682. completed=end.date(),
  1683. estimated_time=delta5,
  1684. )
  1685. cls.deltas.append(delta5)
  1686. cls.delays.append(e5.start - datetime.datetime.combine(e5.assigned, midnight))
  1687. cls.days_long.append(e5.completed - e5.assigned)
  1688. cls.expnames = [e.name for e in Experiment.objects.all()]
  1689. def test_multiple_query_compilation(self):
  1690. # Ticket #21643
  1691. queryset = Experiment.objects.filter(
  1692. end__lt=F("start") + datetime.timedelta(hours=1)
  1693. )
  1694. q1 = str(queryset.query)
  1695. q2 = str(queryset.query)
  1696. self.assertEqual(q1, q2)
  1697. def test_query_clone(self):
  1698. # Ticket #21643 - Crash when compiling query more than once
  1699. qs = Experiment.objects.filter(end__lt=F("start") + datetime.timedelta(hours=1))
  1700. qs2 = qs.all()
  1701. list(qs)
  1702. list(qs2)
  1703. # Intentionally no assert
  1704. def test_delta_add(self):
  1705. for i, delta in enumerate(self.deltas):
  1706. test_set = [
  1707. e.name for e in Experiment.objects.filter(end__lt=F("start") + delta)
  1708. ]
  1709. self.assertEqual(test_set, self.expnames[:i])
  1710. test_set = [
  1711. e.name for e in Experiment.objects.filter(end__lt=delta + F("start"))
  1712. ]
  1713. self.assertEqual(test_set, self.expnames[:i])
  1714. test_set = [
  1715. e.name for e in Experiment.objects.filter(end__lte=F("start") + delta)
  1716. ]
  1717. self.assertEqual(test_set, self.expnames[: i + 1])
  1718. def test_delta_subtract(self):
  1719. for i, delta in enumerate(self.deltas):
  1720. test_set = [
  1721. e.name for e in Experiment.objects.filter(start__gt=F("end") - delta)
  1722. ]
  1723. self.assertEqual(test_set, self.expnames[:i])
  1724. test_set = [
  1725. e.name for e in Experiment.objects.filter(start__gte=F("end") - delta)
  1726. ]
  1727. self.assertEqual(test_set, self.expnames[: i + 1])
  1728. def test_exclude(self):
  1729. for i, delta in enumerate(self.deltas):
  1730. test_set = [
  1731. e.name for e in Experiment.objects.exclude(end__lt=F("start") + delta)
  1732. ]
  1733. self.assertEqual(test_set, self.expnames[i:])
  1734. test_set = [
  1735. e.name for e in Experiment.objects.exclude(end__lte=F("start") + delta)
  1736. ]
  1737. self.assertEqual(test_set, self.expnames[i + 1 :])
  1738. def test_date_comparison(self):
  1739. for i, days in enumerate(self.days_long):
  1740. test_set = [
  1741. e.name
  1742. for e in Experiment.objects.filter(completed__lt=F("assigned") + days)
  1743. ]
  1744. self.assertEqual(test_set, self.expnames[:i])
  1745. test_set = [
  1746. e.name
  1747. for e in Experiment.objects.filter(completed__lte=F("assigned") + days)
  1748. ]
  1749. self.assertEqual(test_set, self.expnames[: i + 1])
  1750. def test_datetime_and_durationfield_addition_with_filter(self):
  1751. test_set = Experiment.objects.filter(end=F("start") + F("estimated_time"))
  1752. self.assertGreater(test_set.count(), 0)
  1753. self.assertEqual(
  1754. [e.name for e in test_set],
  1755. [
  1756. e.name
  1757. for e in Experiment.objects.all()
  1758. if e.end == e.start + e.estimated_time
  1759. ],
  1760. )
  1761. def test_datetime_and_duration_field_addition_with_annotate_and_no_output_field(
  1762. self,
  1763. ):
  1764. test_set = Experiment.objects.annotate(
  1765. estimated_end=F("start") + F("estimated_time")
  1766. )
  1767. self.assertEqual(
  1768. [e.estimated_end for e in test_set],
  1769. [e.start + e.estimated_time for e in test_set],
  1770. )
  1771. @skipUnlessDBFeature("supports_temporal_subtraction")
  1772. def test_datetime_subtraction_with_annotate_and_no_output_field(self):
  1773. test_set = Experiment.objects.annotate(
  1774. calculated_duration=F("end") - F("start")
  1775. )
  1776. self.assertEqual(
  1777. [e.calculated_duration for e in test_set],
  1778. [e.end - e.start for e in test_set],
  1779. )
  1780. def test_mixed_comparisons1(self):
  1781. for i, delay in enumerate(self.delays):
  1782. test_set = [
  1783. e.name
  1784. for e in Experiment.objects.filter(assigned__gt=F("start") - delay)
  1785. ]
  1786. self.assertEqual(test_set, self.expnames[:i])
  1787. test_set = [
  1788. e.name
  1789. for e in Experiment.objects.filter(assigned__gte=F("start") - delay)
  1790. ]
  1791. self.assertEqual(test_set, self.expnames[: i + 1])
  1792. def test_mixed_comparisons2(self):
  1793. for i, delay in enumerate(self.delays):
  1794. delay = datetime.timedelta(delay.days)
  1795. test_set = [
  1796. e.name
  1797. for e in Experiment.objects.filter(start__lt=F("assigned") + delay)
  1798. ]
  1799. self.assertEqual(test_set, self.expnames[:i])
  1800. test_set = [
  1801. e.name
  1802. for e in Experiment.objects.filter(
  1803. start__lte=F("assigned") + delay + datetime.timedelta(1)
  1804. )
  1805. ]
  1806. self.assertEqual(test_set, self.expnames[: i + 1])
  1807. def test_delta_update(self):
  1808. for delta in self.deltas:
  1809. exps = Experiment.objects.all()
  1810. expected_durations = [e.duration() for e in exps]
  1811. expected_starts = [e.start + delta for e in exps]
  1812. expected_ends = [e.end + delta for e in exps]
  1813. Experiment.objects.update(start=F("start") + delta, end=F("end") + delta)
  1814. exps = Experiment.objects.all()
  1815. new_starts = [e.start for e in exps]
  1816. new_ends = [e.end for e in exps]
  1817. new_durations = [e.duration() for e in exps]
  1818. self.assertEqual(expected_starts, new_starts)
  1819. self.assertEqual(expected_ends, new_ends)
  1820. self.assertEqual(expected_durations, new_durations)
  1821. def test_invalid_operator(self):
  1822. with self.assertRaises(DatabaseError):
  1823. list(Experiment.objects.filter(start=F("start") * datetime.timedelta(0)))
  1824. def test_durationfield_add(self):
  1825. zeros = [
  1826. e.name
  1827. for e in Experiment.objects.filter(start=F("start") + F("estimated_time"))
  1828. ]
  1829. self.assertEqual(zeros, ["e0"])
  1830. end_less = [
  1831. e.name
  1832. for e in Experiment.objects.filter(end__lt=F("start") + F("estimated_time"))
  1833. ]
  1834. self.assertEqual(end_less, ["e2"])
  1835. delta_math = [
  1836. e.name
  1837. for e in Experiment.objects.filter(
  1838. end__gte=F("start") + F("estimated_time") + datetime.timedelta(hours=1)
  1839. )
  1840. ]
  1841. self.assertEqual(delta_math, ["e4"])
  1842. queryset = Experiment.objects.annotate(
  1843. shifted=ExpressionWrapper(
  1844. F("start") + Value(None, output_field=DurationField()),
  1845. output_field=DateTimeField(),
  1846. )
  1847. )
  1848. self.assertIsNone(queryset.first().shifted)
  1849. def test_durationfield_multiply_divide(self):
  1850. Experiment.objects.update(scalar=2)
  1851. tests = [
  1852. (Decimal("2"), 2),
  1853. (F("scalar"), 2),
  1854. (2, 2),
  1855. (3.2, 3.2),
  1856. ]
  1857. for expr, scalar in tests:
  1858. with self.subTest(expr=expr):
  1859. qs = Experiment.objects.annotate(
  1860. multiplied=ExpressionWrapper(
  1861. expr * F("estimated_time"),
  1862. output_field=DurationField(),
  1863. ),
  1864. divided=ExpressionWrapper(
  1865. F("estimated_time") / expr,
  1866. output_field=DurationField(),
  1867. ),
  1868. )
  1869. for experiment in qs:
  1870. self.assertEqual(
  1871. experiment.multiplied,
  1872. experiment.estimated_time * scalar,
  1873. )
  1874. self.assertEqual(
  1875. experiment.divided,
  1876. experiment.estimated_time / scalar,
  1877. )
  1878. def test_duration_expressions(self):
  1879. for delta in self.deltas:
  1880. qs = Experiment.objects.annotate(duration=F("estimated_time") + delta)
  1881. for obj in qs:
  1882. self.assertEqual(obj.duration, obj.estimated_time + delta)
  1883. @skipUnlessDBFeature("supports_temporal_subtraction")
  1884. def test_date_subtraction(self):
  1885. queryset = Experiment.objects.annotate(
  1886. completion_duration=F("completed") - F("assigned"),
  1887. )
  1888. at_least_5_days = {
  1889. e.name
  1890. for e in queryset.filter(
  1891. completion_duration__gte=datetime.timedelta(days=5)
  1892. )
  1893. }
  1894. self.assertEqual(at_least_5_days, {"e3", "e4", "e5"})
  1895. at_least_120_days = {
  1896. e.name
  1897. for e in queryset.filter(
  1898. completion_duration__gte=datetime.timedelta(days=120)
  1899. )
  1900. }
  1901. self.assertEqual(at_least_120_days, {"e5"})
  1902. less_than_5_days = {
  1903. e.name
  1904. for e in queryset.filter(completion_duration__lt=datetime.timedelta(days=5))
  1905. }
  1906. self.assertEqual(less_than_5_days, {"e0", "e1", "e2"})
  1907. queryset = Experiment.objects.annotate(
  1908. difference=F("completed") - Value(None, output_field=DateField()),
  1909. )
  1910. self.assertIsNone(queryset.first().difference)
  1911. queryset = Experiment.objects.annotate(
  1912. shifted=ExpressionWrapper(
  1913. F("completed") - Value(None, output_field=DurationField()),
  1914. output_field=DateField(),
  1915. )
  1916. )
  1917. self.assertIsNone(queryset.first().shifted)
  1918. @skipUnlessDBFeature("supports_temporal_subtraction")
  1919. def test_date_subquery_subtraction(self):
  1920. subquery = Experiment.objects.filter(pk=OuterRef("pk")).values("completed")
  1921. queryset = Experiment.objects.annotate(
  1922. difference=subquery - F("completed"),
  1923. ).filter(difference=datetime.timedelta())
  1924. self.assertTrue(queryset.exists())
  1925. @skipUnlessDBFeature("supports_temporal_subtraction")
  1926. def test_date_case_subtraction(self):
  1927. queryset = Experiment.objects.annotate(
  1928. date_case=Case(
  1929. When(Q(name="e0"), then=F("completed")),
  1930. output_field=DateField(),
  1931. ),
  1932. completed_value=Value(
  1933. self.e0.completed,
  1934. output_field=DateField(),
  1935. ),
  1936. difference=F("date_case") - F("completed_value"),
  1937. ).filter(difference=datetime.timedelta())
  1938. self.assertEqual(queryset.get(), self.e0)
  1939. @skipUnlessDBFeature("supports_temporal_subtraction")
  1940. def test_time_subtraction(self):
  1941. Time.objects.create(time=datetime.time(12, 30, 15, 2345))
  1942. queryset = Time.objects.annotate(
  1943. difference=F("time") - Value(datetime.time(11, 15, 0)),
  1944. )
  1945. self.assertEqual(
  1946. queryset.get().difference,
  1947. datetime.timedelta(hours=1, minutes=15, seconds=15, microseconds=2345),
  1948. )
  1949. queryset = Time.objects.annotate(
  1950. difference=F("time") - Value(None, output_field=TimeField()),
  1951. )
  1952. self.assertIsNone(queryset.first().difference)
  1953. queryset = Time.objects.annotate(
  1954. shifted=ExpressionWrapper(
  1955. F("time") - Value(None, output_field=DurationField()),
  1956. output_field=TimeField(),
  1957. )
  1958. )
  1959. self.assertIsNone(queryset.first().shifted)
  1960. @skipUnlessDBFeature("supports_temporal_subtraction")
  1961. def test_time_subquery_subtraction(self):
  1962. Time.objects.create(time=datetime.time(12, 30, 15, 2345))
  1963. subquery = Time.objects.filter(pk=OuterRef("pk")).values("time")
  1964. queryset = Time.objects.annotate(
  1965. difference=subquery - F("time"),
  1966. ).filter(difference=datetime.timedelta())
  1967. self.assertTrue(queryset.exists())
  1968. @skipUnlessDBFeature("supports_temporal_subtraction")
  1969. def test_datetime_subtraction(self):
  1970. under_estimate = [
  1971. e.name
  1972. for e in Experiment.objects.filter(estimated_time__gt=F("end") - F("start"))
  1973. ]
  1974. self.assertEqual(under_estimate, ["e2"])
  1975. over_estimate = [
  1976. e.name
  1977. for e in Experiment.objects.filter(estimated_time__lt=F("end") - F("start"))
  1978. ]
  1979. self.assertEqual(over_estimate, ["e4"])
  1980. queryset = Experiment.objects.annotate(
  1981. difference=F("start") - Value(None, output_field=DateTimeField()),
  1982. )
  1983. self.assertIsNone(queryset.first().difference)
  1984. queryset = Experiment.objects.annotate(
  1985. shifted=ExpressionWrapper(
  1986. F("start") - Value(None, output_field=DurationField()),
  1987. output_field=DateTimeField(),
  1988. )
  1989. )
  1990. self.assertIsNone(queryset.first().shifted)
  1991. @skipUnlessDBFeature("supports_temporal_subtraction")
  1992. def test_datetime_subquery_subtraction(self):
  1993. subquery = Experiment.objects.filter(pk=OuterRef("pk")).values("start")
  1994. queryset = Experiment.objects.annotate(
  1995. difference=subquery - F("start"),
  1996. ).filter(difference=datetime.timedelta())
  1997. self.assertTrue(queryset.exists())
  1998. @skipUnlessDBFeature("supports_temporal_subtraction")
  1999. def test_datetime_subtraction_microseconds(self):
  2000. delta = datetime.timedelta(microseconds=8999999999999999)
  2001. Experiment.objects.update(end=F("start") + delta)
  2002. qs = Experiment.objects.annotate(delta=F("end") - F("start"))
  2003. for e in qs:
  2004. self.assertEqual(e.delta, delta)
  2005. def test_duration_with_datetime(self):
  2006. # Exclude e1 which has very high precision so we can test this on all
  2007. # backends regardless of whether or not it supports
  2008. # microsecond_precision.
  2009. over_estimate = (
  2010. Experiment.objects.exclude(name="e1")
  2011. .filter(
  2012. completed__gt=self.stime + F("estimated_time"),
  2013. )
  2014. .order_by("name")
  2015. )
  2016. self.assertQuerySetEqual(over_estimate, ["e3", "e4", "e5"], lambda e: e.name)
  2017. def test_duration_with_datetime_microseconds(self):
  2018. delta = datetime.timedelta(microseconds=8999999999999999)
  2019. qs = Experiment.objects.annotate(
  2020. dt=ExpressionWrapper(
  2021. F("start") + delta,
  2022. output_field=DateTimeField(),
  2023. )
  2024. )
  2025. for e in qs:
  2026. self.assertEqual(e.dt, e.start + delta)
  2027. def test_date_minus_duration(self):
  2028. more_than_4_days = Experiment.objects.filter(
  2029. assigned__lt=F("completed") - Value(datetime.timedelta(days=4))
  2030. )
  2031. self.assertQuerySetEqual(more_than_4_days, ["e3", "e4", "e5"], lambda e: e.name)
  2032. def test_negative_timedelta_update(self):
  2033. # subtract 30 seconds, 30 minutes, 2 hours and 2 days
  2034. experiments = (
  2035. Experiment.objects.filter(name="e0")
  2036. .annotate(
  2037. start_sub_seconds=F("start") + datetime.timedelta(seconds=-30),
  2038. )
  2039. .annotate(
  2040. start_sub_minutes=F("start_sub_seconds")
  2041. + datetime.timedelta(minutes=-30),
  2042. )
  2043. .annotate(
  2044. start_sub_hours=F("start_sub_minutes") + datetime.timedelta(hours=-2),
  2045. )
  2046. .annotate(
  2047. new_start=F("start_sub_hours") + datetime.timedelta(days=-2),
  2048. )
  2049. )
  2050. expected_start = datetime.datetime(2010, 6, 23, 9, 45, 0)
  2051. # subtract 30 microseconds
  2052. experiments = experiments.annotate(
  2053. new_start=F("new_start") + datetime.timedelta(microseconds=-30)
  2054. )
  2055. expected_start += datetime.timedelta(microseconds=+746970)
  2056. experiments.update(start=F("new_start"))
  2057. e0 = Experiment.objects.get(name="e0")
  2058. self.assertEqual(e0.start, expected_start)
  2059. class ValueTests(TestCase):
  2060. def test_update_TimeField_using_Value(self):
  2061. Time.objects.create()
  2062. Time.objects.update(time=Value(datetime.time(1), output_field=TimeField()))
  2063. self.assertEqual(Time.objects.get().time, datetime.time(1))
  2064. def test_update_UUIDField_using_Value(self):
  2065. UUID.objects.create()
  2066. UUID.objects.update(
  2067. uuid=Value(
  2068. uuid.UUID("12345678901234567890123456789012"), output_field=UUIDField()
  2069. )
  2070. )
  2071. self.assertEqual(
  2072. UUID.objects.get().uuid, uuid.UUID("12345678901234567890123456789012")
  2073. )
  2074. def test_deconstruct(self):
  2075. value = Value("name")
  2076. path, args, kwargs = value.deconstruct()
  2077. self.assertEqual(path, "django.db.models.Value")
  2078. self.assertEqual(args, (value.value,))
  2079. self.assertEqual(kwargs, {})
  2080. def test_deconstruct_output_field(self):
  2081. value = Value("name", output_field=CharField())
  2082. path, args, kwargs = value.deconstruct()
  2083. self.assertEqual(path, "django.db.models.Value")
  2084. self.assertEqual(args, (value.value,))
  2085. self.assertEqual(len(kwargs), 1)
  2086. self.assertEqual(
  2087. kwargs["output_field"].deconstruct(), CharField().deconstruct()
  2088. )
  2089. def test_repr(self):
  2090. tests = [
  2091. (None, "Value(None)"),
  2092. ("str", "Value('str')"),
  2093. (True, "Value(True)"),
  2094. (42, "Value(42)"),
  2095. (
  2096. datetime.datetime(2019, 5, 15),
  2097. "Value(datetime.datetime(2019, 5, 15, 0, 0))",
  2098. ),
  2099. (Decimal("3.14"), "Value(Decimal('3.14'))"),
  2100. ]
  2101. for value, expected in tests:
  2102. with self.subTest(value=value):
  2103. self.assertEqual(repr(Value(value)), expected)
  2104. def test_equal(self):
  2105. value = Value("name")
  2106. self.assertEqual(value, Value("name"))
  2107. self.assertNotEqual(value, Value("username"))
  2108. def test_hash(self):
  2109. d = {Value("name"): "Bob"}
  2110. self.assertIn(Value("name"), d)
  2111. self.assertEqual(d[Value("name")], "Bob")
  2112. def test_equal_output_field(self):
  2113. value = Value("name", output_field=CharField())
  2114. same_value = Value("name", output_field=CharField())
  2115. other_value = Value("name", output_field=TimeField())
  2116. no_output_field = Value("name")
  2117. self.assertEqual(value, same_value)
  2118. self.assertNotEqual(value, other_value)
  2119. self.assertNotEqual(value, no_output_field)
  2120. def test_compile_unresolved(self):
  2121. # This test might need to be revisited later on if #25425 is enforced.
  2122. compiler = Time.objects.all().query.get_compiler(connection=connection)
  2123. value = Value("foo")
  2124. self.assertEqual(value.as_sql(compiler, connection), ("%s", ["foo"]))
  2125. value = Value("foo", output_field=CharField())
  2126. self.assertEqual(value.as_sql(compiler, connection), ("%s", ["foo"]))
  2127. def test_output_field_decimalfield(self):
  2128. Time.objects.create()
  2129. time = Time.objects.annotate(one=Value(1, output_field=DecimalField())).first()
  2130. self.assertEqual(time.one, 1)
  2131. def test_output_field_is_none_error(self):
  2132. with self.assertRaises(OutputFieldIsNoneError):
  2133. Employee.objects.annotate(custom_expression=Value(None)).first()
  2134. def test_output_field_or_none_property_not_cached(self):
  2135. expression = Value(None, output_field=None)
  2136. self.assertIsNone(expression._output_field_or_none)
  2137. expression.output_field = BooleanField()
  2138. self.assertIsInstance(expression._output_field_or_none, BooleanField)
  2139. def test_resolve_output_field(self):
  2140. value_types = [
  2141. ("str", CharField),
  2142. (True, BooleanField),
  2143. (42, IntegerField),
  2144. (3.14, FloatField),
  2145. (datetime.date(2019, 5, 15), DateField),
  2146. (datetime.datetime(2019, 5, 15), DateTimeField),
  2147. (datetime.time(3, 16), TimeField),
  2148. (datetime.timedelta(1), DurationField),
  2149. (Decimal("3.14"), DecimalField),
  2150. (b"", BinaryField),
  2151. (uuid.uuid4(), UUIDField),
  2152. ]
  2153. for value, output_field_type in value_types:
  2154. with self.subTest(type=type(value)):
  2155. expr = Value(value)
  2156. self.assertIsInstance(expr.output_field, output_field_type)
  2157. def test_resolve_output_field_failure(self):
  2158. msg = "Cannot resolve expression type, unknown output_field"
  2159. with self.assertRaisesMessage(FieldError, msg):
  2160. Value(object()).output_field
  2161. def test_output_field_does_not_create_broken_validators(self):
  2162. """
  2163. The output field for a given Value doesn't get cleaned & validated,
  2164. however validators may still be instantiated for a given field type
  2165. and this demonstrates that they don't throw an exception.
  2166. """
  2167. value_types = [
  2168. "str",
  2169. True,
  2170. 42,
  2171. 3.14,
  2172. datetime.date(2019, 5, 15),
  2173. datetime.datetime(2019, 5, 15),
  2174. datetime.time(3, 16),
  2175. datetime.timedelta(1),
  2176. Decimal("3.14"),
  2177. b"",
  2178. uuid.uuid4(),
  2179. ]
  2180. for value in value_types:
  2181. with self.subTest(type=type(value)):
  2182. field = Value(value)._resolve_output_field()
  2183. field.clean(value, model_instance=None)
  2184. class ExistsTests(TestCase):
  2185. def test_optimizations(self):
  2186. with CaptureQueriesContext(connection) as context:
  2187. list(
  2188. Experiment.objects.values(
  2189. exists=Exists(
  2190. Experiment.objects.order_by("pk"),
  2191. )
  2192. ).order_by()
  2193. )
  2194. captured_queries = context.captured_queries
  2195. self.assertEqual(len(captured_queries), 1)
  2196. captured_sql = captured_queries[0]["sql"]
  2197. self.assertNotIn(
  2198. connection.ops.quote_name(Experiment._meta.pk.column),
  2199. captured_sql,
  2200. )
  2201. self.assertIn(
  2202. connection.ops.limit_offset_sql(None, 1),
  2203. captured_sql,
  2204. )
  2205. self.assertNotIn("ORDER BY", captured_sql)
  2206. def test_negated_empty_exists(self):
  2207. manager = Manager.objects.create()
  2208. qs = Manager.objects.filter(~Exists(Manager.objects.none()) & Q(pk=manager.pk))
  2209. self.assertSequenceEqual(qs, [manager])
  2210. def test_select_negated_empty_exists(self):
  2211. manager = Manager.objects.create()
  2212. qs = Manager.objects.annotate(
  2213. not_exists=~Exists(Manager.objects.none())
  2214. ).filter(pk=manager.pk)
  2215. self.assertSequenceEqual(qs, [manager])
  2216. self.assertIs(qs.get().not_exists, True)
  2217. def test_filter_by_empty_exists(self):
  2218. manager = Manager.objects.create()
  2219. qs = Manager.objects.annotate(exists=Exists(Manager.objects.none())).filter(
  2220. pk=manager.pk, exists=False
  2221. )
  2222. self.assertSequenceEqual(qs, [manager])
  2223. self.assertIs(qs.get().exists, False)
  2224. class FieldTransformTests(TestCase):
  2225. @classmethod
  2226. def setUpTestData(cls):
  2227. cls.sday = sday = datetime.date(2010, 6, 25)
  2228. cls.stime = stime = datetime.datetime(2010, 6, 25, 12, 15, 30, 747000)
  2229. cls.ex1 = Experiment.objects.create(
  2230. name="Experiment 1",
  2231. assigned=sday,
  2232. completed=sday + datetime.timedelta(2),
  2233. estimated_time=datetime.timedelta(2),
  2234. start=stime,
  2235. end=stime + datetime.timedelta(2),
  2236. )
  2237. def test_month_aggregation(self):
  2238. self.assertEqual(
  2239. Experiment.objects.aggregate(month_count=Count("assigned__month")),
  2240. {"month_count": 1},
  2241. )
  2242. def test_transform_in_values(self):
  2243. self.assertSequenceEqual(
  2244. Experiment.objects.values("assigned__month"),
  2245. [{"assigned__month": 6}],
  2246. )
  2247. def test_multiple_transforms_in_values(self):
  2248. self.assertSequenceEqual(
  2249. Experiment.objects.values("end__date__month"),
  2250. [{"end__date__month": 6}],
  2251. )
  2252. class ReprTests(SimpleTestCase):
  2253. def test_expressions(self):
  2254. self.assertEqual(
  2255. repr(Case(When(a=1))),
  2256. "<Case: CASE WHEN <Q: (AND: ('a', 1))> THEN Value(None), ELSE Value(None)>",
  2257. )
  2258. self.assertEqual(
  2259. repr(When(Q(age__gte=18), then=Value("legal"))),
  2260. "<When: WHEN <Q: (AND: ('age__gte', 18))> THEN Value('legal')>",
  2261. )
  2262. self.assertEqual(repr(Col("alias", "field")), "Col(alias, field)")
  2263. self.assertEqual(
  2264. repr(ColPairs("alias", ["t1", "t2"], ["s1", "s2"], "f")),
  2265. "ColPairs('alias', ['t1', 't2'], ['s1', 's2'], 'f')",
  2266. )
  2267. self.assertEqual(repr(F("published")), "F(published)")
  2268. self.assertEqual(
  2269. repr(F("cost") + F("tax")), "<CombinedExpression: F(cost) + F(tax)>"
  2270. )
  2271. self.assertEqual(
  2272. repr(ExpressionWrapper(F("cost") + F("tax"), IntegerField())),
  2273. "ExpressionWrapper(F(cost) + F(tax))",
  2274. )
  2275. self.assertEqual(
  2276. repr(Func("published", function="TO_CHAR")),
  2277. "Func(F(published), function=TO_CHAR)",
  2278. )
  2279. self.assertEqual(
  2280. repr(F("published")[0:2]), "Sliced(F(published), slice(0, 2, None))"
  2281. )
  2282. self.assertEqual(
  2283. repr(OuterRef("name")[1:5]), "Sliced(OuterRef(name), slice(1, 5, None))"
  2284. )
  2285. self.assertEqual(repr(OrderBy(Value(1))), "OrderBy(Value(1), descending=False)")
  2286. self.assertEqual(repr(RawSQL("table.col", [])), "RawSQL(table.col, [])")
  2287. self.assertEqual(
  2288. repr(Ref("sum_cost", Sum("cost"))), "Ref(sum_cost, Sum(F(cost)))"
  2289. )
  2290. self.assertEqual(repr(Value(1)), "Value(1)")
  2291. self.assertEqual(
  2292. repr(ExpressionList(F("col"), F("anothercol"))),
  2293. "ExpressionList(F(col), F(anothercol))",
  2294. )
  2295. self.assertEqual(
  2296. repr(ExpressionList(OrderBy(F("col"), descending=False))),
  2297. "ExpressionList(OrderBy(F(col), descending=False))",
  2298. )
  2299. def test_functions(self):
  2300. self.assertEqual(repr(Coalesce("a", "b")), "Coalesce(F(a), F(b))")
  2301. self.assertEqual(repr(Concat("a", "b")), "Concat(ConcatPair(F(a), F(b)))")
  2302. self.assertEqual(repr(Length("a")), "Length(F(a))")
  2303. self.assertEqual(repr(Lower("a")), "Lower(F(a))")
  2304. self.assertEqual(repr(Substr("a", 1, 3)), "Substr(F(a), Value(1), Value(3))")
  2305. self.assertEqual(repr(Upper("a")), "Upper(F(a))")
  2306. def test_aggregates(self):
  2307. self.assertEqual(repr(Avg("a")), "Avg(F(a))")
  2308. self.assertEqual(repr(Count("a")), "Count(F(a))")
  2309. self.assertEqual(repr(Count("*")), "Count('*')")
  2310. self.assertEqual(repr(Max("a")), "Max(F(a))")
  2311. self.assertEqual(repr(Min("a")), "Min(F(a))")
  2312. self.assertEqual(repr(StdDev("a")), "StdDev(F(a), sample=False)")
  2313. self.assertEqual(repr(Sum("a")), "Sum(F(a))")
  2314. self.assertEqual(
  2315. repr(Variance("a", sample=True)), "Variance(F(a), sample=True)"
  2316. )
  2317. def test_distinct_aggregates(self):
  2318. self.assertEqual(repr(Count("a", distinct=True)), "Count(F(a), distinct=True)")
  2319. self.assertEqual(repr(Count("*", distinct=True)), "Count('*', distinct=True)")
  2320. def test_filtered_aggregates(self):
  2321. filter = Q(a=1)
  2322. self.assertEqual(
  2323. repr(Avg("a", filter=filter)), "Avg(F(a), filter=(AND: ('a', 1)))"
  2324. )
  2325. self.assertEqual(
  2326. repr(Count("a", filter=filter)), "Count(F(a), filter=(AND: ('a', 1)))"
  2327. )
  2328. self.assertEqual(
  2329. repr(Max("a", filter=filter)), "Max(F(a), filter=(AND: ('a', 1)))"
  2330. )
  2331. self.assertEqual(
  2332. repr(Min("a", filter=filter)), "Min(F(a), filter=(AND: ('a', 1)))"
  2333. )
  2334. self.assertEqual(
  2335. repr(StdDev("a", filter=filter)),
  2336. "StdDev(F(a), filter=(AND: ('a', 1)), sample=False)",
  2337. )
  2338. self.assertEqual(
  2339. repr(Sum("a", filter=filter)), "Sum(F(a), filter=(AND: ('a', 1)))"
  2340. )
  2341. self.assertEqual(
  2342. repr(Variance("a", sample=True, filter=filter)),
  2343. "Variance(F(a), filter=(AND: ('a', 1)), sample=True)",
  2344. )
  2345. self.assertEqual(
  2346. repr(Count("a", filter=filter, distinct=True)),
  2347. "Count(F(a), distinct=True, filter=(AND: ('a', 1)))",
  2348. )
  2349. class CombinableTests(SimpleTestCase):
  2350. bitwise_msg = (
  2351. "Use .bitand(), .bitor(), and .bitxor() for bitwise logical operations."
  2352. )
  2353. def test_negation(self):
  2354. c = Combinable()
  2355. self.assertEqual(-c, c * -1)
  2356. def test_and(self):
  2357. with self.assertRaisesMessage(NotImplementedError, self.bitwise_msg):
  2358. Combinable() & Combinable()
  2359. def test_or(self):
  2360. with self.assertRaisesMessage(NotImplementedError, self.bitwise_msg):
  2361. Combinable() | Combinable()
  2362. def test_xor(self):
  2363. with self.assertRaisesMessage(NotImplementedError, self.bitwise_msg):
  2364. Combinable() ^ Combinable()
  2365. def test_reversed_and(self):
  2366. with self.assertRaisesMessage(NotImplementedError, self.bitwise_msg):
  2367. object() & Combinable()
  2368. def test_reversed_or(self):
  2369. with self.assertRaisesMessage(NotImplementedError, self.bitwise_msg):
  2370. object() | Combinable()
  2371. def test_reversed_xor(self):
  2372. with self.assertRaisesMessage(NotImplementedError, self.bitwise_msg):
  2373. object() ^ Combinable()
  2374. class CombinedExpressionTests(SimpleTestCase):
  2375. def test_resolve_output_field_positive_integer(self):
  2376. connectors = [
  2377. Combinable.ADD,
  2378. Combinable.MUL,
  2379. Combinable.DIV,
  2380. Combinable.MOD,
  2381. Combinable.POW,
  2382. ]
  2383. for connector in connectors:
  2384. with self.subTest(connector=connector):
  2385. expr = CombinedExpression(
  2386. Expression(PositiveIntegerField()),
  2387. connector,
  2388. Expression(PositiveIntegerField()),
  2389. )
  2390. self.assertIsInstance(expr.output_field, PositiveIntegerField)
  2391. def test_resolve_output_field_number(self):
  2392. tests = [
  2393. (IntegerField, AutoField, IntegerField),
  2394. (AutoField, IntegerField, IntegerField),
  2395. (IntegerField, DecimalField, DecimalField),
  2396. (DecimalField, IntegerField, DecimalField),
  2397. (IntegerField, FloatField, FloatField),
  2398. (FloatField, IntegerField, FloatField),
  2399. ]
  2400. connectors = [
  2401. Combinable.ADD,
  2402. Combinable.SUB,
  2403. Combinable.MUL,
  2404. Combinable.DIV,
  2405. Combinable.MOD,
  2406. ]
  2407. for lhs, rhs, combined in tests:
  2408. for connector in connectors:
  2409. with self.subTest(
  2410. lhs=lhs, connector=connector, rhs=rhs, combined=combined
  2411. ):
  2412. expr = CombinedExpression(
  2413. Expression(lhs()),
  2414. connector,
  2415. Expression(rhs()),
  2416. )
  2417. self.assertIsInstance(expr.output_field, combined)
  2418. def test_resolve_output_field_with_null(self):
  2419. def null():
  2420. return Value(None)
  2421. tests = [
  2422. # Numbers.
  2423. (AutoField, Combinable.ADD, null),
  2424. (DecimalField, Combinable.ADD, null),
  2425. (FloatField, Combinable.ADD, null),
  2426. (IntegerField, Combinable.ADD, null),
  2427. (IntegerField, Combinable.SUB, null),
  2428. (null, Combinable.ADD, IntegerField),
  2429. # Dates.
  2430. (DateField, Combinable.ADD, null),
  2431. (DateTimeField, Combinable.ADD, null),
  2432. (DurationField, Combinable.ADD, null),
  2433. (TimeField, Combinable.ADD, null),
  2434. (TimeField, Combinable.SUB, null),
  2435. (null, Combinable.ADD, DateTimeField),
  2436. (DateField, Combinable.SUB, null),
  2437. ]
  2438. for lhs, connector, rhs in tests:
  2439. msg = (
  2440. f"Cannot infer type of {connector!r} expression involving these types: "
  2441. )
  2442. with self.subTest(lhs=lhs, connector=connector, rhs=rhs):
  2443. expr = CombinedExpression(
  2444. Expression(lhs()),
  2445. connector,
  2446. Expression(rhs()),
  2447. )
  2448. with self.assertRaisesMessage(FieldError, msg):
  2449. expr.output_field
  2450. def test_resolve_output_field_numbers_with_null(self):
  2451. test_values = [
  2452. (3.14159, None, FloatField),
  2453. (None, 3.14159, FloatField),
  2454. (None, 42, IntegerField),
  2455. (42, None, IntegerField),
  2456. (None, Decimal("3.14"), DecimalField),
  2457. (Decimal("3.14"), None, DecimalField),
  2458. ]
  2459. connectors = [
  2460. Combinable.ADD,
  2461. Combinable.SUB,
  2462. Combinable.MUL,
  2463. Combinable.DIV,
  2464. Combinable.MOD,
  2465. Combinable.POW,
  2466. ]
  2467. for lhs, rhs, expected_output_field in test_values:
  2468. for connector in connectors:
  2469. with self.subTest(lhs=lhs, connector=connector, rhs=rhs):
  2470. expr = CombinedExpression(Value(lhs), connector, Value(rhs))
  2471. self.assertIsInstance(expr.output_field, expected_output_field)
  2472. def test_resolve_output_field_dates(self):
  2473. tests = [
  2474. # Add - same type.
  2475. (DateField, Combinable.ADD, DateField, FieldError),
  2476. (DateTimeField, Combinable.ADD, DateTimeField, FieldError),
  2477. (TimeField, Combinable.ADD, TimeField, FieldError),
  2478. (DurationField, Combinable.ADD, DurationField, DurationField),
  2479. # Add - different type.
  2480. (DateField, Combinable.ADD, DurationField, DateTimeField),
  2481. (DateTimeField, Combinable.ADD, DurationField, DateTimeField),
  2482. (TimeField, Combinable.ADD, DurationField, TimeField),
  2483. (DurationField, Combinable.ADD, DateField, DateTimeField),
  2484. (DurationField, Combinable.ADD, DateTimeField, DateTimeField),
  2485. (DurationField, Combinable.ADD, TimeField, TimeField),
  2486. # Subtract - same type.
  2487. (DateField, Combinable.SUB, DateField, DurationField),
  2488. (DateTimeField, Combinable.SUB, DateTimeField, DurationField),
  2489. (TimeField, Combinable.SUB, TimeField, DurationField),
  2490. (DurationField, Combinable.SUB, DurationField, DurationField),
  2491. # Subtract - different type.
  2492. (DateField, Combinable.SUB, DurationField, DateTimeField),
  2493. (DateTimeField, Combinable.SUB, DurationField, DateTimeField),
  2494. (TimeField, Combinable.SUB, DurationField, TimeField),
  2495. (DurationField, Combinable.SUB, DateField, FieldError),
  2496. (DurationField, Combinable.SUB, DateTimeField, FieldError),
  2497. (DurationField, Combinable.SUB, DateTimeField, FieldError),
  2498. ]
  2499. for lhs, connector, rhs, combined in tests:
  2500. msg = (
  2501. f"Cannot infer type of {connector!r} expression involving these types: "
  2502. )
  2503. with self.subTest(lhs=lhs, connector=connector, rhs=rhs, combined=combined):
  2504. expr = CombinedExpression(
  2505. Expression(lhs()),
  2506. connector,
  2507. Expression(rhs()),
  2508. )
  2509. if issubclass(combined, Exception):
  2510. with self.assertRaisesMessage(combined, msg):
  2511. expr.output_field
  2512. else:
  2513. self.assertIsInstance(expr.output_field, combined)
  2514. def test_mixed_char_date_with_annotate(self):
  2515. queryset = Experiment.objects.annotate(nonsense=F("name") + F("assigned"))
  2516. msg = (
  2517. "Cannot infer type of '+' expression involving these types: CharField, "
  2518. "DateField. You must set output_field."
  2519. )
  2520. with self.assertRaisesMessage(FieldError, msg):
  2521. list(queryset)
  2522. class ExpressionWrapperTests(SimpleTestCase):
  2523. def test_empty_group_by(self):
  2524. expr = ExpressionWrapper(Value(3), output_field=IntegerField())
  2525. self.assertEqual(expr.get_group_by_cols(), [])
  2526. def test_non_empty_group_by(self):
  2527. value = Value("f")
  2528. value.output_field = None
  2529. expr = ExpressionWrapper(Lower(value), output_field=IntegerField())
  2530. group_by_cols = expr.get_group_by_cols()
  2531. self.assertEqual(group_by_cols, [expr.expression])
  2532. self.assertEqual(group_by_cols[0].output_field, expr.output_field)
  2533. class NegatedExpressionTests(TestCase):
  2534. @classmethod
  2535. def setUpTestData(cls):
  2536. ceo = Employee.objects.create(firstname="Joe", lastname="Smith", salary=10)
  2537. cls.eu_company = Company.objects.create(
  2538. name="Example Inc.",
  2539. num_employees=2300,
  2540. num_chairs=5,
  2541. ceo=ceo,
  2542. based_in_eu=True,
  2543. )
  2544. cls.non_eu_company = Company.objects.create(
  2545. name="Foobar Ltd.",
  2546. num_employees=3,
  2547. num_chairs=4,
  2548. ceo=ceo,
  2549. based_in_eu=False,
  2550. )
  2551. def test_invert(self):
  2552. f = F("field")
  2553. self.assertEqual(~f, NegatedExpression(f))
  2554. self.assertIsNot(~~f, f)
  2555. self.assertEqual(~~f, f)
  2556. def test_filter(self):
  2557. self.assertSequenceEqual(
  2558. Company.objects.filter(~F("based_in_eu")),
  2559. [self.non_eu_company],
  2560. )
  2561. qs = Company.objects.annotate(eu_required=~Value(False))
  2562. self.assertSequenceEqual(
  2563. qs.filter(based_in_eu=F("eu_required")).order_by("eu_required"),
  2564. [self.eu_company],
  2565. )
  2566. self.assertSequenceEqual(
  2567. qs.filter(based_in_eu=~~F("eu_required")),
  2568. [self.eu_company],
  2569. )
  2570. self.assertSequenceEqual(
  2571. qs.filter(based_in_eu=~F("eu_required")),
  2572. [self.non_eu_company],
  2573. )
  2574. self.assertSequenceEqual(qs.filter(based_in_eu=~F("based_in_eu")), [])
  2575. def test_values(self):
  2576. self.assertSequenceEqual(
  2577. Company.objects.annotate(negated=~F("based_in_eu"))
  2578. .values_list("name", "negated")
  2579. .order_by("name"),
  2580. [("Example Inc.", False), ("Foobar Ltd.", True)],
  2581. )
  2582. class OrderByTests(SimpleTestCase):
  2583. def test_equal(self):
  2584. self.assertEqual(
  2585. OrderBy(F("field"), nulls_last=True),
  2586. OrderBy(F("field"), nulls_last=True),
  2587. )
  2588. self.assertNotEqual(
  2589. OrderBy(F("field"), nulls_last=True),
  2590. OrderBy(F("field")),
  2591. )
  2592. def test_hash(self):
  2593. self.assertEqual(
  2594. hash(OrderBy(F("field"), nulls_last=True)),
  2595. hash(OrderBy(F("field"), nulls_last=True)),
  2596. )
  2597. self.assertNotEqual(
  2598. hash(OrderBy(F("field"), nulls_last=True)),
  2599. hash(OrderBy(F("field"))),
  2600. )
  2601. def test_nulls_false(self):
  2602. msg = "nulls_first and nulls_last values must be True or None."
  2603. with self.assertRaisesMessage(ValueError, msg):
  2604. OrderBy(F("field"), nulls_first=False)
  2605. with self.assertRaisesMessage(ValueError, msg):
  2606. OrderBy(F("field"), nulls_last=False)
  2607. with self.assertRaisesMessage(ValueError, msg):
  2608. F("field").asc(nulls_first=False)
  2609. with self.assertRaisesMessage(ValueError, msg):
  2610. F("field").desc(nulls_last=False)