Comment puis-je analyser un fichier YAML en Python

Comment analyser un fichier YAML en Python?

La méthode la plus simple et la plus pure sans compter sur les en-têtes C est PyYaml ( documentation ), qui peut être installée via pip install pyyaml:

#!/usr/bin/env python

import yaml
import json

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

Et c'est tout. Une yaml.load()fonction simple existe également, mais yaml.safe_load()devrait toujours être préférée, sauf si vous avez explicitement besoin de la sérialisation / désérialisation arbitraire d'objet fournie afin d'éviter d'introduire la possibilité d'exécution de code arbitraire.

Notez que le projet PyYaml prend en charge les versions jusqu'à la spécification YAML 1.1 . Si la prise en charge de la spécification YAML 1.2 est nécessaire, voir ruamel.yaml comme indiqué dans cette réponse .

Lire et écrire des fichiers YAML avec Python 2 + 3 (et 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)

Fichier YAML créé

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

Terminaisons de fichiers communes

.yml et .yaml

Alternatives

• CSV: format super simple ( lecture et écriture )
• JSON: agréable pour écrire des données lisibles par l'homme; TRÈS couramment utilisé ( lecture et écriture )
• YAML: YAML est un sur-ensemble de JSON, mais plus facile à lire ( lecture et écriture , comparaison de JSON et YAML )
• pickle: un format de sérialisation Python ( lecture et écriture )
• MessagePack ( package Python ): représentation plus compacte ( lecture et écriture )
• HDF5 ( package Python ): idéal pour les matrices ( lecture et écriture )
• XML: existe aussi * soupir * ( lecture et écriture )

Pour votre application, les éléments suivants peuvent être importants:

• Prise en charge par d'autres langages de programmation
• Lecture / écriture
• Compacité (taille du fichier)

Voir aussi: Comparaison des formats de sérialisation des données

Dans le cas où vous cherchez plutôt un moyen de créer des fichiers de configuration, vous voudrez peut-être lire mon court article Fichiers de configuration en Python

Si vous avez YAML conforme à la spécification YAML 1.2 (publiée en 2009), vous devez utiliser ruamel.yaml (avertissement: je suis l'auteur de ce package). Il s'agit essentiellement d'un sur-ensemble de PyYAML, qui prend en charge la plupart de YAML 1.1 (à partir de 2005).

Si vous voulez pouvoir conserver vos commentaires lors d'un aller-retour, vous devez certainement utiliser ruamel.yaml.

La mise à niveau de l'exemple de @ Jon est simple:

import ruamel.yaml as yaml

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

À utiliser safe_load()sauf si vous avez vraiment un contrôle total sur l'entrée, en avez besoin (rarement le cas) et savez ce que vous faites.

Si vous utilisez pathlib Pathpour manipuler des fichiers, il vaut mieux utiliser la nouvelle API ruamel.yaml fournit:

from ruamel.yaml import YAML
from pathlib import Path

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

Installez d'abord pyyaml ​​à l'aide de pip3.

Importez ensuite le module yaml et chargez le fichier dans un dictionnaire appelé 'my_dict':

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

C'est tout ce dont vous avez besoin. Maintenant, le fichier yaml entier est dans le dictionnaire 'my_dict'.

Exemple:

defaults.yaml

url: https://www.google.com

environment.py

from ruamel import yaml

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

J'utilise ruamel.yaml . Détails et débat ici .

from ruamel import yaml

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

L'utilisation de ruamel.yaml est compatible (avec quelques problèmes simples résolubles) avec les anciennes utilisations de PyYAML et comme il est indiqué dans le lien que j'ai fourni, utilisez

from ruamel import yaml

au lieu de

import yaml

et cela résoudra la plupart de vos problèmes.

EDIT : PyYAML n'est pas mort comme il se trouve, il est juste maintenu dans un endroit différent.

#!/usr/bin/env python

import sys
import yaml

def main(argv):

    with open(argv[0]) as stream:
        try:
            #print(yaml.load(stream))
            return 0
        except yaml.YAMLError as exc:
            print(exc)
            return 1

if __name__ == "__main__":
    sys.exit(main(sys.argv[1:]))