python中的時區問題

Posted on by

問題背景

使用 Python 進行瞭許久的開發，一直沒有踩到時區的坑，最近新的業務中引入瞭比較多的服務，而且使用 grpc 進行數據通訊，不幸踩到瞭時區的坑，果然偷的懶最終還是會有報應的，於是梳理下對應的時區問題，同時發現系統中之前的數據庫 Mongo 中的時區問題，一起整理如下。

基礎概念

幾個時間概念

首先是幾個常見的時間概念

  • GMT 時間：格林威治時間，基準時間
  • UTC 時間：Coordinated Universal Time，全球協調時間，更精準的基準時間，與 GMT 基本等同
  • CST 中國基準時間：為 UTC 時間 + 8 小時，即 UTC 時間的 0 點對應於中國基準時間的 8 點，即為一般稱為東八區的時間

ISO 8601

一種標準化的時間表示方法，表示格式為 ：YYYY-MM-DDThh:mm:ss ± timezone，可以表示不同時區的時間，時區部分用Z 表示為 UTC 標準時區。兩個例子：

  • 1997-07-16T08:20:30Z 表示的是 UTC 時間的 1997 年 7 月 16 號 8:20:30
  • 1997-07-16T19:20:30+08:00 表示的是東八區時間的 1997 年 7 月 16 號 19:20:30

時間戳

1970年1月1日 00:00:00 UTC+00:00時區的時刻稱為epoch time，記為0，當前的時間戳即為從 epoch time 到現在的秒數，一般叫做 timestamp，因此一個時間戳一定對應於一個特定的 UTC 時間，同時也對應於其他時區的一個確定的時間。因此時間戳可以認為是一個相對安全的時間表示方法。

datetime 實踐

datetime 是 python 中最基礎的一個時間管理包，下面分別利用 datetime 去實踐下對應的時區概念

datetime 類型

datetime 分成兩種類型：

  • naive，本地類型的時間，當 datetime 中沒有指定時區信息時就是這種類型，此類型的時區是根據運行環境確定對應的時區。因此這種類型的時間會因為運行環境的不同而得到不同時間戳
  • aware，帶有時區類型的時間，這種類型的時間對象由於時間和時區都是確定的，因此對應於確定的時間戳

舉例如下:

from datetime import datetime, timezone

now = datetime.now()
now.tzinfo   # None 
utc_now = datetime.now(timezone.utc)
utc_now.tzinfo # UTC

可以看到上面的例子中，now 沒有指定時區，為 naive 類型的時間，其時區與運行環境相關。而 utc_now 指定瞭 UTC 時區，為 aware 類型的時間。

獲取當前時間

  • datetime.now() 可用於獲取當前時間，支持設置對應的時區，如果不設置時區默認獲取的是本地的時間，根據是否指定時區可能穿件出 naive 類型的時間或者 aware 類型的時間，但是對應的時間戳都是符合預期的。
  • datetime.utcnow() 謹慎使用 獲取是當前 UTC 對應的時間，但是生成的 datetime 對象是沒有指定時區的，因此使用的是本地時區，創建的是 naive 類型的時間。因此如果運行環境為東八區，得到的時間是 UTC 對應的時間，但是時區是東八區，最終得到的時間會比預期早 8 個小時，轉化得到時間戳也是不符合預期的。

舉例如下：

from datetime import datetime
now = datetime.now()
now.timestamp() # 1610035129.323702 unow = datetime.utcnow()
unow.timestamp() # 1610006329.323797

最終在 2021-01-07 23:58:49 在東八區環境下運行上面的代碼，now.timestamp() 得到時間戳轉化為對應的時間為東八區的 2021-01-07 23:58:49，但是 unow.timestamp() 得到的時間戳對應的時間為東八區的 2021-01-07 15:58:49，對應於 UTC 時間 2021-01-07 07:58:49，和 UTC 的當前時間完全對不上。

時間戳操作

  • datetime.timestamp() 生成當前時間對應的時間戳
  • datetime.fromtimestamp() 根據時間戳生成運行環境時區對應的時間
  • datetime.utcfromtimestamp() 謹慎使用 根據時間戳生成對應的 UTC 時間，由於生成的 datetime 是沒有指定時區的，因此獲取時間戳看起來得到的是 8 個小時之前時間的時間戳

對於上面的例子，我們使用前面得到的當前時間戳 1610035129 進行測試如下：

from datetime import datetime

timestamp = 1610035129
d1 = datetime.fromtimestamp(timestamp) # 2021-01-07 23:58:49 d2 = datetime.utcfromtimestamp(timestamp) # 2021-01-07 15:58:49

最終得到 d1 是本地時區正確的時間，但是 d2 是 UTC 的是啊金，但是沒有指定的時區，因此看起來就是就是本地 8 個小時前的時間瞭

時區設置

默認構建的 datetime 是沒有時區信息的，可以通過 datetime.replace() 為時間設置上時區，但是這樣必須保證對應的時間與時區信息匹配，否則就會導致錯誤的時區的時間，一個簡單例子就是：

from datetime import datetime, timedelta, timezone
tz_utc_8 = timezone(timedelta(hours=8)) # 創建時區UTC+8:00，即東八區對應的時區 now = datetime.now() # 默認構建的時間無時區 dt = now.replace(tzinfo=tz_utc_8) # 強制設置為UTC+8:00

