將一些重要的資料存在環境變數(environment variable)中,是開發時常見的手段,不僅可以避免將重要的資料不小心 commit 進 codebase 之外,也可以利用環境變數儲存系統或程式設定,實務上也經常利用環境變數區隔開發環境(development)與生產環境(production),例如:

if os. getenv('MODE') == 'development':
    # do development-related things
    pass
else:
    # do production-related things
    pass

但隨著需要設定的環境變數增多,可能導致每次進行開發都有一堆環境變數要先塞好,如果你有遇到這種情況,不妨試試 python-dotenv 吧!

本文環境

  • macOS 10.15
  • Python 3.6.5
  • python-dotenv 0.11.0
$ pip install python-dotenv

.env 檔

python-dotenv 的運作十分簡單,預設 python-dotenv 會載入 .env 檔案,然後將設定寫入環境變數之中,接著就能夠透過 os.getenv(key, default=None) 取得環境變數中的值。

所以準備好 .env 檔案是相當重要的步驟。

.env 檔的格式大致如下,基本上等同 shell 中設定環境變數的用法:

export DBHOST=localhost
export DBPORT=5432

當然 python-dotenv 中可以省略 export ,讓 .env 檔更簡潔:

MODE=development
DBHOST=localhost
DBPORT=5432

此外, python-dotenv 也支援 POSIX parameter expansion 的用法,例如讓變數中可以再放入變數:

MODE=development
DBHOST=localhost
DBPORT=5432
DBCONN_STR=${DBHOST}:${DBPORT}

load_dotenv() 載入 .env

準備好 .env 之後,就能簡單透過呼叫 load_dotenv() 載入 .env 檔,例如載入前面範例的 .env 檔:

import os
from dotenv import load_dotenv


print('Before load_dotenv()', os.getenv('DBCONN_STR'))

load_dotenv()

print('After load_dotenv()', os.getenv('DBCONN_STR'))

上述的程式執行結果:

$ python dotenv_test.py
Before load_dotenv() None
After load_dotenv() localhost:5432

可以看到 DBCONN_STR 這個環境變數在 load_dotenv() 之後被設定好。

以上就是 python-dotenv 的用法,其他更進階的用法,例如整合至 Djando, IPython 甚至是整合 fabric 讀取遠端伺服器上的設定也都能夠做到,這些可以至 python-dotenv GitHub repo 中查閱!

Happy Coding!

References

https://github.com/theskumar/python-dotenv