Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

datetime.py 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  1. from datetime import datetime
  2. from django.conf import settings
  3. from django.db.models import (
  4. DateField, DateTimeField, DurationField, Field, Func, IntegerField,
  5. TimeField, Transform, fields,
  6. )
  7. from django.db.models.lookups import (
  8. YearExact, YearGt, YearGte, YearLt, YearLte,
  9. )
  10. from django.utils import timezone
  11. class TimezoneMixin:
  12. tzinfo = None
  13. def get_tzname(self):
  14. # Timezone conversions must happen to the input datetime *before*
  15. # applying a function. 2015-12-31 23:00:00 -02:00 is stored in the
  16. # database as 2016-01-01 01:00:00 +00:00. Any results should be
  17. # based on the input datetime not the stored datetime.
  18. tzname = None
  19. if settings.USE_TZ:
  20. if self.tzinfo is None:
  21. tzname = timezone.get_current_timezone_name()
  22. else:
  23. tzname = timezone._get_timezone_name(self.tzinfo)
  24. return tzname
  25. class Extract(TimezoneMixin, Transform):
  26. lookup_name = None
  27. output_field = IntegerField()
  28. def __init__(self, expression, lookup_name=None, tzinfo=None, **extra):
  29. if self.lookup_name is None:
  30. self.lookup_name = lookup_name
  31. if self.lookup_name is None:
  32. raise ValueError('lookup_name must be provided')
  33. self.tzinfo = tzinfo
  34. super().__init__(expression, **extra)
  35. def as_sql(self, compiler, connection):
  36. sql, params = compiler.compile(self.lhs)
  37. lhs_output_field = self.lhs.output_field
  38. if isinstance(lhs_output_field, DateTimeField):
  39. tzname = self.get_tzname()
  40. sql = connection.ops.datetime_extract_sql(self.lookup_name, sql, tzname)
  41. elif isinstance(lhs_output_field, DateField):
  42. sql = connection.ops.date_extract_sql(self.lookup_name, sql)
  43. elif isinstance(lhs_output_field, TimeField):
  44. sql = connection.ops.time_extract_sql(self.lookup_name, sql)
  45. elif isinstance(lhs_output_field, DurationField):
  46. if not connection.features.has_native_duration_field:
  47. raise ValueError('Extract requires native DurationField database support.')
  48. sql = connection.ops.time_extract_sql(self.lookup_name, sql)
  49. else:
  50. # resolve_expression has already validated the output_field so this
  51. # assert should never be hit.
  52. assert False, "Tried to Extract from an invalid type."
  53. return sql, params
  54. def resolve_expression(self, query=None, allow_joins=True, reuse=None, summarize=False, for_save=False):
  55. copy = super().resolve_expression(query, allow_joins, reuse, summarize, for_save)
  56. field = copy.lhs.output_field
  57. if not isinstance(field, (DateField, DateTimeField, TimeField, DurationField)):
  58. raise ValueError(
  59. 'Extract input expression must be DateField, DateTimeField, '
  60. 'TimeField, or DurationField.'
  61. )
  62. # Passing dates to functions expecting datetimes is most likely a mistake.
  63. if type(field) == DateField and copy.lookup_name in ('hour', 'minute', 'second'):
  64. raise ValueError(
  65. "Cannot extract time component '%s' from DateField '%s'. " % (copy.lookup_name, field.name)
  66. )
  67. return copy
  68. class ExtractYear(Extract):
  69. lookup_name = 'year'
  70. class ExtractMonth(Extract):
  71. lookup_name = 'month'
  72. class ExtractDay(Extract):
  73. lookup_name = 'day'
  74. class ExtractWeek(Extract):
  75. """
  76. Return 1-52 or 53, based on ISO-8601, i.e., Monday is the first of the
  77. week.
  78. """
  79. lookup_name = 'week'
  80. class ExtractWeekDay(Extract):
  81. """
  82. Return Sunday=1 through Saturday=7.
  83. To replicate this in Python: (mydatetime.isoweekday() % 7) + 1
  84. """
  85. lookup_name = 'week_day'
  86. class ExtractQuarter(Extract):
  87. lookup_name = 'quarter'
  88. class ExtractHour(Extract):
  89. lookup_name = 'hour'
  90. class ExtractMinute(Extract):
  91. lookup_name = 'minute'
  92. class ExtractSecond(Extract):
  93. lookup_name = 'second'
  94. DateField.register_lookup(ExtractYear)
  95. DateField.register_lookup(ExtractMonth)
  96. DateField.register_lookup(ExtractDay)
  97. DateField.register_lookup(ExtractWeekDay)
  98. DateField.register_lookup(ExtractWeek)
  99. DateField.register_lookup(ExtractQuarter)
  100. TimeField.register_lookup(ExtractHour)
  101. TimeField.register_lookup(ExtractMinute)
  102. TimeField.register_lookup(ExtractSecond)
  103. DateTimeField.register_lookup(ExtractHour)
  104. DateTimeField.register_lookup(ExtractMinute)
  105. DateTimeField.register_lookup(ExtractSecond)
  106. ExtractYear.register_lookup(YearExact)
  107. ExtractYear.register_lookup(YearGt)
  108. ExtractYear.register_lookup(YearGte)
  109. ExtractYear.register_lookup(YearLt)
  110. ExtractYear.register_lookup(YearLte)
  111. class Now(Func):
  112. template = 'CURRENT_TIMESTAMP'
  113. output_field = fields.DateTimeField()
  114. def as_postgresql(self, compiler, connection):
  115. # PostgreSQL's CURRENT_TIMESTAMP means "the time at the start of the
  116. # transaction". Use STATEMENT_TIMESTAMP to be cross-compatible with
  117. # other databases.
  118. return self.as_sql(compiler, connection, template='STATEMENT_TIMESTAMP()')
  119. class TruncBase(TimezoneMixin, Transform):
  120. kind = None
  121. tzinfo = None
  122. def __init__(self, expression, output_field=None, tzinfo=None, **extra):
  123. self.tzinfo = tzinfo
  124. super().__init__(expression, output_field=output_field, **extra)
  125. def as_sql(self, compiler, connection):
  126. inner_sql, inner_params = compiler.compile(self.lhs)
  127. # Escape any params because trunc_sql will format the string.
  128. inner_sql = inner_sql.replace('%s', '%%s')
  129. if isinstance(self.output_field, DateTimeField):
  130. tzname = self.get_tzname()
  131. sql = connection.ops.datetime_trunc_sql(self.kind, inner_sql, tzname)
  132. elif isinstance(self.output_field, DateField):
  133. sql = connection.ops.date_trunc_sql(self.kind, inner_sql)
  134. elif isinstance(self.output_field, TimeField):
  135. sql = connection.ops.time_trunc_sql(self.kind, inner_sql)
  136. else:
  137. raise ValueError('Trunc only valid on DateField, TimeField, or DateTimeField.')
  138. return sql, inner_params
  139. def resolve_expression(self, query=None, allow_joins=True, reuse=None, summarize=False, for_save=False):
  140. copy = super().resolve_expression(query, allow_joins, reuse, summarize, for_save)
  141. field = copy.lhs.output_field
  142. # DateTimeField is a subclass of DateField so this works for both.
  143. assert isinstance(field, (DateField, TimeField)), (
  144. "%r isn't a DateField, TimeField, or DateTimeField." % field.name
  145. )
  146. # If self.output_field was None, then accessing the field will trigger
  147. # the resolver to assign it to self.lhs.output_field.
  148. if not isinstance(copy.output_field, (DateField, DateTimeField, TimeField)):
  149. raise ValueError('output_field must be either DateField, TimeField, or DateTimeField')
  150. # Passing dates or times to functions expecting datetimes is most
  151. # likely a mistake.
  152. class_output_field = self.__class__.output_field if isinstance(self.__class__.output_field, Field) else None
  153. output_field = class_output_field or copy.output_field
  154. has_explicit_output_field = class_output_field or field.__class__ is not copy.output_field.__class__
  155. if type(field) == DateField and (
  156. isinstance(output_field, DateTimeField) or copy.kind in ('hour', 'minute', 'second', 'time')):
  157. raise ValueError("Cannot truncate DateField '%s' to %s. " % (
  158. field.name, output_field.__class__.__name__ if has_explicit_output_field else 'DateTimeField'
  159. ))
  160. elif isinstance(field, TimeField) and (
  161. isinstance(output_field, DateTimeField) or
  162. copy.kind in ('year', 'quarter', 'month', 'week', 'day', 'date')):
  163. raise ValueError("Cannot truncate TimeField '%s' to %s. " % (
  164. field.name, output_field.__class__.__name__ if has_explicit_output_field else 'DateTimeField'
  165. ))
  166. return copy
  167. def convert_value(self, value, expression, connection):
  168. if isinstance(self.output_field, DateTimeField):
  169. if settings.USE_TZ:
  170. if value is None:
  171. raise ValueError(
  172. "Database returned an invalid datetime value. "
  173. "Are time zone definitions for your database installed?"
  174. )
  175. value = value.replace(tzinfo=None)
  176. value = timezone.make_aware(value, self.tzinfo)
  177. elif isinstance(value, datetime):
  178. if isinstance(self.output_field, DateField):
  179. value = value.date()
  180. elif isinstance(self.output_field, TimeField):
  181. value = value.time()
  182. return value
  183. class Trunc(TruncBase):
  184. def __init__(self, expression, kind, output_field=None, tzinfo=None, **extra):
  185. self.kind = kind
  186. super().__init__(expression, output_field=output_field, tzinfo=tzinfo, **extra)
  187. class TruncYear(TruncBase):
  188. kind = 'year'
  189. class TruncQuarter(TruncBase):
  190. kind = 'quarter'
  191. class TruncMonth(TruncBase):
  192. kind = 'month'
  193. class TruncWeek(TruncBase):
  194. """Truncate to midnight on the Monday of the week."""
  195. kind = 'week'
  196. class TruncDay(TruncBase):
  197. kind = 'day'
  198. class TruncDate(TruncBase):
  199. kind = 'date'
  200. lookup_name = 'date'
  201. output_field = DateField()
  202. def as_sql(self, compiler, connection):
  203. # Cast to date rather than truncate to date.
  204. lhs, lhs_params = compiler.compile(self.lhs)
  205. tzname = timezone.get_current_timezone_name() if settings.USE_TZ else None
  206. sql = connection.ops.datetime_cast_date_sql(lhs, tzname)
  207. return sql, lhs_params
  208. class TruncTime(TruncBase):
  209. kind = 'time'
  210. lookup_name = 'time'
  211. output_field = TimeField()
  212. def as_sql(self, compiler, connection):
  213. # Cast to date rather than truncate to date.
  214. lhs, lhs_params = compiler.compile(self.lhs)
  215. tzname = timezone.get_current_timezone_name() if settings.USE_TZ else None
  216. sql = connection.ops.datetime_cast_time_sql(lhs, tzname)
  217. return sql, lhs_params
  218. class TruncHour(TruncBase):
  219. kind = 'hour'
  220. class TruncMinute(TruncBase):
  221. kind = 'minute'
  222. class TruncSecond(TruncBase):
  223. kind = 'second'
  224. DateTimeField.register_lookup(TruncDate)
  225. DateTimeField.register_lookup(TruncTime)