Für Anfänger: YAML-Dateien sicher in Python laden – safe_load und Fehlerbehebung

1. Wie liest man YAML in Python? | Überblick über diesen Artikel und Zielgruppe

Für Sie, die YAML in Python handhaben möchten

• Konfigurationsdateien von Web-Apps oder Skripten extern auslagern
• Docker Compose oder Kubernetes-Konfigurationsdateien in Python analysieren möchten
• Parameter von Machine-Learning-Frameworks in YAML verwalten möchten

Was Sie in diesem Artikel lernen können

• Grundstruktur und Merkmale von YAML-Dateien
• Lademethode in Python (safe_load()-Verwendung)
• Häufige Fehler und deren Behebung
• Laden mehrerer Dokumente und praktische Beispiele für Konfigurationsdateien

Zielgruppe

• Anfänger bis Fortgeschrittene, die YAML in Python ausprobieren möchten
• Entwickler, die Konfigurationsdateien handhaben müssen
• Personen, die Unsicherheiten bei der Verwendung von PyYAML haben
• Personen, die mehr über safe_load() und Fehlerbehandlung wissen möchten

2. Was ist YAML? | Einfacher Vergleich der Unterschiede und Merkmale mit JSON

Was ist YAML?

Unterschiede zu JSON

Vorteile von YAML

• Intuitive Schreibweise: Ähnlich wie Einrückungen in Python, Struktur leicht erfassbar
• Kommentare möglich: Praktisch für Ergänzungen in Konfigurationsdateien
• Nicht redundant: Keine geschweiften Klammern oder doppelten Anführungszeichen wie in JSON nötig
• Menschenfreundlich: Auch für Nicht-Techniker leicht lesbar und editierbar

Einsatzbereiche von YAML

• Docker Compose (docker-compose.yml)
• Kubernetes-Konfigurationsdateien (Definition von Pods und Services)
• CI/CD-Tools (GitHub Actions, GitLab CI usw.)
• Machine-Learning-Bibliotheken (PyTorch Lightning, Hydra usw.)
• Konfigurationsdateien für Web-Apps oder Skripte

3. Vorbereitung zum Umgang mit YAML in Python | Installation von PyYAML

Was ist PyYAML?

Installationsmethode für PyYAML

pip install pyyaml

Verwendung einer virtuellen Umgebung wird empfohlen

# Erstellen der virtuellen Umgebung
python -m venv venv

# Aktivieren der virtuellen Umgebung
# Im Fall von Windows
venvScripts\activate
# Im Fall von macOS/Linux
source venv/bin/activate

# PyYAML installieren
pip install pyyaml

Überprüfung der Installation

import yaml
print(yaml.__version__)

4. [Grundlagen] Methode zum Lesen von YAML-Dateien in Python (Verwendung von safe_load)

Die grundlegendste Lademethode: safe_load()

Beispiel-YAML-Datei (config.yaml)

app:
  name: SampleApp
  version: 1.0.0
debug: true
servers:
  - host: localhost
    port: 8000
  - host: example.com
    port: 443

Beispiel für Lade-Code in Python

import yaml

with open('config.yaml', 'r', encoding='utf-8') as f:
    config = yaml.safe_load(f)

print(config)

Ausgabebeispiel (Python-Dictionary-Format)

{
  'app': {'name': 'SampleApp', 'version': '1.0.0'},
  'debug': True,
  'servers': [
    {'host': 'localhost', 'port': 8000},
    {'host': 'example.com', 'port': 443}
  ]
}

Die Angabe der Kodierung in der open()-Funktion ist wichtig

Ein Tipp: Die Verwendung der with-Syntax

5. Unterschiede zwischen safe_load und load | Hinweise zum Lesen von YAML in Python

safe_load() und load(): Was ist der Unterschied?

Merkmale von safe_load() (sicheres Lesen)

import yaml

with open('config.yaml', 'r', encoding='utf-8') as f:
    data = yaml.safe_load(f)

• Die grundlegende Funktion, die man verwenden sollte
• Hohe Sicherheit (liest keine beliebigen Python-Objekte)
• Eingeschränkt auf grundlegende Datentypen (Dictionaries, Listen, Strings, Zahlen usw.)
• Bei Versuch, unbekannte Typen oder Objekte zu lesen, tritt ein Fehler auf

Merkmale von load() (flexibel, aber mit Risiken)

import yaml

