Dynaconf: una guia completa per a la gestió de configuració en Python

Traducció de l’original en anglès. Llegeix-lo en: CastellanoEnglish

Dynaconf és una potent biblioteca de gestió de configuració per a Python que simplifica el procés de gestionar i accedir a la configuració d'una aplicació. Ofereix una àmplia gamma de funcionalitats, com ara el suport per a múltiples fonts de configuració, variables d'entorn i recàrrega dinàmica.

Funcionalitats principals:

  • Múltiples fonts de configuració: Dynaconf pot llegir la configuració de diverses fonts, com ara variables d'entorn, fitxers i fins i tot servidors Vault. Aquesta flexibilitat us permet centralitzar la gestió de la configuració i adaptar-vos a diferents entorns de desplegament.

  • Suport de variables d'entorn: Dynaconf s'integra perfectament amb les variables d'entorn, cosa que facilita injectar valors de configuració des del vostre sistema o des d'entorns en contenidors.

  • Recàrrega dinàmica: Dynaconf pot recarregar dinàmicament els canvis de configuració sense reiniciar l'aplicació, de manera que la vostra aplicació sempre reflecteix la configuració més recent.

Formats de fitxer de configuració suportats:

Dynaconf suporta diversos formats de fitxer de configuració, com ara:

  • TOML (recomanat)

  • YAML

  • JSON

  • INI

  • Fitxers Python

Instal·lació:

Dynaconf es pot instal·lar amb pip o amb poetry:

pip install dynaconf

# or

poetry add dynaconf

Com inicialitzar Dynaconf

Dynaconf és una potent biblioteca de gestió de configuració per a Python que simplifica el procés de gestionar i accedir a la configuració d'una aplicació. Ofereix una àmplia gamma de funcionalitats, com ara el suport per a múltiples fonts de configuració, variables d'entorn i recàrrega dinàmica.

Per inicialitzar Dynaconf al vostre projecte, executeu la comanda següent al directori arrel del projecte:

dynaconf init -f toml

Aquesta comanda crearà els fitxers següents:

  • config.py: aquest fitxer importa l'objecte de configuració de Dynaconf.

  • settings.toml: aquest fitxer conté la configuració de la vostra aplicació.

  • .secrets.toml: aquest fitxer conté les vostres dades sensibles, com ara contrasenyes i tokens.

config.py

El fitxer config.py és un fitxer Python que importa l'objecte de configuració de Dynaconf. Aquest fitxer és necessari perquè Dynaconf funcioni.

Aquí teniu un exemple d'un fitxer config.py:

import dynaconf

settings = dynaconf.settings()

settings.toml

El fitxer settings.toml conté la configuració de la vostra aplicació. Aquest fitxer és opcional, però és la manera recomanada d'emmagatzemar la configuració.

Aquí teniu un exemple d'un fitxer settings.toml:

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

secrets.toml

El fitxer .secrets.toml conté les vostres dades sensibles, com ara contrasenyes i tokens. Aquest fitxer és opcional, però es recomana emmagatzemar les dades sensibles en un fitxer separat de la configuració de l'aplicació.

Aquí teniu un exemple d'un fitxer .secrets.toml:

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

Importar i utilitzar l'objecte de configuració de Dynaconf

Un cop hàgiu inicialitzat Dynaconf, podeu importar l'objecte de configuració al vostre codi Python. Per exemple:

from config import settings

Aleshores podeu accedir a la configuració de la vostra aplicació mitjançant l'objecte settings. Per exemple:

setting_value = settings.get('KEY')

Dynaconf també permet accedir a la configuració mitjançant atributs. Per exemple:

setting_value = settings.KEY

Importar variables d'entorn a Docker-Compose:

Quan utilitzeu Dynaconf amb Docker-Compose, la millor estratègia per importar variables d'entorn és definir-les al fitxer docker-compose.yml i després accedir-hi mitjançant la configuració envvar_prefix de Dynaconf.

version: "3.8"

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

Al vostre codi Python, podeu accedir a aquestes variables d'entorn amb Dynaconf:

import dynaconf

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

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

Conclusió:

Dynaconf és una biblioteca de gestió de configuració versàtil i potent per a Python que simplifica el procés de gestionar i accedir a la configuració d'una aplicació. El seu conjunt complet de funcionalitats i la seva facilitat d'ús la fan una opció ideal per a una àmplia gamma de projectes Python.