「.env」ファイルでの環境変数設定

Pythonにおいて、.env ファイルを読み込んで環境変数を設定する方法をまとめておく。
.env ファイルは、python-dotenvモジュールを使用することで読み込むことができる。
.env でパラメータを指定することで、ハードコーディングを回避し、再利用性を高く保つことができるメリットがある。

使い方

1. python-dotenvモジュールのインストール

次のように、pipコマンドを使用してpython-dotenvモジュールをインストールすることができる。

$ pip install python-dotenv

2.「.env」ファイルを作成する

例として、以下の.envファイルを作成した。

.env

DATABASE_NAME = sample.db

3.「.env」ファイルを読み込む

そして、.envファイルを読み込むには、load_dotenv()を使用する。これを実行することで、.envファイルに記述された情報が環境変数に設定される。また、環境変数の値を取得するにはgetenv(<環境変数名>)を使用する。もし、該当する環境変数が存在しない場合は、Noneが返される。

# 使用するモジュールをインポート
from dotenv import load_dotenv
import os

# .envから環境変数を読み込む
load_dotenv()

# 環境変数を参照
DATABASE_NAME = os.getenv('DATABASE_NAME')
print(DATABASE_NAME)    # 「sample.db」が表示される