with open('config.yaml', 'r', encoding='utf-8') as f:
    data = yaml.load(f, Loader=yaml.FullLoader)

• Kann YAML flexibler interpretieren
• Kann Python-Objekte (z. B. Funktionen, Klasseninstanzen usw.) wiederherstellen
• Aufgrund von Sicherheitsrisiken ist die Angabe des Loaders erforderlich

yaml.YAMLLoadWarning: calling yaml.load() without Loader=... is deprecated

Arten von Loaders (Unterschiede in Sicherheit und Flexibilität)

Schlussfolgerung: Verwenden Sie normalerweise safe_load()

6. Häufige Fehler und deren Lösungen | Fallstricke beim Lesen von YAML in Python

Warum stolpert man beim Lesen von YAML?

1. Syntaxfehler durch falsche Einrückung

Beispiel: YAML mit Einrückungsfehler

user:
  name: Alice
    age: 30

Beispiel für Fehlermeldung:

yaml.scanner.ScannerError: mapping values are not allowed here

Lösung:

• Einrückung einheitlich mit 2–4 Leerzeichen (keine Tabs verwenden)
• Unterelemente tiefere Einrückung als übergeordnete Elemente geben

2. Zeichensalat durch falsche Dateikodierung

Fehlerbeispiel:

UnicodeDecodeError: 'cp932' codec can't decode byte...

Lösung:

with open('config.yaml', 'r', encoding='utf-8') as f:
    data = yaml.safe_load(f)

• Durch explizite Angabe von encoding='utf-8' kann das Problem behoben werden
• In Windows-Umgebungen ist das ein Punkt, der leicht vergessen wird

3. Falscher Dateipfad / Nicht existierende Datei

Fehlerbeispiel:

FileNotFoundError: [Errno 2] No such file or directory: 'config.yaml'

Lösung:

• Überprüfen, ob der Pfad absolut oder korrekt relativ angegeben ist
• Auf Tippfehler in Dateinamen oder Erweiterungen achten
• Prüfen, ob die Datei im selben Verzeichnis wie das Skript liegt

4. Ergebnis von safe_load ist None

Beispiel:

# Diese Datei enthält keine Einstellungen

Ergebnis:

data = yaml.safe_load(f)
print(data)  # Ausgabe: None

Lösung:

• Überprüfen, ob gültige YAML-Daten in der Datei beschrieben sind
• Nur Kommentare oder Leerzeichen führen zu None, was normales Verhalten ist

5. Parsefehler durch zu komplexe YAML-Struktur

Lösung:

• Schrittweise Syntax überprüfen (in kleinen Abschnitten validieren)
• Empfohlen: Ausnahme mit yaml.YAMLError abfangen und detaillierte Meldung prüfen

try:
    with open('config.yaml', 'r', encoding='utf-8') as f:
        data = yaml.safe_load(f)
except yaml.YAMLError as e:
    print(f"YAML-Lesefehler: {e}")

Zusammenfassung: Bei Fehlern ruhig Syntax und Umgebung prüfen

• Ist die Einrückung korrekt (keine Tabs verwendet?)
• Ist die Dateikodierung UTF-8?
• Existiert die Datei?
• Ist der Inhalt der YAML korrekt beschrieben?

7. Anwendung: Methode zum Lesen von YAML-Dateien mit mehreren Dokumenten (safe_load_all)

YAML kann mehrere Dokumente in einer Datei enthalten

Beispiel für eine YAML-Datei mit mehreren Dokumenten (multi.yaml)

# Servereinstellung 1
---
server:
  host: localhost
  port: 8080

# Servereinstellung 2
---
server:
  host: example.com
  port: 443

Verwendung von yaml.safe_load_all()

import yaml

with open('multi.yaml', 'r', encoding='utf-8') as f:
    documents = yaml.safe_load_all(f)
    for doc in documents:
        print(doc)

Ausführungsresultat (Beispielausgabe):

{'server': {'host': 'localhost', 'port': 8080}}
{'server': {'host': 'example.com', 'port': 443}}

Auf den Unterschied zu safe_load() achten

Es ist auch möglich, die geladenen Dokumente in eine Liste umzuwandeln

with open('multi.yaml', 'r', encoding='utf-8') as f:
    documents = list(yaml.safe_load_all(f))

Hinweis: Nicht alle YAML-Dateien unterstützen mehrere Dokumente

8. [Zusatz] Wichtige Punkte beim Einsatz von YAML als Konfigurationsdatei

