2
0

test_extract_trunc.py 58 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139
  1. from datetime import datetime, timedelta
  2. import pytz
  3. from django.conf import settings
  4. from django.db.models import (
  5. DateField, DateTimeField, IntegerField, Max, OuterRef, Subquery, TimeField,
  6. )
  7. from django.db.models.functions import (
  8. Extract, ExtractDay, ExtractHour, ExtractIsoYear, ExtractMinute,
  9. ExtractMonth, ExtractQuarter, ExtractSecond, ExtractWeek, ExtractWeekDay,
  10. ExtractYear, Trunc, TruncDate, TruncDay, TruncHour, TruncMinute,
  11. TruncMonth, TruncQuarter, TruncSecond, TruncTime, TruncWeek, TruncYear,
  12. )
  13. from django.test import (
  14. TestCase, override_settings, skipIfDBFeature, skipUnlessDBFeature,
  15. )
  16. from django.utils import timezone
  17. from ..models import Author, DTModel, Fan
  18. def truncate_to(value, kind, tzinfo=None):
  19. # Convert to target timezone before truncation
  20. if tzinfo is not None:
  21. value = value.astimezone(tzinfo)
  22. def truncate(value, kind):
  23. if kind == 'second':
  24. return value.replace(microsecond=0)
  25. if kind == 'minute':
  26. return value.replace(second=0, microsecond=0)
  27. if kind == 'hour':
  28. return value.replace(minute=0, second=0, microsecond=0)
  29. if kind == 'day':
  30. if isinstance(value, datetime):
  31. return value.replace(hour=0, minute=0, second=0, microsecond=0)
  32. return value
  33. if kind == 'week':
  34. if isinstance(value, datetime):
  35. return (value - timedelta(days=value.weekday())).replace(hour=0, minute=0, second=0, microsecond=0)
  36. return value - timedelta(days=value.weekday())
  37. if kind == 'month':
  38. if isinstance(value, datetime):
  39. return value.replace(day=1, hour=0, minute=0, second=0, microsecond=0)
  40. return value.replace(day=1)
  41. if kind == 'quarter':
  42. month_in_quarter = value.month - (value.month - 1) % 3
  43. if isinstance(value, datetime):
  44. return value.replace(month=month_in_quarter, day=1, hour=0, minute=0, second=0, microsecond=0)
  45. return value.replace(month=month_in_quarter, day=1)
  46. # otherwise, truncate to year
  47. if isinstance(value, datetime):
  48. return value.replace(month=1, day=1, hour=0, minute=0, second=0, microsecond=0)
  49. return value.replace(month=1, day=1)
  50. value = truncate(value, kind)
  51. if tzinfo is not None:
  52. # If there was a daylight saving transition, then reset the timezone.
  53. value = timezone.make_aware(value.replace(tzinfo=None), tzinfo)
  54. return value
  55. @override_settings(USE_TZ=False)
  56. class DateFunctionTests(TestCase):
  57. def create_model(self, start_datetime, end_datetime):
  58. return DTModel.objects.create(
  59. name=start_datetime.isoformat() if start_datetime else 'None',
  60. start_datetime=start_datetime,
  61. end_datetime=end_datetime,
  62. start_date=start_datetime.date() if start_datetime else None,
  63. end_date=end_datetime.date() if end_datetime else None,
  64. start_time=start_datetime.time() if start_datetime else None,
  65. end_time=end_datetime.time() if end_datetime else None,
  66. duration=(end_datetime - start_datetime) if start_datetime and end_datetime else None,
  67. )
  68. def test_extract_year_exact_lookup(self):
  69. """
  70. Extract year uses a BETWEEN filter to compare the year to allow indexes
  71. to be used.
  72. """
  73. start_datetime = datetime(2015, 6, 15, 14, 10)
  74. end_datetime = datetime(2016, 6, 15, 14, 10)
  75. if settings.USE_TZ:
  76. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  77. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  78. self.create_model(start_datetime, end_datetime)
  79. self.create_model(end_datetime, start_datetime)
  80. for lookup in ('year', 'iso_year'):
  81. with self.subTest(lookup):
  82. qs = DTModel.objects.filter(**{'start_datetime__%s__exact' % lookup: 2015})
  83. self.assertEqual(qs.count(), 1)
  84. query_string = str(qs.query).lower()
  85. self.assertEqual(query_string.count(' between '), 1)
  86. self.assertEqual(query_string.count('extract'), 0)
  87. # exact is implied and should be the same
  88. qs = DTModel.objects.filter(**{'start_datetime__%s' % lookup: 2015})
  89. self.assertEqual(qs.count(), 1)
  90. query_string = str(qs.query).lower()
  91. self.assertEqual(query_string.count(' between '), 1)
  92. self.assertEqual(query_string.count('extract'), 0)
  93. # date and datetime fields should behave the same
  94. qs = DTModel.objects.filter(**{'start_date__%s' % lookup: 2015})
  95. self.assertEqual(qs.count(), 1)
  96. query_string = str(qs.query).lower()
  97. self.assertEqual(query_string.count(' between '), 1)
  98. self.assertEqual(query_string.count('extract'), 0)
  99. def test_extract_year_greaterthan_lookup(self):
  100. start_datetime = datetime(2015, 6, 15, 14, 10)
  101. end_datetime = datetime(2016, 6, 15, 14, 10)
  102. if settings.USE_TZ:
  103. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  104. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  105. self.create_model(start_datetime, end_datetime)
  106. self.create_model(end_datetime, start_datetime)
  107. for lookup in ('year', 'iso_year'):
  108. with self.subTest(lookup):
  109. qs = DTModel.objects.filter(**{'start_datetime__%s__gt' % lookup: 2015})
  110. self.assertEqual(qs.count(), 1)
  111. self.assertEqual(str(qs.query).lower().count('extract'), 0)
  112. qs = DTModel.objects.filter(**{'start_datetime__%s__gte' % lookup: 2015})
  113. self.assertEqual(qs.count(), 2)
  114. self.assertEqual(str(qs.query).lower().count('extract'), 0)
  115. def test_extract_year_lessthan_lookup(self):
  116. start_datetime = datetime(2015, 6, 15, 14, 10)
  117. end_datetime = datetime(2016, 6, 15, 14, 10)
  118. if settings.USE_TZ:
  119. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  120. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  121. self.create_model(start_datetime, end_datetime)
  122. self.create_model(end_datetime, start_datetime)
  123. for lookup in ('year', 'iso_year'):
  124. with self.subTest(lookup):
  125. qs = DTModel.objects.filter(**{'start_datetime__%s__lt' % lookup: 2016})
  126. self.assertEqual(qs.count(), 1)
  127. self.assertEqual(str(qs.query).count('extract'), 0)
  128. qs = DTModel.objects.filter(**{'start_datetime__%s__lte' % lookup: 2016})
  129. self.assertEqual(qs.count(), 2)
  130. self.assertEqual(str(qs.query).count('extract'), 0)
  131. def test_extract_func(self):
  132. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  133. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  134. if settings.USE_TZ:
  135. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  136. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  137. self.create_model(start_datetime, end_datetime)
  138. self.create_model(end_datetime, start_datetime)
  139. with self.assertRaisesMessage(ValueError, 'lookup_name must be provided'):
  140. Extract('start_datetime')
  141. msg = 'Extract input expression must be DateField, DateTimeField, TimeField, or DurationField.'
  142. with self.assertRaisesMessage(ValueError, msg):
  143. list(DTModel.objects.annotate(extracted=Extract('name', 'hour')))
  144. with self.assertRaisesMessage(
  145. ValueError, "Cannot extract time component 'second' from DateField 'start_date'."):
  146. list(DTModel.objects.annotate(extracted=Extract('start_date', 'second')))
  147. self.assertQuerysetEqual(
  148. DTModel.objects.annotate(extracted=Extract('start_datetime', 'year')).order_by('start_datetime'),
  149. [(start_datetime, start_datetime.year), (end_datetime, end_datetime.year)],
  150. lambda m: (m.start_datetime, m.extracted)
  151. )
  152. self.assertQuerysetEqual(
  153. DTModel.objects.annotate(extracted=Extract('start_datetime', 'quarter')).order_by('start_datetime'),
  154. [(start_datetime, 2), (end_datetime, 2)],
  155. lambda m: (m.start_datetime, m.extracted)
  156. )
  157. self.assertQuerysetEqual(
  158. DTModel.objects.annotate(extracted=Extract('start_datetime', 'month')).order_by('start_datetime'),
  159. [(start_datetime, start_datetime.month), (end_datetime, end_datetime.month)],
  160. lambda m: (m.start_datetime, m.extracted)
  161. )
  162. self.assertQuerysetEqual(
  163. DTModel.objects.annotate(extracted=Extract('start_datetime', 'day')).order_by('start_datetime'),
  164. [(start_datetime, start_datetime.day), (end_datetime, end_datetime.day)],
  165. lambda m: (m.start_datetime, m.extracted)
  166. )
  167. self.assertQuerysetEqual(
  168. DTModel.objects.annotate(extracted=Extract('start_datetime', 'week')).order_by('start_datetime'),
  169. [(start_datetime, 25), (end_datetime, 24)],
  170. lambda m: (m.start_datetime, m.extracted)
  171. )
  172. self.assertQuerysetEqual(
  173. DTModel.objects.annotate(extracted=Extract('start_datetime', 'week_day')).order_by('start_datetime'),
  174. [
  175. (start_datetime, (start_datetime.isoweekday() % 7) + 1),
  176. (end_datetime, (end_datetime.isoweekday() % 7) + 1)
  177. ],
  178. lambda m: (m.start_datetime, m.extracted)
  179. )
  180. self.assertQuerysetEqual(
  181. DTModel.objects.annotate(extracted=Extract('start_datetime', 'hour')).order_by('start_datetime'),
  182. [(start_datetime, start_datetime.hour), (end_datetime, end_datetime.hour)],
  183. lambda m: (m.start_datetime, m.extracted)
  184. )
  185. self.assertQuerysetEqual(
  186. DTModel.objects.annotate(extracted=Extract('start_datetime', 'minute')).order_by('start_datetime'),
  187. [(start_datetime, start_datetime.minute), (end_datetime, end_datetime.minute)],
  188. lambda m: (m.start_datetime, m.extracted)
  189. )
  190. self.assertQuerysetEqual(
  191. DTModel.objects.annotate(extracted=Extract('start_datetime', 'second')).order_by('start_datetime'),
  192. [(start_datetime, start_datetime.second), (end_datetime, end_datetime.second)],
  193. lambda m: (m.start_datetime, m.extracted)
  194. )
  195. self.assertEqual(DTModel.objects.filter(start_datetime__year=Extract('start_datetime', 'year')).count(), 2)
  196. self.assertEqual(DTModel.objects.filter(start_datetime__hour=Extract('start_datetime', 'hour')).count(), 2)
  197. self.assertEqual(DTModel.objects.filter(start_date__month=Extract('start_date', 'month')).count(), 2)
  198. self.assertEqual(DTModel.objects.filter(start_time__hour=Extract('start_time', 'hour')).count(), 2)
  199. def test_extract_none(self):
  200. self.create_model(None, None)
  201. for t in (Extract('start_datetime', 'year'), Extract('start_date', 'year'), Extract('start_time', 'hour')):
  202. with self.subTest(t):
  203. self.assertIsNone(DTModel.objects.annotate(extracted=t).first().extracted)
  204. @skipUnlessDBFeature('has_native_duration_field')
  205. def test_extract_duration(self):
  206. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  207. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  208. if settings.USE_TZ:
  209. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  210. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  211. self.create_model(start_datetime, end_datetime)
  212. self.create_model(end_datetime, start_datetime)
  213. self.assertQuerysetEqual(
  214. DTModel.objects.annotate(extracted=Extract('duration', 'second')).order_by('start_datetime'),
  215. [
  216. (start_datetime, (end_datetime - start_datetime).seconds % 60),
  217. (end_datetime, (start_datetime - end_datetime).seconds % 60)
  218. ],
  219. lambda m: (m.start_datetime, m.extracted)
  220. )
  221. self.assertEqual(
  222. DTModel.objects.annotate(
  223. duration_days=Extract('duration', 'day'),
  224. ).filter(duration_days__gt=200).count(),
  225. 1
  226. )
  227. @skipIfDBFeature('has_native_duration_field')
  228. def test_extract_duration_without_native_duration_field(self):
  229. msg = 'Extract requires native DurationField database support.'
  230. with self.assertRaisesMessage(ValueError, msg):
  231. list(DTModel.objects.annotate(extracted=Extract('duration', 'second')))
  232. def test_extract_year_func(self):
  233. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  234. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  235. if settings.USE_TZ:
  236. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  237. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  238. self.create_model(start_datetime, end_datetime)
  239. self.create_model(end_datetime, start_datetime)
  240. self.assertQuerysetEqual(
  241. DTModel.objects.annotate(extracted=ExtractYear('start_datetime')).order_by('start_datetime'),
  242. [(start_datetime, start_datetime.year), (end_datetime, end_datetime.year)],
  243. lambda m: (m.start_datetime, m.extracted)
  244. )
  245. self.assertQuerysetEqual(
  246. DTModel.objects.annotate(extracted=ExtractYear('start_date')).order_by('start_datetime'),
  247. [(start_datetime, start_datetime.year), (end_datetime, end_datetime.year)],
  248. lambda m: (m.start_datetime, m.extracted)
  249. )
  250. self.assertEqual(DTModel.objects.filter(start_datetime__year=ExtractYear('start_datetime')).count(), 2)
  251. def test_extract_iso_year_func(self):
  252. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  253. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  254. if settings.USE_TZ:
  255. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  256. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  257. self.create_model(start_datetime, end_datetime)
  258. self.create_model(end_datetime, start_datetime)
  259. self.assertQuerysetEqual(
  260. DTModel.objects.annotate(extracted=ExtractIsoYear('start_datetime')).order_by('start_datetime'),
  261. [(start_datetime, start_datetime.year), (end_datetime, end_datetime.year)],
  262. lambda m: (m.start_datetime, m.extracted)
  263. )
  264. self.assertQuerysetEqual(
  265. DTModel.objects.annotate(extracted=ExtractIsoYear('start_date')).order_by('start_datetime'),
  266. [(start_datetime, start_datetime.year), (end_datetime, end_datetime.year)],
  267. lambda m: (m.start_datetime, m.extracted)
  268. )
  269. # Both dates are from the same week year.
  270. self.assertEqual(DTModel.objects.filter(start_datetime__iso_year=ExtractIsoYear('start_datetime')).count(), 2)
  271. def test_extract_iso_year_func_boundaries(self):
  272. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  273. if settings.USE_TZ:
  274. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  275. week_52_day_2014 = datetime(2014, 12, 27, 13, 0) # Sunday
  276. week_1_day_2014_2015 = datetime(2014, 12, 31, 13, 0) # Wednesday
  277. week_53_day_2015 = datetime(2015, 12, 31, 13, 0) # Thursday
  278. if settings.USE_TZ:
  279. week_1_day_2014_2015 = timezone.make_aware(week_1_day_2014_2015, is_dst=False)
  280. week_52_day_2014 = timezone.make_aware(week_52_day_2014, is_dst=False)
  281. week_53_day_2015 = timezone.make_aware(week_53_day_2015, is_dst=False)
  282. days = [week_52_day_2014, week_1_day_2014_2015, week_53_day_2015]
  283. self.create_model(week_53_day_2015, end_datetime)
  284. self.create_model(week_52_day_2014, end_datetime)
  285. self.create_model(week_1_day_2014_2015, end_datetime)
  286. qs = DTModel.objects.filter(start_datetime__in=days).annotate(
  287. extracted=ExtractIsoYear('start_datetime'),
  288. ).order_by('start_datetime')
  289. self.assertQuerysetEqual(qs, [
  290. (week_52_day_2014, 2014),
  291. (week_1_day_2014_2015, 2015),
  292. (week_53_day_2015, 2015),
  293. ], lambda m: (m.start_datetime, m.extracted))
  294. def test_extract_month_func(self):
  295. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  296. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  297. if settings.USE_TZ:
  298. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  299. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  300. self.create_model(start_datetime, end_datetime)
  301. self.create_model(end_datetime, start_datetime)
  302. self.assertQuerysetEqual(
  303. DTModel.objects.annotate(extracted=ExtractMonth('start_datetime')).order_by('start_datetime'),
  304. [(start_datetime, start_datetime.month), (end_datetime, end_datetime.month)],
  305. lambda m: (m.start_datetime, m.extracted)
  306. )
  307. self.assertQuerysetEqual(
  308. DTModel.objects.annotate(extracted=ExtractMonth('start_date')).order_by('start_datetime'),
  309. [(start_datetime, start_datetime.month), (end_datetime, end_datetime.month)],
  310. lambda m: (m.start_datetime, m.extracted)
  311. )
  312. self.assertEqual(DTModel.objects.filter(start_datetime__month=ExtractMonth('start_datetime')).count(), 2)
  313. def test_extract_day_func(self):
  314. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  315. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  316. if settings.USE_TZ:
  317. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  318. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  319. self.create_model(start_datetime, end_datetime)
  320. self.create_model(end_datetime, start_datetime)
  321. self.assertQuerysetEqual(
  322. DTModel.objects.annotate(extracted=ExtractDay('start_datetime')).order_by('start_datetime'),
  323. [(start_datetime, start_datetime.day), (end_datetime, end_datetime.day)],
  324. lambda m: (m.start_datetime, m.extracted)
  325. )
  326. self.assertQuerysetEqual(
  327. DTModel.objects.annotate(extracted=ExtractDay('start_date')).order_by('start_datetime'),
  328. [(start_datetime, start_datetime.day), (end_datetime, end_datetime.day)],
  329. lambda m: (m.start_datetime, m.extracted)
  330. )
  331. self.assertEqual(DTModel.objects.filter(start_datetime__day=ExtractDay('start_datetime')).count(), 2)
  332. def test_extract_week_func(self):
  333. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  334. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  335. if settings.USE_TZ:
  336. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  337. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  338. self.create_model(start_datetime, end_datetime)
  339. self.create_model(end_datetime, start_datetime)
  340. self.assertQuerysetEqual(
  341. DTModel.objects.annotate(extracted=ExtractWeek('start_datetime')).order_by('start_datetime'),
  342. [(start_datetime, 25), (end_datetime, 24)],
  343. lambda m: (m.start_datetime, m.extracted)
  344. )
  345. self.assertQuerysetEqual(
  346. DTModel.objects.annotate(extracted=ExtractWeek('start_date')).order_by('start_datetime'),
  347. [(start_datetime, 25), (end_datetime, 24)],
  348. lambda m: (m.start_datetime, m.extracted)
  349. )
  350. # both dates are from the same week.
  351. self.assertEqual(DTModel.objects.filter(start_datetime__week=ExtractWeek('start_datetime')).count(), 2)
  352. def test_extract_quarter_func(self):
  353. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  354. end_datetime = datetime(2016, 8, 15, 14, 10, 50, 123)
  355. if settings.USE_TZ:
  356. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  357. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  358. self.create_model(start_datetime, end_datetime)
  359. self.create_model(end_datetime, start_datetime)
  360. self.assertQuerysetEqual(
  361. DTModel.objects.annotate(extracted=ExtractQuarter('start_datetime')).order_by('start_datetime'),
  362. [(start_datetime, 2), (end_datetime, 3)],
  363. lambda m: (m.start_datetime, m.extracted)
  364. )
  365. self.assertQuerysetEqual(
  366. DTModel.objects.annotate(extracted=ExtractQuarter('start_date')).order_by('start_datetime'),
  367. [(start_datetime, 2), (end_datetime, 3)],
  368. lambda m: (m.start_datetime, m.extracted)
  369. )
  370. self.assertEqual(DTModel.objects.filter(start_datetime__quarter=ExtractQuarter('start_datetime')).count(), 2)
  371. def test_extract_quarter_func_boundaries(self):
  372. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  373. if settings.USE_TZ:
  374. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  375. last_quarter_2014 = datetime(2014, 12, 31, 13, 0)
  376. first_quarter_2015 = datetime(2015, 1, 1, 13, 0)
  377. if settings.USE_TZ:
  378. last_quarter_2014 = timezone.make_aware(last_quarter_2014, is_dst=False)
  379. first_quarter_2015 = timezone.make_aware(first_quarter_2015, is_dst=False)
  380. dates = [last_quarter_2014, first_quarter_2015]
  381. self.create_model(last_quarter_2014, end_datetime)
  382. self.create_model(first_quarter_2015, end_datetime)
  383. qs = DTModel.objects.filter(start_datetime__in=dates).annotate(
  384. extracted=ExtractQuarter('start_datetime'),
  385. ).order_by('start_datetime')
  386. self.assertQuerysetEqual(qs, [
  387. (last_quarter_2014, 4),
  388. (first_quarter_2015, 1),
  389. ], lambda m: (m.start_datetime, m.extracted))
  390. def test_extract_week_func_boundaries(self):
  391. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  392. if settings.USE_TZ:
  393. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  394. week_52_day_2014 = datetime(2014, 12, 27, 13, 0) # Sunday
  395. week_1_day_2014_2015 = datetime(2014, 12, 31, 13, 0) # Wednesday
  396. week_53_day_2015 = datetime(2015, 12, 31, 13, 0) # Thursday
  397. if settings.USE_TZ:
  398. week_1_day_2014_2015 = timezone.make_aware(week_1_day_2014_2015, is_dst=False)
  399. week_52_day_2014 = timezone.make_aware(week_52_day_2014, is_dst=False)
  400. week_53_day_2015 = timezone.make_aware(week_53_day_2015, is_dst=False)
  401. days = [week_52_day_2014, week_1_day_2014_2015, week_53_day_2015]
  402. self.create_model(week_53_day_2015, end_datetime)
  403. self.create_model(week_52_day_2014, end_datetime)
  404. self.create_model(week_1_day_2014_2015, end_datetime)
  405. qs = DTModel.objects.filter(start_datetime__in=days).annotate(
  406. extracted=ExtractWeek('start_datetime'),
  407. ).order_by('start_datetime')
  408. self.assertQuerysetEqual(qs, [
  409. (week_52_day_2014, 52),
  410. (week_1_day_2014_2015, 1),
  411. (week_53_day_2015, 53),
  412. ], lambda m: (m.start_datetime, m.extracted))
  413. def test_extract_weekday_func(self):
  414. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  415. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  416. if settings.USE_TZ:
  417. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  418. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  419. self.create_model(start_datetime, end_datetime)
  420. self.create_model(end_datetime, start_datetime)
  421. self.assertQuerysetEqual(
  422. DTModel.objects.annotate(extracted=ExtractWeekDay('start_datetime')).order_by('start_datetime'),
  423. [
  424. (start_datetime, (start_datetime.isoweekday() % 7) + 1),
  425. (end_datetime, (end_datetime.isoweekday() % 7) + 1),
  426. ],
  427. lambda m: (m.start_datetime, m.extracted)
  428. )
  429. self.assertQuerysetEqual(
  430. DTModel.objects.annotate(extracted=ExtractWeekDay('start_date')).order_by('start_datetime'),
  431. [
  432. (start_datetime, (start_datetime.isoweekday() % 7) + 1),
  433. (end_datetime, (end_datetime.isoweekday() % 7) + 1),
  434. ],
  435. lambda m: (m.start_datetime, m.extracted)
  436. )
  437. self.assertEqual(DTModel.objects.filter(start_datetime__week_day=ExtractWeekDay('start_datetime')).count(), 2)
  438. def test_extract_hour_func(self):
  439. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  440. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  441. if settings.USE_TZ:
  442. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  443. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  444. self.create_model(start_datetime, end_datetime)
  445. self.create_model(end_datetime, start_datetime)
  446. self.assertQuerysetEqual(
  447. DTModel.objects.annotate(extracted=ExtractHour('start_datetime')).order_by('start_datetime'),
  448. [(start_datetime, start_datetime.hour), (end_datetime, end_datetime.hour)],
  449. lambda m: (m.start_datetime, m.extracted)
  450. )
  451. self.assertQuerysetEqual(
  452. DTModel.objects.annotate(extracted=ExtractHour('start_time')).order_by('start_datetime'),
  453. [(start_datetime, start_datetime.hour), (end_datetime, end_datetime.hour)],
  454. lambda m: (m.start_datetime, m.extracted)
  455. )
  456. self.assertEqual(DTModel.objects.filter(start_datetime__hour=ExtractHour('start_datetime')).count(), 2)
  457. def test_extract_minute_func(self):
  458. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  459. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  460. if settings.USE_TZ:
  461. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  462. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  463. self.create_model(start_datetime, end_datetime)
  464. self.create_model(end_datetime, start_datetime)
  465. self.assertQuerysetEqual(
  466. DTModel.objects.annotate(extracted=ExtractMinute('start_datetime')).order_by('start_datetime'),
  467. [(start_datetime, start_datetime.minute), (end_datetime, end_datetime.minute)],
  468. lambda m: (m.start_datetime, m.extracted)
  469. )
  470. self.assertQuerysetEqual(
  471. DTModel.objects.annotate(extracted=ExtractMinute('start_time')).order_by('start_datetime'),
  472. [(start_datetime, start_datetime.minute), (end_datetime, end_datetime.minute)],
  473. lambda m: (m.start_datetime, m.extracted)
  474. )
  475. self.assertEqual(DTModel.objects.filter(start_datetime__minute=ExtractMinute('start_datetime')).count(), 2)
  476. def test_extract_second_func(self):
  477. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  478. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  479. if settings.USE_TZ:
  480. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  481. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  482. self.create_model(start_datetime, end_datetime)
  483. self.create_model(end_datetime, start_datetime)
  484. self.assertQuerysetEqual(
  485. DTModel.objects.annotate(extracted=ExtractSecond('start_datetime')).order_by('start_datetime'),
  486. [(start_datetime, start_datetime.second), (end_datetime, end_datetime.second)],
  487. lambda m: (m.start_datetime, m.extracted)
  488. )
  489. self.assertQuerysetEqual(
  490. DTModel.objects.annotate(extracted=ExtractSecond('start_time')).order_by('start_datetime'),
  491. [(start_datetime, start_datetime.second), (end_datetime, end_datetime.second)],
  492. lambda m: (m.start_datetime, m.extracted)
  493. )
  494. self.assertEqual(DTModel.objects.filter(start_datetime__second=ExtractSecond('start_datetime')).count(), 2)
  495. def test_trunc_func(self):
  496. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  497. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  498. if settings.USE_TZ:
  499. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  500. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  501. self.create_model(start_datetime, end_datetime)
  502. self.create_model(end_datetime, start_datetime)
  503. msg = 'output_field must be either DateField, TimeField, or DateTimeField'
  504. with self.assertRaisesMessage(ValueError, msg):
  505. list(DTModel.objects.annotate(truncated=Trunc('start_datetime', 'year', output_field=IntegerField())))
  506. with self.assertRaisesMessage(AssertionError, "'name' isn't a DateField, TimeField, or DateTimeField."):
  507. list(DTModel.objects.annotate(truncated=Trunc('name', 'year', output_field=DateTimeField())))
  508. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to DateTimeField"):
  509. list(DTModel.objects.annotate(truncated=Trunc('start_date', 'second')))
  510. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  511. list(DTModel.objects.annotate(truncated=Trunc('start_time', 'month')))
  512. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to DateTimeField"):
  513. list(DTModel.objects.annotate(truncated=Trunc('start_date', 'month', output_field=DateTimeField())))
  514. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  515. list(DTModel.objects.annotate(truncated=Trunc('start_time', 'second', output_field=DateTimeField())))
  516. def test_datetime_kind(kind):
  517. self.assertQuerysetEqual(
  518. DTModel.objects.annotate(
  519. truncated=Trunc('start_datetime', kind, output_field=DateTimeField())
  520. ).order_by('start_datetime'),
  521. [
  522. (start_datetime, truncate_to(start_datetime, kind)),
  523. (end_datetime, truncate_to(end_datetime, kind))
  524. ],
  525. lambda m: (m.start_datetime, m.truncated)
  526. )
  527. def test_date_kind(kind):
  528. self.assertQuerysetEqual(
  529. DTModel.objects.annotate(
  530. truncated=Trunc('start_date', kind, output_field=DateField())
  531. ).order_by('start_datetime'),
  532. [
  533. (start_datetime, truncate_to(start_datetime.date(), kind)),
  534. (end_datetime, truncate_to(end_datetime.date(), kind))
  535. ],
  536. lambda m: (m.start_datetime, m.truncated)
  537. )
  538. def test_time_kind(kind):
  539. self.assertQuerysetEqual(
  540. DTModel.objects.annotate(
  541. truncated=Trunc('start_time', kind, output_field=TimeField())
  542. ).order_by('start_datetime'),
  543. [
  544. (start_datetime, truncate_to(start_datetime.time(), kind)),
  545. (end_datetime, truncate_to(end_datetime.time(), kind))
  546. ],
  547. lambda m: (m.start_datetime, m.truncated)
  548. )
  549. test_date_kind('year')
  550. test_date_kind('quarter')
  551. test_date_kind('month')
  552. test_date_kind('week')
  553. test_date_kind('day')
  554. test_time_kind('hour')
  555. test_time_kind('minute')
  556. test_time_kind('second')
  557. test_datetime_kind('year')
  558. test_datetime_kind('quarter')
  559. test_datetime_kind('month')
  560. test_datetime_kind('week')
  561. test_datetime_kind('day')
  562. test_datetime_kind('hour')
  563. test_datetime_kind('minute')
  564. test_datetime_kind('second')
  565. qs = DTModel.objects.filter(start_datetime__date=Trunc('start_datetime', 'day', output_field=DateField()))
  566. self.assertEqual(qs.count(), 2)
  567. def test_trunc_none(self):
  568. self.create_model(None, None)
  569. for t in (Trunc('start_datetime', 'year'), Trunc('start_date', 'year'), Trunc('start_time', 'hour')):
  570. with self.subTest(t):
  571. self.assertIsNone(DTModel.objects.annotate(truncated=t).first().truncated)
  572. def test_trunc_year_func(self):
  573. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  574. end_datetime = truncate_to(datetime(2016, 6, 15, 14, 10, 50, 123), 'year')
  575. if settings.USE_TZ:
  576. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  577. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  578. self.create_model(start_datetime, end_datetime)
  579. self.create_model(end_datetime, start_datetime)
  580. self.assertQuerysetEqual(
  581. DTModel.objects.annotate(extracted=TruncYear('start_datetime')).order_by('start_datetime'),
  582. [
  583. (start_datetime, truncate_to(start_datetime, 'year')),
  584. (end_datetime, truncate_to(end_datetime, 'year')),
  585. ],
  586. lambda m: (m.start_datetime, m.extracted)
  587. )
  588. self.assertQuerysetEqual(
  589. DTModel.objects.annotate(extracted=TruncYear('start_date')).order_by('start_datetime'),
  590. [
  591. (start_datetime, truncate_to(start_datetime.date(), 'year')),
  592. (end_datetime, truncate_to(end_datetime.date(), 'year')),
  593. ],
  594. lambda m: (m.start_datetime, m.extracted)
  595. )
  596. self.assertEqual(DTModel.objects.filter(start_datetime=TruncYear('start_datetime')).count(), 1)
  597. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  598. list(DTModel.objects.annotate(truncated=TruncYear('start_time')))
  599. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  600. list(DTModel.objects.annotate(truncated=TruncYear('start_time', output_field=TimeField())))
  601. def test_trunc_quarter_func(self):
  602. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  603. end_datetime = truncate_to(datetime(2016, 10, 15, 14, 10, 50, 123), 'quarter')
  604. last_quarter_2015 = truncate_to(datetime(2015, 12, 31, 14, 10, 50, 123), 'quarter')
  605. first_quarter_2016 = truncate_to(datetime(2016, 1, 1, 14, 10, 50, 123), 'quarter')
  606. if settings.USE_TZ:
  607. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  608. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  609. last_quarter_2015 = timezone.make_aware(last_quarter_2015, is_dst=False)
  610. first_quarter_2016 = timezone.make_aware(first_quarter_2016, is_dst=False)
  611. self.create_model(start_datetime=start_datetime, end_datetime=end_datetime)
  612. self.create_model(start_datetime=end_datetime, end_datetime=start_datetime)
  613. self.create_model(start_datetime=last_quarter_2015, end_datetime=end_datetime)
  614. self.create_model(start_datetime=first_quarter_2016, end_datetime=end_datetime)
  615. self.assertQuerysetEqual(
  616. DTModel.objects.annotate(extracted=TruncQuarter('start_date')).order_by('start_datetime'),
  617. [
  618. (start_datetime, truncate_to(start_datetime.date(), 'quarter')),
  619. (last_quarter_2015, truncate_to(last_quarter_2015.date(), 'quarter')),
  620. (first_quarter_2016, truncate_to(first_quarter_2016.date(), 'quarter')),
  621. (end_datetime, truncate_to(end_datetime.date(), 'quarter')),
  622. ],
  623. lambda m: (m.start_datetime, m.extracted)
  624. )
  625. self.assertQuerysetEqual(
  626. DTModel.objects.annotate(extracted=TruncQuarter('start_datetime')).order_by('start_datetime'),
  627. [
  628. (start_datetime, truncate_to(start_datetime, 'quarter')),
  629. (last_quarter_2015, truncate_to(last_quarter_2015, 'quarter')),
  630. (first_quarter_2016, truncate_to(first_quarter_2016, 'quarter')),
  631. (end_datetime, truncate_to(end_datetime, 'quarter')),
  632. ],
  633. lambda m: (m.start_datetime, m.extracted)
  634. )
  635. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  636. list(DTModel.objects.annotate(truncated=TruncQuarter('start_time')))
  637. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  638. list(DTModel.objects.annotate(truncated=TruncQuarter('start_time', output_field=TimeField())))
  639. def test_trunc_month_func(self):
  640. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  641. end_datetime = truncate_to(datetime(2016, 6, 15, 14, 10, 50, 123), 'month')
  642. if settings.USE_TZ:
  643. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  644. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  645. self.create_model(start_datetime, end_datetime)
  646. self.create_model(end_datetime, start_datetime)
  647. self.assertQuerysetEqual(
  648. DTModel.objects.annotate(extracted=TruncMonth('start_datetime')).order_by('start_datetime'),
  649. [
  650. (start_datetime, truncate_to(start_datetime, 'month')),
  651. (end_datetime, truncate_to(end_datetime, 'month')),
  652. ],
  653. lambda m: (m.start_datetime, m.extracted)
  654. )
  655. self.assertQuerysetEqual(
  656. DTModel.objects.annotate(extracted=TruncMonth('start_date')).order_by('start_datetime'),
  657. [
  658. (start_datetime, truncate_to(start_datetime.date(), 'month')),
  659. (end_datetime, truncate_to(end_datetime.date(), 'month')),
  660. ],
  661. lambda m: (m.start_datetime, m.extracted)
  662. )
  663. self.assertEqual(DTModel.objects.filter(start_datetime=TruncMonth('start_datetime')).count(), 1)
  664. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  665. list(DTModel.objects.annotate(truncated=TruncMonth('start_time')))
  666. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  667. list(DTModel.objects.annotate(truncated=TruncMonth('start_time', output_field=TimeField())))
  668. def test_trunc_week_func(self):
  669. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  670. end_datetime = truncate_to(datetime(2016, 6, 15, 14, 10, 50, 123), 'week')
  671. if settings.USE_TZ:
  672. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  673. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  674. self.create_model(start_datetime, end_datetime)
  675. self.create_model(end_datetime, start_datetime)
  676. self.assertQuerysetEqual(
  677. DTModel.objects.annotate(extracted=TruncWeek('start_datetime')).order_by('start_datetime'),
  678. [
  679. (start_datetime, truncate_to(start_datetime, 'week')),
  680. (end_datetime, truncate_to(end_datetime, 'week')),
  681. ],
  682. lambda m: (m.start_datetime, m.extracted)
  683. )
  684. self.assertEqual(DTModel.objects.filter(start_datetime=TruncWeek('start_datetime')).count(), 1)
  685. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  686. list(DTModel.objects.annotate(truncated=TruncWeek('start_time')))
  687. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  688. list(DTModel.objects.annotate(truncated=TruncWeek('start_time', output_field=TimeField())))
  689. def test_trunc_date_func(self):
  690. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  691. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  692. if settings.USE_TZ:
  693. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  694. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  695. self.create_model(start_datetime, end_datetime)
  696. self.create_model(end_datetime, start_datetime)
  697. self.assertQuerysetEqual(
  698. DTModel.objects.annotate(extracted=TruncDate('start_datetime')).order_by('start_datetime'),
  699. [
  700. (start_datetime, start_datetime.date()),
  701. (end_datetime, end_datetime.date()),
  702. ],
  703. lambda m: (m.start_datetime, m.extracted)
  704. )
  705. self.assertEqual(DTModel.objects.filter(start_datetime__date=TruncDate('start_datetime')).count(), 2)
  706. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateField"):
  707. list(DTModel.objects.annotate(truncated=TruncDate('start_time')))
  708. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateField"):
  709. list(DTModel.objects.annotate(truncated=TruncDate('start_time', output_field=TimeField())))
  710. def test_trunc_date_none(self):
  711. self.create_model(None, None)
  712. self.assertIsNone(DTModel.objects.annotate(truncated=TruncDate('start_datetime')).first().truncated)
  713. def test_trunc_time_func(self):
  714. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  715. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  716. if settings.USE_TZ:
  717. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  718. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  719. self.create_model(start_datetime, end_datetime)
  720. self.create_model(end_datetime, start_datetime)
  721. self.assertQuerysetEqual(
  722. DTModel.objects.annotate(extracted=TruncTime('start_datetime')).order_by('start_datetime'),
  723. [
  724. (start_datetime, start_datetime.time()),
  725. (end_datetime, end_datetime.time()),
  726. ],
  727. lambda m: (m.start_datetime, m.extracted)
  728. )
  729. self.assertEqual(DTModel.objects.filter(start_datetime__time=TruncTime('start_datetime')).count(), 2)
  730. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to TimeField"):
  731. list(DTModel.objects.annotate(truncated=TruncTime('start_date')))
  732. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to TimeField"):
  733. list(DTModel.objects.annotate(truncated=TruncTime('start_date', output_field=DateField())))
  734. def test_trunc_time_none(self):
  735. self.create_model(None, None)
  736. self.assertIsNone(DTModel.objects.annotate(truncated=TruncTime('start_datetime')).first().truncated)
  737. def test_trunc_day_func(self):
  738. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  739. end_datetime = truncate_to(datetime(2016, 6, 15, 14, 10, 50, 123), 'day')
  740. if settings.USE_TZ:
  741. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  742. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  743. self.create_model(start_datetime, end_datetime)
  744. self.create_model(end_datetime, start_datetime)
  745. self.assertQuerysetEqual(
  746. DTModel.objects.annotate(extracted=TruncDay('start_datetime')).order_by('start_datetime'),
  747. [
  748. (start_datetime, truncate_to(start_datetime, 'day')),
  749. (end_datetime, truncate_to(end_datetime, 'day')),
  750. ],
  751. lambda m: (m.start_datetime, m.extracted)
  752. )
  753. self.assertEqual(DTModel.objects.filter(start_datetime=TruncDay('start_datetime')).count(), 1)
  754. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  755. list(DTModel.objects.annotate(truncated=TruncDay('start_time')))
  756. with self.assertRaisesMessage(ValueError, "Cannot truncate TimeField 'start_time' to DateTimeField"):
  757. list(DTModel.objects.annotate(truncated=TruncDay('start_time', output_field=TimeField())))
  758. def test_trunc_hour_func(self):
  759. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  760. end_datetime = truncate_to(datetime(2016, 6, 15, 14, 10, 50, 123), 'hour')
  761. if settings.USE_TZ:
  762. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  763. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  764. self.create_model(start_datetime, end_datetime)
  765. self.create_model(end_datetime, start_datetime)
  766. self.assertQuerysetEqual(
  767. DTModel.objects.annotate(extracted=TruncHour('start_datetime')).order_by('start_datetime'),
  768. [
  769. (start_datetime, truncate_to(start_datetime, 'hour')),
  770. (end_datetime, truncate_to(end_datetime, 'hour')),
  771. ],
  772. lambda m: (m.start_datetime, m.extracted)
  773. )
  774. self.assertQuerysetEqual(
  775. DTModel.objects.annotate(extracted=TruncHour('start_time')).order_by('start_datetime'),
  776. [
  777. (start_datetime, truncate_to(start_datetime.time(), 'hour')),
  778. (end_datetime, truncate_to(end_datetime.time(), 'hour')),
  779. ],
  780. lambda m: (m.start_datetime, m.extracted)
  781. )
  782. self.assertEqual(DTModel.objects.filter(start_datetime=TruncHour('start_datetime')).count(), 1)
  783. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to DateTimeField"):
  784. list(DTModel.objects.annotate(truncated=TruncHour('start_date')))
  785. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to DateTimeField"):
  786. list(DTModel.objects.annotate(truncated=TruncHour('start_date', output_field=DateField())))
  787. def test_trunc_minute_func(self):
  788. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  789. end_datetime = truncate_to(datetime(2016, 6, 15, 14, 10, 50, 123), 'minute')
  790. if settings.USE_TZ:
  791. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  792. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  793. self.create_model(start_datetime, end_datetime)
  794. self.create_model(end_datetime, start_datetime)
  795. self.assertQuerysetEqual(
  796. DTModel.objects.annotate(extracted=TruncMinute('start_datetime')).order_by('start_datetime'),
  797. [
  798. (start_datetime, truncate_to(start_datetime, 'minute')),
  799. (end_datetime, truncate_to(end_datetime, 'minute')),
  800. ],
  801. lambda m: (m.start_datetime, m.extracted)
  802. )
  803. self.assertQuerysetEqual(
  804. DTModel.objects.annotate(extracted=TruncMinute('start_time')).order_by('start_datetime'),
  805. [
  806. (start_datetime, truncate_to(start_datetime.time(), 'minute')),
  807. (end_datetime, truncate_to(end_datetime.time(), 'minute')),
  808. ],
  809. lambda m: (m.start_datetime, m.extracted)
  810. )
  811. self.assertEqual(DTModel.objects.filter(start_datetime=TruncMinute('start_datetime')).count(), 1)
  812. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to DateTimeField"):
  813. list(DTModel.objects.annotate(truncated=TruncMinute('start_date')))
  814. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to DateTimeField"):
  815. list(DTModel.objects.annotate(truncated=TruncMinute('start_date', output_field=DateField())))
  816. def test_trunc_second_func(self):
  817. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  818. end_datetime = truncate_to(datetime(2016, 6, 15, 14, 10, 50, 123), 'second')
  819. if settings.USE_TZ:
  820. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  821. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  822. self.create_model(start_datetime, end_datetime)
  823. self.create_model(end_datetime, start_datetime)
  824. self.assertQuerysetEqual(
  825. DTModel.objects.annotate(extracted=TruncSecond('start_datetime')).order_by('start_datetime'),
  826. [
  827. (start_datetime, truncate_to(start_datetime, 'second')),
  828. (end_datetime, truncate_to(end_datetime, 'second'))
  829. ],
  830. lambda m: (m.start_datetime, m.extracted)
  831. )
  832. self.assertQuerysetEqual(
  833. DTModel.objects.annotate(extracted=TruncSecond('start_time')).order_by('start_datetime'),
  834. [
  835. (start_datetime, truncate_to(start_datetime.time(), 'second')),
  836. (end_datetime, truncate_to(end_datetime.time(), 'second'))
  837. ],
  838. lambda m: (m.start_datetime, m.extracted)
  839. )
  840. self.assertEqual(DTModel.objects.filter(start_datetime=TruncSecond('start_datetime')).count(), 1)
  841. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to DateTimeField"):
  842. list(DTModel.objects.annotate(truncated=TruncSecond('start_date')))
  843. with self.assertRaisesMessage(ValueError, "Cannot truncate DateField 'start_date' to DateTimeField"):
  844. list(DTModel.objects.annotate(truncated=TruncSecond('start_date', output_field=DateField())))
  845. def test_trunc_subquery_with_parameters(self):
  846. author_1 = Author.objects.create(name='J. R. R. Tolkien')
  847. author_2 = Author.objects.create(name='G. R. R. Martin')
  848. fan_since_1 = datetime(2016, 2, 3, 15, 0, 0)
  849. fan_since_2 = datetime(2015, 2, 3, 15, 0, 0)
  850. fan_since_3 = datetime(2017, 2, 3, 15, 0, 0)
  851. if settings.USE_TZ:
  852. fan_since_1 = timezone.make_aware(fan_since_1, is_dst=False)
  853. fan_since_2 = timezone.make_aware(fan_since_2, is_dst=False)
  854. fan_since_3 = timezone.make_aware(fan_since_3, is_dst=False)
  855. Fan.objects.create(author=author_1, name='Tom', fan_since=fan_since_1)
  856. Fan.objects.create(author=author_1, name='Emma', fan_since=fan_since_2)
  857. Fan.objects.create(author=author_2, name='Isabella', fan_since=fan_since_3)
  858. inner = Fan.objects.filter(
  859. author=OuterRef('pk'),
  860. name__in=('Emma', 'Isabella', 'Tom')
  861. ).values('author').annotate(newest_fan=Max('fan_since')).values('newest_fan')
  862. outer = Author.objects.annotate(
  863. newest_fan_year=TruncYear(Subquery(inner, output_field=DateTimeField()))
  864. )
  865. tz = pytz.UTC if settings.USE_TZ else None
  866. self.assertSequenceEqual(
  867. outer.order_by('name').values('name', 'newest_fan_year'),
  868. [
  869. {'name': 'G. R. R. Martin', 'newest_fan_year': datetime(2017, 1, 1, 0, 0, tzinfo=tz)},
  870. {'name': 'J. R. R. Tolkien', 'newest_fan_year': datetime(2016, 1, 1, 0, 0, tzinfo=tz)},
  871. ]
  872. )
  873. @override_settings(USE_TZ=True, TIME_ZONE='UTC')
  874. class DateFunctionWithTimeZoneTests(DateFunctionTests):
  875. def test_extract_func_with_timezone(self):
  876. start_datetime = datetime(2015, 6, 15, 23, 30, 1, 321)
  877. end_datetime = datetime(2015, 6, 16, 13, 11, 27, 123)
  878. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  879. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  880. self.create_model(start_datetime, end_datetime)
  881. melb = pytz.timezone('Australia/Melbourne')
  882. qs = DTModel.objects.annotate(
  883. day=Extract('start_datetime', 'day'),
  884. day_melb=Extract('start_datetime', 'day', tzinfo=melb),
  885. week=Extract('start_datetime', 'week', tzinfo=melb),
  886. isoyear=ExtractIsoYear('start_datetime', tzinfo=melb),
  887. weekday=ExtractWeekDay('start_datetime'),
  888. weekday_melb=ExtractWeekDay('start_datetime', tzinfo=melb),
  889. quarter=ExtractQuarter('start_datetime', tzinfo=melb),
  890. hour=ExtractHour('start_datetime'),
  891. hour_melb=ExtractHour('start_datetime', tzinfo=melb),
  892. ).order_by('start_datetime')
  893. utc_model = qs.get()
  894. self.assertEqual(utc_model.day, 15)
  895. self.assertEqual(utc_model.day_melb, 16)
  896. self.assertEqual(utc_model.week, 25)
  897. self.assertEqual(utc_model.isoyear, 2015)
  898. self.assertEqual(utc_model.weekday, 2)
  899. self.assertEqual(utc_model.weekday_melb, 3)
  900. self.assertEqual(utc_model.quarter, 2)
  901. self.assertEqual(utc_model.hour, 23)
  902. self.assertEqual(utc_model.hour_melb, 9)
  903. with timezone.override(melb):
  904. melb_model = qs.get()
  905. self.assertEqual(melb_model.day, 16)
  906. self.assertEqual(melb_model.day_melb, 16)
  907. self.assertEqual(melb_model.week, 25)
  908. self.assertEqual(melb_model.isoyear, 2015)
  909. self.assertEqual(melb_model.weekday, 3)
  910. self.assertEqual(melb_model.quarter, 2)
  911. self.assertEqual(melb_model.weekday_melb, 3)
  912. self.assertEqual(melb_model.hour, 9)
  913. self.assertEqual(melb_model.hour_melb, 9)
  914. def test_extract_func_explicit_timezone_priority(self):
  915. start_datetime = datetime(2015, 6, 15, 23, 30, 1, 321)
  916. end_datetime = datetime(2015, 6, 16, 13, 11, 27, 123)
  917. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  918. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  919. self.create_model(start_datetime, end_datetime)
  920. melb = pytz.timezone('Australia/Melbourne')
  921. with timezone.override(melb):
  922. model = DTModel.objects.annotate(
  923. day_melb=Extract('start_datetime', 'day'),
  924. day_utc=Extract('start_datetime', 'day', tzinfo=timezone.utc),
  925. ).order_by('start_datetime').get()
  926. self.assertEqual(model.day_melb, 16)
  927. self.assertEqual(model.day_utc, 15)
  928. def test_trunc_timezone_applied_before_truncation(self):
  929. start_datetime = datetime(2016, 1, 1, 1, 30, 50, 321)
  930. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  931. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  932. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  933. self.create_model(start_datetime, end_datetime)
  934. melb = pytz.timezone('Australia/Melbourne')
  935. pacific = pytz.timezone('US/Pacific')
  936. model = DTModel.objects.annotate(
  937. melb_year=TruncYear('start_datetime', tzinfo=melb),
  938. pacific_year=TruncYear('start_datetime', tzinfo=pacific),
  939. ).order_by('start_datetime').get()
  940. self.assertEqual(model.start_datetime, start_datetime)
  941. self.assertEqual(model.melb_year, truncate_to(start_datetime, 'year', melb))
  942. self.assertEqual(model.pacific_year, truncate_to(start_datetime, 'year', pacific))
  943. self.assertEqual(model.start_datetime.year, 2016)
  944. self.assertEqual(model.melb_year.year, 2016)
  945. self.assertEqual(model.pacific_year.year, 2015)
  946. def test_trunc_ambiguous_and_invalid_times(self):
  947. sao = pytz.timezone('America/Sao_Paulo')
  948. utc = pytz.timezone('UTC')
  949. start_datetime = utc.localize(datetime(2016, 10, 16, 13))
  950. end_datetime = utc.localize(datetime(2016, 2, 21, 1))
  951. self.create_model(start_datetime, end_datetime)
  952. with timezone.override(sao):
  953. with self.assertRaisesMessage(pytz.NonExistentTimeError, '2016-10-16 00:00:00'):
  954. model = DTModel.objects.annotate(truncated_start=TruncDay('start_datetime')).get()
  955. with self.assertRaisesMessage(pytz.AmbiguousTimeError, '2016-02-20 23:00:00'):
  956. model = DTModel.objects.annotate(truncated_end=TruncHour('end_datetime')).get()
  957. model = DTModel.objects.annotate(
  958. truncated_start=TruncDay('start_datetime', is_dst=False),
  959. truncated_end=TruncHour('end_datetime', is_dst=False),
  960. ).get()
  961. self.assertEqual(model.truncated_start.dst(), timedelta(0))
  962. self.assertEqual(model.truncated_end.dst(), timedelta(0))
  963. model = DTModel.objects.annotate(
  964. truncated_start=TruncDay('start_datetime', is_dst=True),
  965. truncated_end=TruncHour('end_datetime', is_dst=True),
  966. ).get()
  967. self.assertEqual(model.truncated_start.dst(), timedelta(0, 3600))
  968. self.assertEqual(model.truncated_end.dst(), timedelta(0, 3600))
  969. def test_trunc_func_with_timezone(self):
  970. """
  971. If the truncated datetime transitions to a different offset (daylight
  972. saving) then the returned value will have that new timezone/offset.
  973. """
  974. start_datetime = datetime(2015, 6, 15, 14, 30, 50, 321)
  975. end_datetime = datetime(2016, 6, 15, 14, 10, 50, 123)
  976. start_datetime = timezone.make_aware(start_datetime, is_dst=False)
  977. end_datetime = timezone.make_aware(end_datetime, is_dst=False)
  978. self.create_model(start_datetime, end_datetime)
  979. self.create_model(end_datetime, start_datetime)
  980. melb = pytz.timezone('Australia/Melbourne')
  981. def test_datetime_kind(kind):
  982. self.assertQuerysetEqual(
  983. DTModel.objects.annotate(
  984. truncated=Trunc('start_datetime', kind, output_field=DateTimeField(), tzinfo=melb)
  985. ).order_by('start_datetime'),
  986. [
  987. (start_datetime, truncate_to(start_datetime.astimezone(melb), kind, melb)),
  988. (end_datetime, truncate_to(end_datetime.astimezone(melb), kind, melb))
  989. ],
  990. lambda m: (m.start_datetime, m.truncated)
  991. )
  992. def test_date_kind(kind):
  993. self.assertQuerysetEqual(
  994. DTModel.objects.annotate(
  995. truncated=Trunc('start_date', kind, output_field=DateField(), tzinfo=melb)
  996. ).order_by('start_datetime'),
  997. [
  998. (start_datetime, truncate_to(start_datetime.date(), kind)),
  999. (end_datetime, truncate_to(end_datetime.date(), kind))
  1000. ],
  1001. lambda m: (m.start_datetime, m.truncated)
  1002. )
  1003. def test_time_kind(kind):
  1004. self.assertQuerysetEqual(
  1005. DTModel.objects.annotate(
  1006. truncated=Trunc('start_time', kind, output_field=TimeField(), tzinfo=melb)
  1007. ).order_by('start_datetime'),
  1008. [
  1009. (start_datetime, truncate_to(start_datetime.time(), kind)),
  1010. (end_datetime, truncate_to(end_datetime.time(), kind))
  1011. ],
  1012. lambda m: (m.start_datetime, m.truncated)
  1013. )
  1014. test_date_kind('year')
  1015. test_date_kind('quarter')
  1016. test_date_kind('month')
  1017. test_date_kind('week')
  1018. test_date_kind('day')
  1019. test_time_kind('hour')
  1020. test_time_kind('minute')
  1021. test_time_kind('second')
  1022. test_datetime_kind('year')
  1023. test_datetime_kind('quarter')
  1024. test_datetime_kind('month')
  1025. test_datetime_kind('week')
  1026. test_datetime_kind('day')
  1027. test_datetime_kind('hour')
  1028. test_datetime_kind('minute')
  1029. test_datetime_kind('second')
  1030. qs = DTModel.objects.filter(start_datetime__date=Trunc('start_datetime', 'day', output_field=DateField()))
  1031. self.assertEqual(qs.count(), 2)