Python環境変数の使用方法

さまざまな環境で開発する場合は、環境ごとに異なる構成値を指定することをお勧めします。アプリケーションを開発したコンピューターは、アプリケーションを展開したコンピューターと同じではありません。

そこで、環境変数が使用されます。

このガイドでは、環境変数とは何か、およびそれらをどのように使用できるかについて説明します。始めるのに役立つPython環境変数の例を見ていきます。

環境変数とは何ですか？

環境変数は、プログラムの外部で値が設定される変数です。

環境変数を使用すると、アプリケーションを構築している環境に応じて、変数に異なる値を設定できます。

環境変数が使用される理由

多くのアプリケーション、特にコラボレーションアプリケーションには、複数の異なる環境があります。 1つの環境はテストに使用され、別の環境は本番環境に使用され、さらに別の環境は開発に使用されます。これらの環境には、多くの場合、設定する必要のあるさまざまな構成値があります。

本番環境で使用するアプリケーションプログラミングインターフェイス（API）キーは、ローカルマシンで使用するものと同じではない可能性があります。アプリケーションを構築するときにローカルマシンでダミーデータを使用できますが、これは実稼働環境では適切ではありません。

環境変数の値は、プログラムを変更せずに変更できます。これは、新しい環境の代わりに構成値を使用しなくても、コードに変更を簡単にデプロイできることを意味します。

参加者の81％は、ブートキャンプに参加した後、自分たちの技術的な仕事の見通しについてより自信を持っていると述べました。今日のブートキャンプにマッチしましょう。

平均的なブートキャンプの卒業生は、ブートキャンプの開始から最初の仕事を見つけるまで、キャリアの移行に6か月も費やしませんでした。

環境変数は、セキュリティの目的でも使用されます。メインプログラム内にAPIキーと構成値を書き込むことは、プロジェクトの全員がそれらを見ることができるため、リスクを伴う可能性があります。環境変数内に値を指定すると、プログラムと変数を設定した開発者のみがその値にアクセスできます。

環境変数を設定する方法

まず、環境変数を作成しましょう。環境変数は、Pythonセッションが終了するまで持続します。これは、Pythonインタープリターを閉じると、Pythonスクリプトで変数がリセットされることを意味します。

AirtableAPIを使用するアプリを構築しています。コードをGitHubで共有するため、APIキーが公開されないようにします。 APIキーを公開せずにコードに追加するには、環境変数を使用します。

最初のステップは、osライブラリをインポートすることです。

import os


このライブラリには、Python環境変数を操作するためのコードが含まれています。次に、環境変数を設定します。

Os.environ[“AIRTABLE_KEY”] = “YOUR_API_KEY”


このコードは、AIRTABLE_KEYと呼ばれる変数を設定します。その値はYOUR_API_KEYです。 。環境変数の割り当ては、辞書の値を変更する方法と同じように機能します。

設定または変更する変数の名前、等号、変数に割り当てる値を指定する必要があります。

同じ構文を使用して、環境変数を変更できます。

os.environ[“AIRTABLE_KEY”] = “YOUR_API_KEY_2”


APIキーの値がYOUR_API_KEY_2に変更されました 。

環境変数を取得する方法

環境変数を設定しました。あなたの心の問題はおそらく：どのように値を取得できるかということです。ここでos.environ.get() を使用できます 方法。

AIRTABLE_KEYの値を取得しましょう 変数：

api_key = os.environ.get("AIRTABLE_KEY")
print(api_key)

AIRTABLE_KEYの値を取得したいと述べました 環境変数。この値をapi_keyという新しい変数に割り当てます 次に、それをコンソールに印刷します。

コードは次のようになります：YOUR_API_KEY_2 。

os.environの内容をコンソールに出力することにより、設定したすべての環境変数のリストを取得できます。

print(os.environ)


Python内にはいくつかのデフォルトの環境変数が設定されています。これは、Pythonプログラム内で設定されたすべての環境変数を出力すると、長いリストが返される可能性があることを意味します。

環境変数を削除する方法

Pythonプロジェクト内の環境変数を削除できます。これは、os.environ.pop()を使用して実行できます。 方法。 AIRTABLE_KEYを削除しましょう 環境変数：

os.environ.pop(“AIRTABLE_KEY”)


このコードは、AIRTABLE_KEYを削除します 環境変数。

複数の環境変数をクリアする場合は、これを行うのは実用的ではありません。プロジェクトの新しいインスタンスを開始する場合、またはセッション内のすべての環境変数をリセットする場合は、オーバーライドする値が数十ある可能性があります。

ここでclear() 方法が便利です。セッションですべての環境変数を削除しましょう。

os.environ.clear()
print(os.environ)

このコードは、すべての環境変数の値をクリアします。次に、セッション内のすべての環境変数のリストを出力します。

{}


Pythonは、プロジェクトで必要になる可能性のあるいくつかのデフォルトの環境変数を設定します。

clear() のみを使用する必要があります プログラムに環境変数がもう必要ないと確信している場合は、この方法を使用します。 pop()の使用 より具体的であるため、この方法が推奨されます。

Dotenvを使用して環境変数を設定する方法

dotenvライブラリは、環境変数を管理するための多くの便利な関数を提供します。

特に、dotenvを使用すると、ファイルから環境変数を読み取ることができます。これは、Pythonシェル内でそれらを宣言する必要がないことを意味します。

読み取る値が多い場合は、モジュールファイルから環境変数を読み取る方が便利です。また、値を変更する必要がある場合に、変数の管理が容易になります。

dotenvパッケージを使用するには、それをインストールする必要があります。これは、easy_installまたはpipのいずれかを使用して実行できます。

まず、環境変数を定義しましょう。これを行うには、.envというファイルを作成します。このファイルは、touchコマンドを使用してコマンドラインから作成できます。

touch .env


.envファイルを開き、次の内容を追加します。

AIRTABLE_KEY=YOUR_API_KEY_3


環境変数は、他の変数と同じように割り当てられます。等号の左側には、変数の名前があります。右側には、変数が格納する値があります。これらの2つの値は、等号で区切られます。

次に、変数をファイルにロードします。

from dotenv import load_dotenv

load_dotenv()

このコードはload_dotenv()をインポートします dotenvライブラリのメソッドを実行します。これにより、.envファイル内のすべての変数が環境に読み込まれます。

次に、osライブラリを使用して変数を取得してみましょう。

import os

api_key = os.environ.get("AIRTABLE_KEY")
print(api_key)

コードは次を返します：YOUR_API_KEY_3 。 APIキーは.envファイル内に設定されました。 load_dotenv() メソッドは環境変数をロードし、os.environメソッドを使用してそれらにアクセスできるようにしました。

結論

環境変数は、プログラムの外部で値を構成するために使用される事前定義された値です。これらは通常、さまざまな環境をセットアップするために使用されるため、その名前が付けられています。

環境変数は、秘密の値を設定するための安全な方法です。 APIキーは、アプリケーションを見るすべての人が読み取れるため、アプリケーションコードに直接追加することは望ましくありません。あなたとあなたのプログラムだけが値を見ることができるように、それを環境変数に設定することができます。

これで、プロのようにPythonコードで環境変数を操作する準備が整いました。