引言

相信使用Django的各位開發(fā)者在存儲(chǔ)時(shí)間的時(shí)候經(jīng)常會(huì)遇到這樣子的錯(cuò)誤:

RuntimeWarning: DateTimeField received a naive datetime while time zone support is active.

這個(gè)錯(cuò)誤到底是什么意思呢？什么是naive datetime object？什么又是aware datetime object？

在Django配置中如果將settings.TIME_ZONE設(shè)置為中國時(shí)區(qū)（Asia/Shanghai），為什么以下時(shí)間函數(shù)會(huì)得到時(shí)間相差較大的結(jié)果？

# settings.py
TIME_ZONE = 'Asia/Shanghai'

# python manage.py shell
>>> from datetime import datetime
>>> datetime.now()
datetime.datetime(2016, 12, 7, 12, 41, 22, 729326)
>>> from django.utils import timezone
>>> timezone.now()
datetime.datetime(2016, 12, 7, 4, 41, 36, 685921, tzinfo=<UTC>)

接下來筆者將詳細(xì)揭秘在Django中關(guān)于時(shí)區(qū)的種種內(nèi)幕，如有不對，敬請指教。

準(zhǔn)備

UTC與DST

UTC可以視為一個(gè)世界統(tǒng)一的時(shí)間，以原子時(shí)為基礎(chǔ)，其他時(shí)區(qū)的時(shí)間都是在這個(gè)基礎(chǔ)上增加或減少的，比如中國的時(shí)區(qū)就為UTC＋8。

DST（夏時(shí)制）則是為了充分利用夏天日照長的特點(diǎn)，充分利用光照節(jié)約能源而人為調(diào)整時(shí)間的一種機(jī)制。通過在夏天將時(shí)間向前加一小時(shí)，使人們早睡早起節(jié)約能源。雖然很多西方國家都采用了DST，但是中國不采用DST。（資料來源：DST 百度百科）

naive datetime object vs aware datetime object

當(dāng)使用datetime.now()得到一個(gè)datetime對象的時(shí)候，此時(shí)該datetime對象沒有任何關(guān)于時(shí)區(qū)的信息，即datetime對象的tzinfo屬性為None(tzinfo屬性被用于存儲(chǔ)datetime object關(guān)于時(shí)區(qū)的信息)，該datetime對象就被稱為naive datetime object。

>>> import datetime
>>> naive = datetime.datetime.now()
>>> naive.tzinfo
>>>

既然naive datetime object沒有關(guān)于時(shí)區(qū)的信息存儲(chǔ)，相對的aware datetime object就是指存儲(chǔ)了時(shí)區(qū)信息的datetime object。
在使用now函數(shù)的時(shí)候，可以指定時(shí)區(qū)，但該時(shí)區(qū)參數(shù)必須是datetime.tzinfo的子類。(tzinfo是一個(gè)抽象類，必須有一個(gè)具體的子類才能使用，筆者在這里使用了pytz.utc，在Django中的timezone源碼中也實(shí)現(xiàn)了一個(gè)UTC類以防沒有pytz庫的時(shí)候timezone功能能正常使用)

>>> import datetime
>>> import pytz
>>> aware = datetime.datetime.now(pytz.utc)
>>> aware
datetime.datetime(2016, 12, 7, 8, 32, 7, 864077, tzinfo=<UTC>)
>>> aware.tzinfo
<UTC>

 在Django中提供了幾個(gè)簡單的函數(shù)如is_aware, is_naive, make_aware和make_naive用于辨別和轉(zhuǎn)換naive datetime object和aware datetime object。

datetime.now簡析

在調(diào)用datetime.now()的時(shí)候時(shí)間是如何返回的呢？在官方文檔里只是簡單地說明了now函數(shù)返回當(dāng)前的具體時(shí)間，以及可以�指定時(shí)區(qū)參數(shù)，并沒有具體的說明now函數(shù)的實(shí)現(xiàn)。

classmethod datetime.now(tz=None)
Return the current local date and time. If optional argument tz is None or not specified, this is like today(), but, if possible, supplies more precision than can be gotten from going through a time.time() timestamp (for example, this may be possible on platforms supplying the C gettimeofday() function).

If tz is not None, it must be an instance of a tzinfo subclass, and the current date and time are converted to tz's time zone. In this case the result is equivalent to tz.fromutc(datetime.utcnow().replace(tzinfo=tz)). See also today(), utcnow().

