コンテンツにスキップ

スクリプト開発 / 環境変数 `DFF.ENV`

スクリプトエディターの左サイドバーで設定した環境変数は、Script 内でその ID を使用して読み取ることができます。

API

メソッド	説明
`DFF.ENV(key, default=None)`	環境変数を読み取ります。存在しない場合は `default` を返します
`DFF.ENV.get(key, default=None)`	`DFF.ENV(...)` を直接呼び出すのと同等です
`DFF.ENV.keys()`	利用可能な環境変数の ID リストを返します
`DFF.ENV.ref(key, default=None)`	動的な値の取得をサポートする `DFF.API` パラメータの遅延参照を作成します

例
company_name = DFF.ENV('companyName')
page_size = DFF.ENV('pageSize', default=10)
all_keys = DFF.ENV.keys()

環境変数が見つからない場合は default を返します。デフォルト値が渡されていない場合は None を返します。password タイプの環境変数は自動的に復号されます。型変換が設定されている場合は、変換後の Python 値を返します。設定ミスにより型変換が例外をスローする可能性があるため、オプション変数を読み取る場合はデフォルト値またはフォールバックロジックを用意してください。

型フォールバック付きの例
def get_page_size():
    try:
        return int(DFF.ENV('pageSize', default=10) or 10)
    except Exception:
        return 10

動的参照

DFF.ENV.ref(...) は現在の環境変数の値ではなく、動的参照を返します。参照は Func メタデータが消費される際に解決され、DFF.API の delayed_cron_job、timeout、expires、queue パラメータに使用できます。

例
@DFF.API('動的タイムアウト', timeout=DFF.ENV.ref('FUNC_TIMEOUT', default=35))
def dynamic_timeout():
    return 'ok'

接続アドレス、Token、パスワード、環境差異の設定は、環境変数に優先的に保存してください。Script 内にハードコードせず、print(...) や Func レスポンスで機密値を出力しないでください。