Flask Config 設定クラス API

Config は、Flask アプリのすべての設定項目を管理するための辞書サブクラスです。

を通じてapp.configアクセスし、複数のソースから設定をロードできます。


Config クラスのメソッド

メソッド シグネチャ 説明
from_pyfile (filename, silent=False) Python ファイルから設定をロードします。silent=True のときファイルが存在しないエラーを無視します
from_object (obj) オブジェクト(モジュール、クラス、文字列インポートパス)から設定をロードします。大文字の属性のみロードします
from_envvar (variable_name, silent=False) 環境変数が指すファイルから設定をロードします。from_pyfile(os.environ[var]) と同等です
from_prefixed_env (prefix="FLASK", *, loads=json.loads) 環境変数からロードします。FLASK_ プレフィックスを持つ変数を読み取り、プレフィックスを除去して設定にします
from_file (filename, load, silent=False, text=True) 任意の形式のファイルからロードします。load は解析関数です(例: json.load、tomllib.load)
from_mapping (mapping=None, **kwargs) マッピングオブジェクトから設定をロードします。オプションの **kwargs キーと値のペア。大文字のキーのみロードします
get_namespace (namespace, lowercase=True, trim_namespace=True) 指定されたプレフィックスの設定サブセットを取得します。例: get_namespace("DB_") で全てのデータベース設定を取得します

ロード方法の比較

ロード方法 適用シナリオ 例
from_pyfile 設定ファイルが Python 形式 app.config.from_pyfile("config.py")
from_object クラスやモジュールで設定を整理し、環境を区別する app.config.from_object("myapp.config.ProductionConfig")
from_prefixed_env 12-Factor App、環境変数による設定 app.config.from_prefixed_env()
from_file JSON、TOML などの非 Python 形式 app.config.from_file("config.json", load=json.load)
get_namespace 設定サブセットを抽出してライブラリのコンストラクタに渡す db_config = app.config.get_namespace("DB_")

設定キーの命名規則

設定キー名すべて大文字でなければなりませんこれは Flask の規約です。from_object、from_mapping、from_prefixed_env などのメソッドでは小文字のキーは自動的に無視されます。


コード例

例

from flask import Flask

app = Flask(__name__)

# 方法1: Pythonファイルからロード
app.config.from_pyfile("config.py")

# 方法2: 環境変数からロード(FLASK_ プレフィックスを読み取る)
app.config.from_prefixed_env()

# 方法3: 直接設定
app.config["MY_SETTING"] = "value"

# 方法4: JSONからロード
import json
app.config.from_file("config.json", load=json.load)

# 方法5: ネームスペース設定を取得
# DB_HOST、DB_PORT、DB_NAME などの設定があるとします
db_config = app.config.get_namespace("DB_")
# db_config = {"host": "...", "port": ..., "name": "..."}
その他の拡張