[Python].envファイルで環境変数を設定する[python-dotenv]

前書き

自分用のちょっとしたツールをPythonで作ることが増えてきたため、Tipsを記していきます。

Python3 環境構築手順は↓

今回は環境変数を.envファイルに切り出し、実行ファイル(main.py)で変数として呼び出すところまでを試します。

環境変数としてコード管理から切り出すべきもの

• 環境（local/dev/test/production）によってvalueが異なる項目
• その他外部への接続情報等、公開するべきではない項目

設定方法

今回はpython-dotenvを使用します。まずはインストールを行いましょう。

python-dotenv(GitHub)

$ pip install python-dotenv

.envファイルに環境変数を定義します。
簡単なサンプルのため、以下のファイルは全てProjectのrootディレクトリに置いています。

.env

CLIENT_ID=hogehoge
CLIENT_SECRET=fugafuga

.envファイルに設定した項目をconfig.pyで読み出します。

config.py

from dotenv import load_dotenv
load_dotenv()

import os

CLIENT_ID = os.getenv('CLIENT_ID') //hogehoge
CLIENT_SECRET = os.getenv('CLIENT_SECRET') //fugafuga

config.pyで読み出した項目を実行ファイル内で呼び出します。

main.py

import config

client_key = config.CLIENT_ID //hogehoge
client_secret = config.CLIENT_SECRET //fugafuga

.gitignoreに.envを追加

.gitignoreへの追記を忘れないように！！

.gitignore

+ .env