近來查閱 Python 關於 datetime 的標準日期格式(datetime.isoformat)的時候,發現一個奇妙的行為,該行為可能造成日期格式不一致。

本文環境

  • Python 3.7

isoformat

Python 的 isoformat() 預設有 2 個參數,其中 1 個是 timespec , timespec 預設是 auto ,當設定為 auto 時, isoformat 會根據 datetime.utcoffset() 以及 microsecond 的不一樣,而自動產生 4 種不同格式的字串:

  • YYYY-MM-DDTHH:MM:SS.ffffff
  • YYYY-MM-DDTHH:MM:SS
  • YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]
  • YYYY-MM-DDTHH:MM:SS+HH:MM[:SS[.ffffff]]

例如當 microseconds 為 0 與不為 0 的時候,就會產生 2 種格式:

>>> from datetime import datetime, timezone
>>> datetime(2019, 5, 18, 20, 17, 8, 0).isoformat()
'2019-05-18T20:17:08'
>>> datetime(2019, 5, 18, 20, 17, 8, 1).isoformat()
'2019-05-18T20:17:08.000001'

以及當 datetime 有時區資訊時,也會有 2 種不同的格式:

>>> from datetime import datetime, timezone
>>> datetime.now().isoformat()
'2019-05-18T20:17:08.513482'
>>> datetime.now(timezone.utc).isoformat()
'2019-05-18T20:17:08.827410+00:00'

上述 2 種情況就會產生 4 種排列組合。

雖然大部分的使用情況並不會讓人感覺到使用上的問題,但如果是對於有嚴格要求日期格式必須一致的系統,預設的 timespec='auto' 就會有機會產生非預期的格式,進而導致系統發生問題。

如果要解決這問題的話,就必須檢查 datetime object 是否有時區資訊,以及視時間的精準度需求將 timespec 改為以下的選項之一:

  • hours
  • minutes
  • seconds
  • milliseconds
  • microseconds

例如,以下是確保所有的字串都符合 YYYY-MM-DDTHH:MM:SS 格式的範例:

def get_isoformat(dt: datetime):
    if dt.utcoffset() is not None:
        raise ValueError('system does not support timezone')
    return dt.isoformat(timespec='seconds')

以上。

Happy Coding!

References

https://docs.python.org/3/library/datetime.html#datetime.datetime.isoformat