Si vous avez travaillé avec des projets Python, vous êtes probablement tombé sur les nombreuses façons de fournir une configuration. Je ne vais pas passer en revue toutes les méthodes ici, mais quelques-unes d'entre elles sont :

• en utilisant des fichiers .ini
• en utilisant une classe python
• en utilisant des fichiers .env
• en utilisant des fichiers JSON ou XML
• en utilisant un fichier yaml

Ma préférence va à la configuration yaml car je trouve généralement très pratique et facile à utiliser et j'aime vraiment que les fichiers yaml soient également utilisés dans, par exemple, la configuration docker-compose, c'est donc quelque chose que la plupart connaissent.

Pour l'analyse yaml, j'utilise la bibliothèque PyYAML Python.

Dans cet article, nous parlerons du cas du fichier yaml et plus précisément de ce que vous pouvez faire pour éviter de garder vos secrets, par exemple vos mots de passe, vos hôtes, vos noms d'utilisateur, etc., directement dessus .

Disons que nous avons un exemple très simple de configuration de fichier yaml :

database:
 name: database_name
 user: me
 password: very_secret_and_complex
 host: localhost
 port: 5432
ws:
 user: username
 password: very_secret_and_complex_too
 host: localhost

Pour que PyYAML soit capable de résoudre les variables d'environnement, nous avons besoin de trois éléments principaux :

• Un modèle d'expression régulière pour l'identification de la variable d'environnement, par exemplepattern = re.compile(‘.*?\${(\w+)}.*?’)
• Une balise qui signifiera qu'il y a une variable d'environnement (ou plusieurs) à analyser, par exemple !ENV.
• Et une fonction que le chargeur utilisera pour résoudre les variables d'environnement

Exemple de configuration YAML avec des variables d'environnement :

database:
 name: database_name
 user: !ENV ${DB_USER}
 password: !ENV ${DB_PASS}
 host: !ENV ${DB_HOST}
 port: 5432
ws:
 user: !ENV ${WS_USER}
 password: !ENV ${WS_PASS}
 host: !ENV ‘https://${CURR_ENV}.ws.com.local'

ws:
 user: !ENV ${WS_USER}
 password: !ENV ${WS_PASS}
 host: !ENV 'https://${CURR_ENV}.ws.com.${MODE}'  # multiple env var

Définissez d’abord les variables d’environnement. Par exemple, pour le DB_PASS:

export DB_PASS=very_secret_and_complex

read -s ‘Database password: ‘ db_pass
export DB_PASS=$db_pass
    
      

python use_env_variables_in_config_example.py -c /path/to/yaml

Et dans votre code, faites des choses avec conf, par exemple accédez au mot de passe de la base de données comme ceci :conf['database']['DB_PASS']

J'espère que cela a été utile. Toutes les pensées, questions, corrections et suggestions sont les bienvenues :)

Liens utiles