Desarrollo #json#python#yaml 3 min

Dynaconf: una guía completa para la gestión de configuración en Python

Traducción del original en inglés. Léela en: CatalàEnglish

Dynaconf es una potente biblioteca de gestión de configuración para Python que simplifica el proceso de gestionar y acceder a la configuración de una aplicación. Ofrece una amplia gama de funcionalidades, como el soporte para múltiples fuentes de configuración, variables de entorno y recarga dinámica.

Funcionalidades principales:

  • Múltiples fuentes de configuración: Dynaconf puede leer la configuración de diversas fuentes, como variables de entorno, archivos e incluso servidores Vault. Esta flexibilidad os permite centralizar la gestión de la configuración y adaptaros a diferentes entornos de despliegue.

  • Soporte de variables de entorno: Dynaconf se integra a la perfección con las variables de entorno, lo que facilita inyectar valores de configuración desde vuestro sistema o desde entornos en contenedores.

  • Recarga dinámica: Dynaconf puede recargar dinámicamente los cambios de configuración sin reiniciar la aplicación, de modo que vuestra aplicación siempre refleja la configuración más reciente.

Formatos de archivo de configuración soportados:

Dynaconf soporta diversos formatos de archivo de configuración, como:

  • TOML (recomendado)

  • YAML

  • JSON

  • INI

  • Archivos Python

Instalación:

Dynaconf se puede instalar con pip o con poetry:

pip install dynaconf

# or

poetry add dynaconf

Cómo inicializar Dynaconf

Dynaconf es una potente biblioteca de gestión de configuración para Python que simplifica el proceso de gestionar y acceder a la configuración de una aplicación. Ofrece una amplia gama de funcionalidades, como el soporte para múltiples fuentes de configuración, variables de entorno y recarga dinámica.

Para inicializar Dynaconf en vuestro proyecto, ejecutad el siguiente comando en el directorio raíz del proyecto:

dynaconf init -f toml

Este comando creará los siguientes archivos:

  • config.py: este archivo importa el objeto de configuración de Dynaconf.

  • settings.toml: este archivo contiene la configuración de vuestra aplicación.

  • .secrets.toml: este archivo contiene vuestros datos sensibles, como contraseñas y tokens.

config.py

El archivo config.py es un archivo Python que importa el objeto de configuración de Dynaconf. Este archivo es necesario para que Dynaconf funcione.

Aquí tenéis un ejemplo de un archivo config.py:

import dynaconf

settings = dynaconf.settings()

settings.toml

El archivo settings.toml contiene la configuración de vuestra aplicación. Este archivo es opcional, pero es la forma recomendada de almacenar la configuración.

Aquí tenéis un ejemplo de un archivo settings.toml:

[default]
debug = false
host = "localhost"
port = 5000

secrets.toml

El archivo .secrets.toml contiene vuestros datos sensibles, como contraseñas y tokens. Este archivo es opcional, pero se recomienda almacenar los datos sensibles en un archivo separado de la configuración de la aplicación.

Aquí tenéis un ejemplo de un archivo .secrets.toml:

[default]
database_password = "my_database_password"
api_token = "my_api_token"

Importar y utilizar el objeto de configuración de Dynaconf

Una vez hayáis inicializado Dynaconf, podéis importar el objeto de configuración en vuestro código Python. Por ejemplo:

from config import settings

Entonces podéis acceder a la configuración de vuestra aplicación mediante el objeto settings. Por ejemplo:

setting_value = settings.get('KEY')

Dynaconf también permite acceder a la configuración mediante atributos. Por ejemplo:

setting_value = settings.KEY

Importar variables de entorno en Docker-Compose:

Cuando utilizáis Dynaconf con Docker-Compose, la mejor estrategia para importar variables de entorno es definirlas en vuestro archivo docker-compose.yml y después acceder a ellas mediante la configuración envvar_prefix de Dynaconf.

version: "3.8"

services:
  app:
    build: .
    environment:
      - APP_DEBUG=true
      - APP_HOST=0.0.0.0
      - APP_PORT=8000

En vuestro código Python, podéis acceder a estas variables de entorno con Dynaconf:

import dynaconf

settings = dynaconf.settings(envvar_prefix="APP")

debug = settings.get("DEBUG")
host = settings.get("HOST")
port = settings.get("PORT")

Conclusión:

Dynaconf es una biblioteca de gestión de configuración versátil y potente para Python que simplifica el proceso de gestionar y acceder a la configuración de una aplicación. Su conjunto completo de funcionalidades y su facilidad de uso la convierten en una opción ideal para una amplia gama de proyectos Python.