pythonで環境ファイルを読み込む

概要

APIkeyやデータベースの環境設定の際に環境変数を定義する環境ファイルをpythonコード内で読み込む。

バージョン

• windows10
• python: "3.8.3"

環境ファイルを読み込む手順

①必要なモジュールをインストールする

環境ファイルを読み込むために必要なモジュールであるpython-dotenvをpipを用いてインストールする。

$ pip install python-dotenv

②環境ファイルを作成する

作業ディレクトリ内でターミナルから

$ touch .env

を実行し.envファイルを作成する。そして、今回はAPIを叩くことを想定し、環境フォルダ内にAPI_KEYを定義するために以下を書き込む。

.env

API_KEY='0000000000'

※API_KEYの値はこの記事のためだけに定めた架空の値です。

③.gitignoreファイルを作成する

gitで管理する場合は機密情報を拡散しないようにするために、.gitignoreファイルを作成し

.gitignore

# .envファイルをgitの管理対象から外す
.env

を書き込む。これにより、.envファイルがgitの管理対象から外れる。

④環境ファイルを読み込む

環境ファイルを読み込むためのpythonファイルが同一のディレクトリに存在する場合、pythonファイルに以下の記述を加えることで、環境ファイルに記入した環境変数を読み込むことができる。仮に同一ディレクトリ内に.envファイルとpythonファイルが存在しない場合はload_dotenv()の()内に.envファイルまでのパスを書き込む必要がある。

# 必要モジュールのインポート
import os
from dotenv import load_dotenv

# .envファイルの内容を読み込見込む
load_dotenv()

# os.environを用いて環境変数を表示させます
print(os.environ['API_KEY'])

そして、pythonファイル実行後、.envで設定したAPI_KEYの値がターミナルで以下のように表示された場合、正常に動作していることが確認できる。

0000000000

正常に動作していることが確認できたら、pythonファイル内の

print(os.environ['API_KEY'])

を削除するかコメントアウトするかして、API_KEYの値が必要な個所に

os.environ['API_KEY']

を追加する。
以上で、pythonファイルにて環境ファイルを読み込むことが完了する。