Wie kann ich eine YAML-Datei in Python parsen?

Question

Wie kann ich eine YAML-Datei in Python parsen?

Answer 1

Die einfachste und reinste Methode, ohne sich auf C-Header zu verlassen, ist PyYaml ( Dokumentation ), die über pip install pyyaml :

#!/usr/bin/env python

import yaml

with open("example.yaml", "r") as stream:
    try:
        print(yaml.safe_load(stream))
    except yaml.YAMLError as exc:
        print(exc)

Und das war's. Einfarbig yaml.load() Funktion gibt es auch, aber yaml.safe_load() sollte immer vorgezogen werden, um die Möglichkeit der Ausführung von beliebigem Code zu vermeiden. Wenn Sie also nicht explizit die Serialisierung/Deserialisierung beliebiger Objekte benötigen, verwenden Sie safe_load .

Beachten Sie, dass das PyYaml-Projekt Versionen bis zur YAML 1.1-Spezifikation . Wenn YAML 1.2 Spezifikation Unterstützung benötigt wird, siehe ruamel.yaml wie vermerkt in diese Antwort .

Sie könnten auch einen Drop-in-Ersatz für pyyaml verwenden, der Ihre yaml-Datei geordnet hält so wie du es hattest , genannt oyaml . Siehe Synchro von oyaml hier

Answer 2

Lesen und Schreiben von YAML-Dateien mit Python 2+3 (und Unicode)

# -*- coding: utf-8 -*-
import yaml
import io

# Define data
data = {
    'a list': [
        1, 
        42, 
        3.141, 
        1337, 
        'help', 
        u'€'
    ],
    'a string': 'bla',
    'another dict': {
        'foo': 'bar',
        'key': 'value',
        'the answer': 42
    }
}

# Write YAML file
with io.open('data.yaml', 'w', encoding='utf8') as outfile:
    yaml.dump(data, outfile, default_flow_style=False, allow_unicode=True)

# Read YAML file
with open("data.yaml", 'r') as stream:
    data_loaded = yaml.safe_load(stream)

print(data == data_loaded)

Erstellte YAML-Datei

a list:
- 1
- 42
- 3.141
- 1337
- help
- €
a string: bla
another dict:
  foo: bar
  key: value
  the answer: 42

Gemeinsame Dateiendungen

.yml y .yaml

Alternativen

• CSV: Supereinfaches Format ( Lesen und Schreiben )
• JSON: Gut geeignet zum Schreiben von menschenlesbaren Daten; SEHR häufig verwendet ( Lesen und Schreiben )
• YAML: YAML ist eine Obermenge von JSON, aber einfacher zu lesen ( Lesen und Schreiben , Vergleich von JSON und YAML )
• einlegen: Ein Python-Serialisierungsformat ( Lesen und Schreiben )
• MessagePack ( Python-Paket ): Eine kompaktere Darstellung ( Lesen und Schreiben )
• HDF5 ( Python-Paket ): Schön für Matrizen ( Lesen und Schreiben )
• XML: existiert auch *seufz* ( lesen & schreiben. )

Für Ihre Bewerbung könnten folgende Punkte wichtig sein:

• Unterstützung durch andere Programmiersprachen
• Lese-/Schreibleistung
• Kompaktheit (Dateigröße)

Siehe auch: Vergleich von Formaten zur Serialisierung von Daten

Falls Sie eher nach einer Möglichkeit suchen, Konfigurationsdateien zu erstellen, sollten Sie meinen kurzen Artikel lesen Konfigurationsdateien in Python

Answer 3

Wenn Sie YAML haben, das dem YAML 1.2 Spezifikation (veröffentlicht 2009), dann sollten Sie ruamel.yaml (Haftungsausschluss: Ich bin der Autor dieses Pakets). Es ist im Wesentlichen eine Obermenge von PyYAML, das den größten Teil von YAML 1.1 (von 2005) unterstützt.

Wenn Sie in der Lage sein wollen, Ihre Kommentare beim Roundtrip zu erhalten, sollten Sie auf jeden Fall ruamel.yaml verwenden.

Das Beispiel von @Jon ist leicht zu verbessern:

import ruamel.yaml as yaml

with open("example.yaml") as stream:
    try:
        print(yaml.safe_load(stream))
    except yaml.YAMLError as exc:
        print(exc)

Verwenden Sie safe_load() es sei denn, Sie haben wirklich die volle Kontrolle über die Eingabe, brauchen sie (was selten der Fall ist) und wissen, was Sie tun.

Wenn Sie pathlib verwenden Path für die Bearbeitung von Dateien zu verwenden, ist es besser, die neue API ruamel.yaml zu nutzen:

from ruamel.yaml import YAML
from pathlib import Path

path = Path('example.yaml')
yaml = YAML(typ='safe')
data = yaml.load(path)

Answer 4

Installieren Sie zunächst pyyaml mit pip3.

Dann importieren Sie das Modul yaml und laden Sie die Datei in ein Wörterbuch namens "my_dict":

import yaml
with open('filename.yaml') as f:
    my_dict = yaml.safe_load(f)

Das ist alles, was Sie brauchen. Jetzt befindet sich die gesamte yaml-Datei im Wörterbuch "my_dict".

Answer 5

Um auf ein beliebiges Element einer Liste in einer YAML-Datei zuzugreifen, gehen Sie wie folgt vor:

global:
  registry:
    url: dtr-:5000/
    repoPath:
  dbConnectionString: jdbc:oracle:thin:@x.x.x.x:1521:abcd

Sie können das folgende Python-Skript verwenden:

import yaml

with open("/some/path/to/yaml.file", 'r') as f:
    valuesYaml = yaml.load(f, Loader=yaml.FullLoader)

print(valuesYaml['global']['dbConnectionString'])