Flask Config API de clase de configuración
Config es una subclase de diccionario que gestiona todos los elementos de configuración de la aplicación Flask.
A través deapp.configse accede, admite cargar configuración desde múltiples fuentes.
Métodos de la clase Config
| Método | Firma | Descripción |
|---|---|---|
| from_pyfile | (filename, silent=False) | Carga la configuración desde un archivo Python. Cuando silent=True ignora el error de archivo inexistente |
| from_object | (obj) | Carga la configuración desde un objeto (módulo, clase, ruta de importación de cadena). Solo carga atributos en mayúsculas |
| from_envvar | (variable_name, silent=False) | Carga la configuración desde el archivo apuntado por una variable de entorno. Equivale a from_pyfile(os.environ[var]) |
| from_prefixed_env | (prefix="FLASK", *, loads=json.loads) | Carga desde variables de entorno. Lee variables con prefijo FLASK_, y tras eliminar el prefijo las establece como configuración |
| from_file | (filename, load, silent=False, text=True) | Carga desde un archivo de cualquier formato. load es la función de análisis (como json.load, tomllib.load) |
| from_mapping | (mapping=None, **kwargs) | Carga configuración desde un objeto de mapeo. Admite pares clave-valor **kwargs opcionales. Solo carga claves en mayúsculas |
| get_namespace | (namespace, lowercase=True, trim_namespace=True) | Obtiene un subconjunto de configuración con el prefijo especificado. Por ejemplo, get_namespace("DB_") obtiene toda la configuración de base de datos |
Comparación de métodos de carga
| Método de carga | Escenario aplicable | Ejemplo |
|---|---|---|
| from_pyfile | El archivo de configuración está en formato Python | app.config.from_pyfile("config.py") |
| from_object | Usar clases o módulos para organizar la configuración y distinguir entornos | app.config.from_object("myapp.config.ProductionConfig") |
| from_prefixed_env | 12-Factor App, configuración mediante variables de entorno | app.config.from_prefixed_env() |
| from_file | Formatos no Python como JSON, TOML | app.config.from_file("config.json", load=json.load) |
| get_namespace | Extraer un subconjunto de configuración para pasarlo al constructor de una biblioteca | db_config = app.config.get_namespace("DB_") |
Reglas de nomenclatura de claves de configuración
Nombre de la clave de configuraciónDebe estar en mayúsculas. Esta es una convención de Flask; métodos como from_object, from_mapping, from_prefixed_env ignoran automáticamente las claves en minúsculas.
Ejemplo de código
Ejemplo
from flask import Flask
app = Flask(__name__)
# Método 1: Cargar desde archivo Python
app.config.from_pyfile("config.py")
# Método 2: Cargar desde variables de entorno (lee el prefijo FLASK_)
app.config.from_prefixed_env()
# Método 3: Configurar directamente
app.config["MY_SETTING"] = "value"
# Método 4: Cargar desde JSON
import json
app.config.from_file("config.json", load=json.load)
# Método 5: Obtener configuración de espacio de nombres
# Supongamos que hay configuraciones como DB_HOST, DB_PORT, DB_NAME
db_config = app.config.get_namespace("DB_")
# db_config = {"host": "...", "port": ..., "name": "..."}
app = Flask(__name__)
# Método 1: Cargar desde archivo Python
app.config.from_pyfile("config.py")
# Método 2: Cargar desde variables de entorno (lee el prefijo FLASK_)
app.config.from_prefixed_env()
# Método 3: Configurar directamente
app.config["MY_SETTING"] = "value"
# Método 4: Cargar desde JSON
import json
app.config.from_file("config.json", load=json.load)
# Método 5: Obtener configuración de espacio de nombres
# Supongamos que hay configuraciones como DB_HOST, DB_PORT, DB_NAME
db_config = app.config.get_namespace("DB_")
# db_config = {"host": "...", "port": ..., "name": "..."}