Wenn Sie mit Python-Projekten gearbeitet haben, sind Sie wahrscheinlich auf die vielen Möglichkeiten gestoßen, die Konfiguration bereitzustellen. Ich werde hier nicht alle Wege gehen, aber einige davon sind:

• Verwenden von INI-Dateien
• mit einer Python-Klasse
• Verwenden von .env-Dateien
• Verwenden von JSON- oder XML-Dateien
• mit einer Yaml-Datei

Ich bevorzuge die Arbeit mit der Yaml-Konfiguration, da ich diese normalerweise sehr praktisch und einfach zu verwenden finde und es mir sehr gefällt, dass Yaml-Dateien auch in der Docker-Compose-Konfiguration verwendet werden, so dass die meisten damit vertraut sind.

Für das Yaml-Parsing verwende ich die PyYAML Python-Bibliothek.

In diesem Artikel werden wir über den Fall der Yaml-Datei sprechen und genauer darüber, was Sie tun können, um zu vermeiden, dass Ihre Geheimnisse, z. B. Passwörter, Hosts, Benutzernamen usw., direkt darauf gespeichert werden .

Angenommen, wir haben ein sehr einfaches Beispiel für eine Yaml-Dateikonfiguration:

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

Damit PyYAML Umgebungsvariablen auflösen kann, benötigen wir drei wichtige Dinge:

• Ein Regex-Muster für die Identifizierung von Umgebungsvariablen, z pattern = re.compile(‘.*?\${(\w+)}.*?’)
• Ein Tag, das angibt, dass eine Umgebungsvariable (oder mehr) analysiert werden muss, z !ENV.
• Und eine Funktion, mit der der Loader die Umgebungsvariablen auflöst

Beispiel einer YAML-Konfiguration mit Umgebungsvariablen:

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

Stellen Sie zuerst die Umgebungsvariablen ein. Zum Beispiel für 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

Und machen Sie in Ihrem Code Dinge mit conf, z. B. greifen Sie wie folgt auf das Datenbankkennwort zu: conf['database']['DB_PASS']

Ich hoffe das war hilfreich. Alle Gedanken, Fragen, Korrekturen und Vorschläge sind sehr willkommen :)

Nützliche Links