設置上對應的時區後，對應的日期與時間是不變的，但是由於設置瞭全新的時區，如果與之前的時區不同，那麼對應的時間戳就會改變，使用此方法時要謹慎

時區轉換

可以將一個帶有時區信息的時間轉換為另一個時區的時間，通過 datetime.astimezone() 可以實現，一個簡單的例子是：

from datetime import datetime, timedelta, timezone
utc_dt = datetime.utcnow().replace(tzinfo=timezone.utc) # 構建瞭 UTC 的當前時間 bj_dt = utc_dt.astimezone(timezone(timedelta(hours=8))) # 將時區轉化為東八區的時間

通過 astimezone() 進行轉換後，雖然時間變化瞭，但是對應的是同樣的基準時間，因此對應的時間戳是不變的，

Grpc 實踐

在 Grpc 的使用中，設計到時間戳對象 Timestamp 與時間的轉換，Timestamp 對象支持通過 python 中的時間戳構建，即當前時間的對應的時間戳秒數，也支持通過 datetime 構建。對應的接口如下：

  • Timestamp.FromSeconds() 此方法是根據時間戳生成 Grpc 的時間戳對象，沒有特殊的地方
  • Timestamp.FromDatetime() 謹慎使用 此方法根據 datetime 時間生成時間戳對象，隱含期望 datetime 是 UTC 時間，如果錯誤傳入東八區時間，會導致得到一個 8 個小時後的絕對時間

我們在實踐中有混用這兩個方法，最終發現調用 FromDatetime() 時獲得的時間戳是完全不符合預期的。一個簡單例子如下：

from datetime import datetime
from google.protobuf.timestamp_pb2 import Timestamp

now = datetime.now()
now_timestamp = int(now.timestamp()) # 1610245593 t1 = Timestamp()
t1.FromSeconds(now_timestamp) # 1610245593 
t2 = Timestamp()
t2.FromDatetime(now) # 1610274393

可以看到通過 FromDatetime() 得到訂單時間戳與預期是不相符的，隻有傳入的 datetime 是 UTC 的時間時兩者才是一致的

而轉換為 datetime 對象的接口為：

  • Timestamp.ToSeconds() 此方法是根據時間戳對象得到對應的整數時間戳，沒有問題
  • Timestamp.ToDatetime() 謹慎使用 此方法是根據 grpc 的時間戳對象生成 datetime，隱含輸出的 datetime 是 UTC 時間 ，而生成的 datetime 是沒有時區信息的，默認會按照本地時區進行處理，不做處理的情況下得到的就是 8 個小時前，對應的時間戳也是錯誤的

與上面的問題類似，通過 ToDatetime() 得到的時間是 UTC 時間，但是由於得到的 datetime 沒有指定時區，隻有在 UTC 的運行環境下得到的時間才是符合預期的。

Pymongo 實踐

之前的在使用 Pymongo 進行數據存儲時，直接使用的是 Pymongo 的默認設置，運行環境設置為東八區，在使用中直接將沒有指定時區的 datetime 存入數據庫中，之後再取出進行使用工作起來看起來一切正常。但是本次在梳理時區時查看數據庫中存儲的數據時，就發現瞭一個明顯的問題，數據庫中存儲的看起來日期與時間是對的，但是是 UTC 的時間，也就是說實際存儲的時間比預期晚 8 小時瞭，但是為什麼又能正常工作呢？確認後結果如下：

  • Pymongo 在沒有指定時區的情況下， 默認不認為此時間為本地時間，事實上認為此時間為 UTC 時間，最終會利用此時間計算得到對應的時間戳並進行存儲，所以最終存儲的時間戳會晚 8 小時；
  • 而在默認設置下，從 Pymongo 中返回的時間也沒有時區，而時間依舊是 UTC 時間，因此會導致計算得到時間又早瞭 8 小時，因此時間看起來是正常的。

如何才能保證存入正確時間，返回的也是符合預期的呢？

  • 存入的時間可以設置上對應的時區，即避免存入 naive 類型的時間，應該存入 aware 類型的時間，避免輸入是認為是 UTC 的時間
  • 在 Pymongo 中設置輸出帶時區的時間，避免默認輸出時間的問題，Pymongo 可以通過 tz_aware 指定輸出帶時區的時間，通過 tzinfo 指定輸出時間的時區，這個設置在構建 Pymongo 時傳入即可。對應如下：
from datetime import timedelta, timezone
 
db = MongoClient(settings.MONGODB_DSN, tz_aware=True, tzifo=timezone(timedelta(hours=8))).get_default_database()

總結

根據上面的的實踐，分別對三個部分進行使用如下：

  1. datetime 的使用中，如果運行環境設置為非 UTC 時區，建議禁用 utc 相關的方法，比如 utcnow ，utcfromtimestamp() ，同時盡量避免使用 naive 使用，保證時間與運行環境解耦；
  2. grpc 的使用中盡量避免調用 FromDatetime() 和 ToDatetime() 這種包含隱含信息的方法，盡量通過時間戳與 grpc 的 TimeStamp 對象進行交互；
  3. Pymongo 中盡量傳入的帶有時區的時間，輸出也配置上時區輸出，避免隱含的問題；

一條總原則就是：與第三方的服務交互或存儲時，盡量隻使用時間戳這種絕對機制，這樣才能從根本上杜絕問題。

以上就是python中的時區問題的詳細內容，更多關於python 時區的資料請關註WalkonNet其它相關文章！

推薦閱讀：