Управление конфигурацией во Flask

Любому приложению нужна конфигурация — адреса баз данных, ключи, переключатели режима отладки и так далее.

Flask предоставляет гибкую систему конфигурации, которая поддерживает загрузку конфигурации из нескольких источников, чтобы удовлетворить различные потребности при разработке и в продакшене.

Основы объекта конфигурации

Конфигурация приложения Flask хранится вapp.configОн похож на словарь, и можно читать и записывать любое значение конфигурации по имени ключа:

Имена ключей конфигурацииДолжны быть полностью в верхнем регистреЭто соглашение Flask, используемое вместе с методами загрузки конфигурации.

Встроенные элементы конфигурации

Flask имеет большое количество встроенных элементов конфигурации для управления поведением фреймворка. Ниже приведены наиболее часто используемые при разработке:

Загрузка из файла 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, лучше всего подходит для развертывания в production.

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

Вложенная конфигурация

Использование двойных подчёркиваний__Вложенную конфигурацию можно задать:

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

Результат после загрузки:

Загрузка из JSON/TOML — from_file

Помимо файлов Python и переменных среды, Flask также поддерживает загрузку конфигурации из таких форматов, как JSON и TOML:

Загрузка из объекта——from_object

Загрузить все атрибуты в верхнем регистре напрямую из объекта Python (модуля или класса):

Папка instance — приватная конфигурация

Некоторые конфигурации не подходят для коммита в репозиторий кода (например, секретные ключи production). Их можно разместитьinstanceв папке:

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

Приоритет загрузки конфигурации

Обычный порядок загрузки конфигурации на практике:

Такая расстановка приоритетов обеспечивает: значения по умолчанию — самые слабые, конфигурация из файла — средняя, а переменные окружения — самые сильные, что соответствует лучшим практикам 12-Factor App.