Flask 設定管理

どんなアプリケーションにも設定が必要です——データベースアドレス、シークレットキー、デバッグモードの切り替えなど。

Flaskは柔軟な設定システムを提供し、複数のソースから設定を読み込むことをサポートして、開発と本番の異なるニーズを満たします。


Configオブジェクトの基本

Flaskアプリケーションの設定はapp.configの中に保存されます。これはディクショナリのようなもので、キー名で任意の設定値を読み書きできます:

例

from flask import Flask

app = Flask(__name__)

# 設定項目を直接設定する
app.config["SECRET_KEY"] = "your-secret-key"
app.config["DEBUG"] = True
app.config["DATABASE"] = "サンプル.db"

# 設定を読み込む
print(app.config["SECRET_KEY"])  # 出力: your-secret-key
print(app.debug)                 # 出力: True(DEBUG は app.debug プロパティからアクセス可能)

設定キー名はすべて大文字でなければなりません。これはFlaskの規約であり、設定読み込みメソッドと組み合わせて使用します。


組み込み設定項目

Flaskはフレームワークの動作を制御するための多数の組み込み設定項目を備えています。以下は開発で最もよく使われるものです:

設定項目 型 デフォルト値 説明
DEBUG bool None デバッグモードを有効にするかどうか(本番環境ではFalseにする必要があります)
TESTING bool False テストモードを有効にするかどうか
SECRET_KEY str None Sessionの署名に使用するシークレットキー(必須)
SERVER_NAME str None サーバーのドメイン+ポート(例: "example.com:5000")
MAX_CONTENT_LENGTH int None リクエストボディの最大サイズ(バイト)。アップロード制限に使用
SESSION_COOKIE_NAME str "session" Session Cookieの名前
PERMANENT_SESSION_LIFETIME timedelta 31日 永続Sessionの有効期間

Pythonファイルから読み込む——from_pyfile

最も一般的な方法は、設定を別のPythonファイルに書き込んでから読み込むことです:

# 文件路径:config.py(与 app.py 同级目录)
# 注意:所有键名必须大写
SECRET_KEY = "your-production-secret-key"
DATABASE_URL = "postgresql://user:pass@localhost/db"
MAX_CONTENT_LENGTH = 16 * 1024 * 1024  # 限制上传文件大小 16MB

# 开发配置
DEBUG = True

app.py コード:

# 文件路径:app.py
from flask import Flask

app = Flask(__name__)

# 加载 config.py 中所有大写的变量到 app.config
app.config.from_pyfile("config.py")

print(app.config["DATABASE_URL"])  # 输出: postgresql://user:pass@localhost/db

環境変数から読み込む——from_prefixed_env

環境変数からの読み込みは12-Factor Appが推奨する方法であり、本番環境へのデプロイに最適です。

FlaskはデフォルトでFLASK_というプレフィックスの環境変数を読み取ります。値はJSON型として解析が試みられます:

# 在终端设置环境变量(或写入 .flaskenv 文件)
export FLASK_SECRET_KEY="prod-secret"
export FLASK_MAX_CONTENT_LENGTH=16777216

app.py コード:

from flask import Flask
from datetime import timedelta

app = Flask(__name__)

# 加载默认配置
app.config["PERMANENT_SESSION_LIFETIME"] = timedelta(days=7)

# 自动加载所有以 FLASK_ 开头的环境变量
# 例如 FLASK_SECRET_KEY 会成为 config["SECRET_KEY"]
app.config.from_prefixed_env()

# 也可以自定义前缀
# app.config.from_prefixed_env("サンプル")  # 加载 サンプル_ 前缀的变量

ネスト設定

ダブルアンダースコアを使用すると__ネスト設定を定義できます:

$ export FLASK_DATABASE__HOST="localhost"
$ export FLASK_DATABASE__PORT="5432"

読み込み後の結果:

例

app.config.from_prefixed_env()
# config["DATABASE"] の値は {"host": "localhost", "port": 5432}
print(app.config["DATABASE"])  # 出力: {'host': 'localhost', 'port': 5432}

JSON/TOMLから読み込む——from_file

Pythonファイルと環境変数に加えて、FlaskはJSON、TOMLなどの形式からも設定を読み込むことができます:

例

// ファイルパス:config.json
{
  "SECRET_KEY": "サンプル-secret",
  "DATABASE_URL": "sqlite:///サンプル.db",
  "ITEMS_PER_PAGE": 20
}

例

import json

app = Flask(__name__)

# JSONファイルから読み込む(text=True はテキストモードを意味し、デフォルトでTrue)
app.config.from_file("config.json", load=json.load)
# TOMLファイルから読み込む(tomllib または tomli が必要)
# import tomllib
# app.config.from_file("config.toml", load=tomllib.load, text=False)

オブジェクトから読み込む——from_object

Pythonオブジェクト(モジュールまたはクラス)からすべての大文字属性を直接読み込みます:

例

# 推奨方法:設定クラスを定義して環境を区別する
class Config:
    SECRET_KEY = "dev-key"
    DATABASE = "dev.db"

class ProductionConfig(Config):
    DEBUG = False
    DATABASE = "prod.db"

class DevelopmentConfig(Config):
    DEBUG = True

# 環境変数に基づいて設定を選択する
import os
config_mode = os.environ.get("FLASK_CONFIG", "development")
if config_mode == "production":
    app.config.from_object(ProductionConfig)
else:
    app.config.from_object(DevelopmentConfig)

instanceフォルダ——秘密設定

一部の設定(本番環境のシークレットキーなど)はコードリポジトリにコミットするのに適さないため、次の場所に置くことができます:instanceフォルダの中:

例

app = Flask(__name__, instance_relative_config=True)

# instance/config.pyを読み込む(このファイルはGitにコミットしない)
app.config.from_pyfile("config.py", silent=True)

# instanceフォルダは通常、プロジェクトディレクトリ外の独立した場所にあります
myflaskapp/
├── app.py
├── config.py         # 公共配置(可提交到 Git)
└── instance/          # 不提交到 Git(.gitignore)
    └── config.py     # 私密配置(密钥等)

設定読み込みの優先順位

実際に最も一般的な設定読み込みの順序:

例

app = Flask(__name__)

# 1. デフォルト設定を読み込む(コードにハードコードされたデフォルト値)
app.config.update({
    "ITEMS_PER_PAGE": 20,
    "MAX_CONTENT_LENGTH": 16 * 1024 * 1024,
})

# 2. インスタンス設定を読み込む(instance/config.py、デフォルト値より優先度が高い)
app.config.from_pyfile("config.py", silent=True)

# 3. 環境変数を読み込む(優先度が最も高く、前述のすべての設定を上書きする)
app.config.from_prefixed_env()

この優先順位により、デフォルト値が最も弱く、ファイル設定が中程度、環境変数が最も強いことが保証されます——12-Factor Appのベストプラクティスに適合します。

その他の拡張