Wie kann ich eine YAML-Datei in Python parsen?

Question 1

Question 2

Die einfachste und reinste Methode, ohne sich auf C-Header zu verlassen, ist PyYaml (Dokumentation), die über installiert werden kann 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 ist es. Eine Fläche yaml.load() Funktion existiert auch, aber yaml.safe_load() sollte immer bevorzugt werden, um die Möglichkeit der Ausführung willkürlichen Codes zu vermeiden. Es sei denn, Sie benötigen explizit die Verwendung der willkürlichen Objektserialisierung/-deserialisierung safe_load.

Beachten Sie, dass das PyYaml-Projekt Versionen bis zum unterstützt YAML 1.1-Spezifikation. Wenn YAML 1.2-Spezifikation Unterstützung benötigt wird, siehe ruamel.yaml wie in dieser Antwort erwähnt.

Außerdem könnten Sie auch einen Drop-in-Ersatz für pyyaml verwenden, der Ihre yaml-Datei in Ordnung hält so wie du es hattestgenannt oyaml. Aussicht synk von oyaml hier

Question 3

Lesen & 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)

YAML-Datei erstellt

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

Gängige Dateiendungen

.yml und .yaml

Alternativen

CSV: Supereinfaches Format (Lesen & Schreiben)
JSON: Gut zum Schreiben von menschenlesbaren Daten; SEHR häufig verwendet (Lesen & Schreiben)

YAML: YAML ist eine Obermenge von JSON, aber einfacher zu lesen (Lesen & Schreiben, Vergleich von JSON und YAML)
pickle: Ein Python-Serialisierungsformat (Lesen & Schreiben) ⚠️ Die Verwendung von Pickle mit Dateien von Drittanbietern birgt ein unkontrollierbares Risiko der Ausführung willkürlichen Codes.
MessagePack (Python-Paket): Kompaktere Darstellung (Lesen & Schreiben)

HDF5 (Python-Paket): Nett für Matrizen (Lesen & 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 Datenserialisierungsformaten

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

Question 4

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

Wenn Sie Ihre Kommentare beim Roundtrip beibehalten möchten, sollten Sie auf jeden Fall ruamel.yaml verwenden.

Das Upgrade von @Jons Beispiel ist einfach:

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 safe_load() es sei denn, Sie haben wirklich die volle Kontrolle über die Eingabe, brauchen sie (selten der Fall) und wissen, was Sie tun.

Wenn Sie pathlib verwenden Path Zum Bearbeiten von Dateien verwenden Sie besser die neue API, die ruamel.yaml bietet:

from ruamel.yaml import YAML
from pathlib import Path

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

Question 5

Installieren Sie zuerst pyyaml mit pip3.

Importieren Sie dann das yaml-Modul 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“.

Question 6

Beispiel:

defaults.yaml

url: https://www.google.com

Umgebung.py

from ruamel import yaml

data = yaml.safe_load(open('defaults.yaml'))
data['url']

Question 7

So greifen Sie auf ein beliebiges Element einer Liste in einer YAML-Datei zu:

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'])

Question 8

ich benutze ruamel.yaml. ~~Details & Debatte hier~~.

from ruamel import yaml

with open(filename, 'r') as fp:
    read_data = yaml.load(fp)

Benutzung von ruamel.yaml ist (mit einigen einfach lösbaren Problemen) mit alten Verwendungen von PyYAML kompatibel und kann, wie in dem von mir bereitgestellten Link angegeben, verwendet werden

from ruamel import yaml

Anstatt von

import yaml

und es wird die meisten Ihrer Probleme beheben.

BEARBEITEN: PyYAML ist nicht tot, wie sich herausstellt, es wird nur an einem anderen Ort gepflegt.