Skip to content

Environment

Environment variable management and .env file loading.

3 modules

ModuleDescription
環境変数を取得環境変数の値を取得
.envファイルを読み込む.envファイルから環境変数を読み込む
環境変数を設定現在のプロセスで環境変数を設定

Modules

環境変数を取得

env.get

環境変数の値を取得

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-環境変数の名前
defaultstringNo-変数が設定されていない場合のデフォルト値

Output:

FieldTypeDescription
namestring変数名
valuestring変数の値(未設定の場合はデフォルト)
existsboolean環境に変数が存在するかどうか

Example: Get HOME variable

yaml
name: HOME

Example: Get variable with default

yaml
name: MY_APP_PORT
default: 8080

.envファイルを読み込む

env.load_dotenv

.envファイルから環境変数を読み込む

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes.env.envファイルへのパス
overridebooleanNoFalse既存の環境変数を上書きするかどうか

Output:

FieldTypeDescription
loaded_countnumber読み込まれた変数の数
variablesarray読み込まれた変数名のリスト

Example: Load .env file

yaml
path: .env
override: false

環境変数を設定

env.set

現在のプロセスで環境変数を設定

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-設定する環境変数の名前
valuestringYes-環境変数に割り当てる値

Output:

FieldTypeDescription
namestring変数名
valuestring設定された新しい値
previous_valuestring以前の値(以前に設定されていない場合はnull)

Example: Set an environment variable

yaml
name: MY_APP_PORT
value: 3000

Released under the Apache 2.0 License.