OK，那么接下來直接從datetime.now()的源碼入手吧。

@classmethod
 def now(cls, tz=None):
  "Construct a datetime from time.time() and optional time zone info."
  t = _time.time()
  return cls.fromtimestamp(t, tz)

大家可以看到datetime.now函數(shù)通過time.time()返回了一個(gè)時(shí)間戳，然后調(diào)用了datetime.fromtimestamp()將一個(gè)時(shí)間戳轉(zhuǎn)化成一個(gè)datetime對象。

那么，不同時(shí)區(qū)的時(shí)間戳?xí)粫?huì)不一樣呢？不，時(shí)間戳不會(huì)隨著時(shí)區(qū)的改變而改變，時(shí)間戳是唯一的，被定義為格林威治時(shí)間1970年01月01日00時(shí)00分00秒(北京時(shí)間1970年01月01日08時(shí)00分00秒)起至現(xiàn)在的總秒數(shù)。

datetime.fromtimestamp

既然時(shí)間戳不會(huì)隨時(shí)區(qū)改變，那么在fromtimestamp中應(yīng)該對時(shí)間戳的轉(zhuǎn)換做了時(shí)區(qū)的處理。

直接上源碼：

 @classmethod
 def _fromtimestamp(cls, t, utc, tz):
  """Construct a datetime from a POSIX timestamp (like time.time()).

  A timezone info object may be passed in as well.
  """
  frac, t = _math.modf(t)
  us = round(frac * 1e6)
  if us >= 1000000:
   t += 1
   us -= 1000000
  elif us < 0:
   t -= 1
   us += 1000000

  converter = _time.gmtime if utc else _time.localtime
  y, m, d, hh, mm, ss, weekday, jday, dst = converter(t)
  ss = min(ss, 59) # clamp out leap seconds if the platform has them
  return cls(y, m, d, hh, mm, ss, us, tz)

 @classmethod
 def fromtimestamp(cls, t, tz=None):
  """Construct a datetime from a POSIX timestamp (like time.time()).

  A timezone info object may be passed in as well.
  """
  _check_tzinfo_arg(tz)

  result = cls._fromtimestamp(t, tz is not None, tz)
  if tz is not None:
   result = tz.fromutc(result)
  return result

當(dāng)直接調(diào)用datetime.now()的時(shí)候，并沒有傳進(jìn)tz的參數(shù)，因此_fromtimestamp中的utc參數(shù)為False，所以converter被賦值為time.localtime函數(shù)。

time.localtime

localtime函數(shù)的使用只需要知道它返回一個(gè)九元組表示當(dāng)前的時(shí)區(qū)的具體時(shí)間即可：

def localtime(seconds=None): # real signature unknown; restored from __doc__
 """
 localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,
        tm_sec,tm_wday,tm_yday,tm_isdst)

 Convert seconds since the Epoch to a time tuple expressing local time.
 When 'seconds' is not passed in, convert the current time instead.
 """
 pass

筆者覺得更需要注意的是什么因素影響了time.localtime返回的時(shí)區(qū)時(shí)間，那么，就需要談及time.tzset函數(shù)了。

在Python官方文檔中關(guān)于time.tzset函數(shù)解釋如下：

time.tzset()

Resets the time conversion rules used by the library routines. The environment variable TZ specifies how this is done.

Availability: Unix.

Note Although in many cases, changing the TZ environment variable may affect the output of functions like localtime() without calling tzset(), this behavior should not be relied on.
The TZ environment variable should contain no whitespace.

可以看到，一個(gè)名為TZ的環(huán)境變量的設(shè)置會(huì)影響localtime的時(shí)區(qū)時(shí)間的返回。（有興趣的同學(xué)可以去在Unix下執(zhí)行man tzset，就知道TZ變量是如何影響localtime了）

最后，筆者給出一些測試的例子，由于獲取的時(shí)間戳不隨時(shí)間改變，因此直接調(diào)用fromtimestamp即可：

>>> from datetime import datetime
>>> from time import time, tzset
>>> china = datetime.fromtimestamp(time())
>>> import os
>>> os.environ['TZ'] = 'UTC'
>>> tzset()
>>> utc = datetime.fromtimestamp(time())
>>> china
datetime.datetime(2016, 12, 7, 16, 3, 34, 453664)
>>> utc
datetime.datetime(2016, 12, 7, 8, 4, 30, 108349)