Warum eignet sich YAML für Konfigurationsdateien?

• Umgebungskonfiguration für Web-Anwendungen (Produktion/Entwicklung/Test)
• Hyperparameter-Konfiguration für maschinelles Lernen
• Umschalten des Verhaltens von Skripten
• Verwaltung externer Abhängigkeiten wie API-Keys (※ Bei der Verwaltung sensibler Informationen Vorsicht walten lassen)

Praktisches Beispiel für eine YAML-Konfigurationsdatei

app:
  name: MyApp
  mode: production

logging:
  level: INFO
  file: logs/app.log

database:
  host: localhost
  port: 5432
  user: admin
  password: secret

Hierarchisierung der Konfiguration unter Nutzung der verschachtelten Struktur

env:
  dev:
    db: dev-db.local
    debug: true
  prod:
    db: prod-db.server
    debug: false

Absichten durch Kommentare explizit machen

# Einstellung des App-Modus (dev, test, production eines davon)
mode: production

Code-Beispiel zum Laden von YAML zur Laufzeit (Anwendung)

import yaml

with open('settings.yaml', 'r', encoding='utf-8') as f:
    config = yaml.safe_load(f)

app_name = config['app']['name']
mode = config['app']['mode']
db_host = config['database']['host']

Achtungspunkte: Bei der Handhabung sensibler Informationen ausreichend Vorsicht walten lassen

• Commits in das Repository mit .gitignore verhindern
• Mit .env-Dateien usw. kombinieren und in YAML nur referenzieren
• Verschlüsselung oder Zugriffsbeschränkungen anwenden

9. Häufig gestellte Fragen (FAQ)

Q1. Welches ist in Python einfacher zu handhaben: YAML oder JSON?

Q2. yaml.load() darf man nicht verwenden?

Q3. Warum ist der Inhalt der eingelesenen YAML-Datei leer (None)?

# Diese Datei ist noch nicht konfiguriert

Q4. Kann man in einer YAML-Datei Werte wiederverwenden (wie Variablen)?

default: &defaults
  timeout: 30
  retries: 3

service1:
  <<: *defaults
  host: service1.local

service2:
  <<: *defaults
  host: service2.local

Q5. Unter Windows werden japanische Zeichen als Zeichenkodierungsfehler dargestellt. Was kann man tun?

with open('config.yaml', 'r', encoding='utf-8') as f:
    data = yaml.safe_load(f)

Q6. Wie liest man eine YAML-Datei mit mehreren Konfigurationsblöcken ein?

---
app: App1
port: 3000
---
app: App2
port: 4000

with open('multi.yaml', 'r', encoding='utf-8') as f:
    for doc in yaml.safe_load_all(f):
        print(doc)

10. Zusammenfassung | YAML in Python lesen und meistern

Überblick über YAML-Lesen: Von den Grundlagen bis zu fortgeschrittenen Anwendungen

• Installation von PyYAML: Um YAML in Python zu handhaben, ist zunächst pip install pyyaml erforderlich.
• Grundlegendes Lesen: Mit yaml.safe_load() können Sie YAML sicher und einfach als Dictionary oder Liste laden.
• Fehlerbehebung: Einrückungs- oder Kodierungsfehler sind häufige Probleme. Syntaxprüfung und encoding='utf-8' sind wichtig.
• Unterschied zu load(): Für Sicherheit sollten Sie safe_load() verwenden. Bei load() ist die Angabe eines geeigneten Loaders erforderlich.
• Handhabung mehrerer Dokumente: Mit safe_load_all() können Sie mehrere Konfigurationsblöcke in einer Datei flexibel verarbeiten.
• Praktische Nutzung als Konfigurationsdatei: YAML mit seiner hohen Lesbarkeit und Flexibilität ist ideal für die Konfigurationsverwaltung in Python-Projekten.

Nächste Schritte: YAML noch intensiver nutzen

• Schreiben in YAML-Dateien: Automatische Generierung von Konfigurationsdateien mit yaml.dump()
• Wechselkonvertierung mit JSON: Praktisch bei der Integration mit Web-APIs oder externen Diensten
• Kombinierte Nutzung mit .env-Dateien oder Umgebungsvariablen: Aufbau sicherer Konfigurationsmanagement-Techniken
• Automatisches Laden von Einstellungen: Mechanismus zum dynamischen Laden von Konfigurationsdateien je nach Umgebung beim App-Start