Gestion de la configuration Flask

Toute application a besoin de configuration — adresses de base de données, clés, commutateurs de mode de débogage, etc.

Flask fournit un système de configuration flexible qui prend en charge le chargement de la configuration depuis plusieurs sources afin de répondre à des besoins différents en développement et en production.

Notions de base sur l'objet Config

La configuration de l'application Flask est stockée dansapp.config. Dans celui-ci, il se comporte comme un dictionnaire, et vous pouvez lire et écrire n'importe quelle valeur de configuration par nom de clé :

Noms des clés de configurationDoivent être entièrement en majusculesIl s'agit d'une convention Flask, utilisée avec les méthodes de chargement de configuration.

Éléments de configuration intégrés

Flask dispose d'un grand nombre d'éléments de configuration intégrés pour contrôler le comportement du framework. Les suivants sont les plus couramment utilisés en développement :

Charger depuis un fichier Python — from_pyfile

La pratique la plus courante consiste à écrire la configuration dans un fichier Python séparé, puis à la charger :

# 文件路径：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

Code de 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

Charger depuis les variables d'environnement——from_prefixed_env

Le chargement à partir des variables d'environnement est une pratique recommandée de la 12-Factor App, la mieux adaptée au déploiement en production.

Flask lit par défautFLASK_les variables d'environnement avec le préfixe, et une analyse des valeurs en type JSON sera tentée :

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

Code de 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("EXAMPLE")  # 加载 EXAMPLE_ 前缀的变量

Configuration imbriquée

Utilisation de doubles underscores__La configuration imbriquée peut être définie :

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

Résultat après chargement :

Charger depuis JSON/TOML — from_file

Outre les fichiers Python et les variables d'environnement, Flask prend également en charge le chargement de la configuration à partir de formats tels que JSON et TOML :

Charger depuis un objet——from_object

Charger tous les attributs en majuscules directement depuis un objet Python (module ou classe) :

Le dossier d'instance—configuration privée

Certaines configurations ne doivent pas être versionnées dans un dépôt de code (comme les clés secrètes de production). Elles peuvent être placées dansinstanceDans le dossier :

myflaskapp/
├── app.py
├── config.py         # 公共配置（可提交到 Git）
└── instance/          # 不提交到 Git（.gitignore）
    └── config.py     # 私密配置（密钥等）

Priorité de chargement de la configuration

Un ordre courant de chargement de la configuration en pratique :

Une telle priorité garantit : les valeurs par défaut sont les plus faibles, la configuration de fichier est moyenne, et les variables d'environnement sont les plus fortes—conformément aux bonnes pratiques de la 12-Factor App.