以及直接調(diào)用localtime的例子：

>>> from time import time, localtime, tzset
>>> import os
>>> china = localtime()
>>> china
time.struct_time(tm_year=2016, tm_mon=12, tm_mday=7, tm_hour=16, tm_min=7, tm_sec=5, tm_wday=2, tm_yday=342, tm_isdst=0)
>>> os.environ['TZ'] = 'UTC'
>>> tzset()
>>> utc = localtime()
>>> utc
time.struct_time(tm_year=2016, tm_mon=12, tm_mday=7, tm_hour=8, tm_min=7, tm_sec=34, tm_wday=2, tm_yday=342, tm_isdst=0)
 

（提前劇透：TZ這一個(gè)環(huán)境變量在Django的時(shí)區(qū)中發(fā)揮了重大的作用）

Django TimeZone

timezone.now() vs datetime.now()

筆者在前面花費(fèi)了大量的篇幅來講datetime.now函數(shù)的原理，并且提及了TZ這一個(gè)環(huán)境變量，這是因?yàn)樵贒jango導(dǎo)入settings的時(shí)候也設(shè)置了TZ環(huán)境變量。

當(dāng)執(zhí)行以下語句的時(shí)候：

from django.conf import settings

毫無疑問，首先會(huì)訪問django.conf.__init__.py文件。

在這里settings是一個(gè)lazy object，但是這不是本章的重點(diǎn)，只需要知道當(dāng)訪問settings的時(shí)候，真正實(shí)例化的是以下這一個(gè)Settings類。

class Settings(BaseSettings):
 def __init__(self, settings_module):
  # update this dict from global settings (but only for ALL_CAPS settings)
  for setting in dir(global_settings):
   if setting.isupper():
    setattr(self, setting, getattr(global_settings, setting))

  # store the settings module in case someone later cares
  self.SETTINGS_MODULE = settings_module

  mod = importlib.import_module(self.SETTINGS_MODULE)

  tuple_settings = (
   "INSTALLED_APPS",
   "TEMPLATE_DIRS",
   "LOCALE_PATHS",
  )
  self._explicit_settings = set()
  for setting in dir(mod):
   if setting.isupper():
    setting_value = getattr(mod, setting)

    if (setting in tuple_settings and
      not isinstance(setting_value, (list, tuple))):
     raise ImproperlyConfigured("The %s setting must be a list or a tuple. " % setting)
    setattr(self, setting, setting_value)
    self._explicit_settings.add(setting)

  if not self.SECRET_KEY:
   raise ImproperlyConfigured("The SECRET_KEY setting must not be empty.")

  if hasattr(time, 'tzset') and self.TIME_ZONE:
   # When we can, attempt to validate the timezone. If we can't find
   # this file, no check happens and it's harmless.
   zoneinfo_root = '/usr/share/zoneinfo'
   if (os.path.exists(zoneinfo_root) and not
     os.path.exists(os.path.join(zoneinfo_root, *(self.TIME_ZONE.split('/'))))):
    raise ValueError("Incorrect timezone setting: %s" % self.TIME_ZONE)
   # Move the time zone info into os.environ. See ticket #2315 for why
   # we don't do this unconditionally (breaks Windows).
   os.environ['TZ'] = self.TIME_ZONE
   time.tzset()

 def is_overridden(self, setting):
  return setting in self._explicit_settings

 def __repr__(self):
  return '<%(cls)s "%(settings_module)s">' % {
   'cls': self.__class__.__name__,
   'settings_module': self.SETTINGS_MODULE,
  }

在該類的初始化函數(shù)的最后，可以看到當(dāng)USE_TZ=True的時(shí)候（即開啟Django的時(shí)區(qū)功能），設(shè)置了TZ變量為settings.TIME_ZONE。

OK，知道了TZ變量被設(shè)置為TIME_ZONE之后，就能解釋一些很奇怪的事情了。

比如，新建一個(gè)Django項(xiàng)目，保留默認(rèn)的時(shí)區(qū)設(shè)置，并啟動(dòng)django shell：

# settings.py
TIME_ZONE = 'UTC'
USE_I18N = True
USE_L10N = True
USE_TZ = True

# python3 manage.py shell
>>> import datetime
>>> datetime.datetime.now()
datetime.datetime(2016, 12, 7, 9, 19, 34, 741124)
>>> datetime.datetime.utcnow()
datetime.datetime(2016, 12, 7, 9, 19, 45, 753843)

默認(rèn)的Python Shell通過datetime.now返回的應(yīng)該是當(dāng)?shù)貢r(shí)間，在這里即中國時(shí)區(qū)，但是當(dāng)settings.TIME_ZONE設(shè)置為UTC的時(shí)候，通過datetime.now返回的就是UTC時(shí)間。

可以試試將TIME_ZONE設(shè)置成中國時(shí)區(qū)：

# settings.py
TIME_ZONE = 'Asia/Shanghai'

# python3 manage.py shell
>>> import datetime
>>> datetime.datetime.now()
datetime.datetime(2016, 12, 7, 17, 22, 21, 172761)
>>> datetime.datetime.utcnow()
datetime.datetime(2016, 12, 7, 9, 22, 26, 373080)

此時(shí)datetime.now返回的就是中國時(shí)區(qū)了。

當(dāng)使用timezone.now函數(shù)的時(shí)候，情況則不一樣，在支持時(shí)區(qū)功能的時(shí)候，該函數(shù)返回的是一個(gè)帶有UTC時(shí)區(qū)信息的aware datetime obeject，即它不受TIME_ZONE變量的影響。

直接看它的源碼實(shí)現(xiàn)：

def now():
 """
 Returns an aware or naive datetime.datetime, depending on settings.USE_TZ.
 """
 if settings.USE_TZ:
  # timeit shows that datetime.now(tz=utc) is 24% slower
  return datetime.utcnow().replace(tzinfo=utc)
 else:
  return datetime.now()
 

不支持時(shí)區(qū)功能，就返回一個(gè)受TIME_ZONE影響的naive datetime object。

實(shí)踐場景

假設(shè)現(xiàn)在有這樣一個(gè)場景，前端通過固定格式提交一個(gè)時(shí)間字符串供后端的form驗(yàn)證，后端解析得到datetime object之后再通過django orm存儲(chǔ)到DatetimeField里面。

Form.DateTimeField

在django關(guān)于timezone的官方文檔中，已經(jīng)說明了經(jīng)過form.DatetimeField返回的在cleaned_data中的時(shí)間都是當(dāng)前時(shí)區(qū)的aware datetime object。

Time zone aware input in forms¶

When you enable time zone support, Django interprets datetimes entered in forms in the current time zone and returns aware datetime objects in cleaned_data.

If the current time zone raises an exception for datetimes that don't exist or are ambiguous because they fall in a DST transition (the timezones provided by pytz do this), such datetimes will be reported as invalid values.

Models.DatetimeField

在存儲(chǔ)時(shí)間到MySQL的時(shí)候，首先需要知道在Models里面的DatetimeField通過ORM映射到MySQL的時(shí)候是什么類型。
筆者首先建立了一個(gè)Model作為測試：

# models.py
class Time(models.Model):

 now = models.DateTimeField()

# MySQL Tables Schema
+-------+-------------+------+-----+---------+----------------+
| Field | Type  | Null | Key | Default | Extra   |
+-------+-------------+------+-----+---------+----------------+
| id | int(11)  | NO | PRI | NULL | auto_increment |
| now | datetime(6) | NO |  | NULL |    |
+-------+-------------+------+-----+---------+----------------+

可以看到，在MySQL中是通過datetime類型存儲(chǔ)Django ORM中的DateTimeField類型，其中datetime類型是不受MySQL的時(shí)區(qū)設(shè)置影響，與timestamp類型不同。

關(guān)于datetime和timestamp類型可以參考這篇文章。

因此，如果筆者關(guān)閉了時(shí)區(qū)功能，卻向MySQL中存儲(chǔ)了一個(gè)aware datetime object，就會(huì)得到以下報(bào)錯(cuò)：

"ValueError: MySQL backend does not support timezone-aware datetimes. "

關(guān)于對時(shí)區(qū)在業(yè)務(wù)開發(fā)中的一些看法

后端應(yīng)該在數(shù)據(jù)庫統(tǒng)一存儲(chǔ)UTC時(shí)間并返回UTC時(shí)間給前端，前端在發(fā)送時(shí)間和接收時(shí)間的時(shí)候要把時(shí)間分別從當(dāng)前時(shí)區(qū)轉(zhuǎn)換成UTC發(fā)送給后端，以及接收后端的UTC時(shí)間轉(zhuǎn)換成當(dāng)?shù)貢r(shí)區(qū)。

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論