¿Cómo puedo analizar un archivo YAML en Python?

¿Cómo puedo analizar un archivo YAML en Python?

El método más sencillo y puro sin depender de los encabezados C es PyYaml ( documentación ), que se puede instalar a través de 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)

Y eso es. yaml.load()También existe una función simple , pero yaml.safe_load()siempre debe preferirse a menos que necesite explícitamente la serialización / deserialización de objetos arbitrarios proporcionada para evitar introducir la posibilidad de ejecución de código arbitrario.

Tenga en cuenta que el proyecto PyYaml admite versiones hasta la especificación YAML 1.1 . Si se necesita compatibilidad con la especificación YAML 1.2 , consulte ruamel.yaml como se indica en esta respuesta .

Leer y escribir archivos YAML con Python 2 + 3 (y 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)

Archivo YAML creado

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

Finales de archivo comunes

.yml y .yaml

Alternativas

• CSV: formato super simple ( lectura y escritura )
• JSON: Agradable para escribir datos legibles por humanos; MUY comúnmente utilizado ( leer y escribir )
• YAML: YAML es un superconjunto de JSON, pero más fácil de leer ( leer y escribir , comparación de JSON y YAML )
• pickle: un formato de serialización de Python ( lectura y escritura )
• MessagePack ( paquete de Python ): representación más compacta ( lectura y escritura )
• HDF5 ( paquete Python ): agradable para matrices ( lectura y escritura )
• XML: existe también * suspiro * ( lectura y escritura )

Para su aplicación, lo siguiente puede ser importante:

• Soporte por otros lenguajes de programación.
• Rendimiento de lectura / escritura
• Compacidad (tamaño del archivo)

Ver también: Comparación de formatos de serialización de datos.

En caso de que esté buscando una forma de crear archivos de configuración, puede leer mi breve artículo Archivos de configuración en Python

Si tiene YAML que cumple con la especificación YAML 1.2 (lanzada en 2009), entonces debe usar ruamel.yaml (descargo de responsabilidad: soy el autor de ese paquete). Es esencialmente un superconjunto de PyYAML, que admite la mayor parte de YAML 1.1 (desde 2005).

Si desea poder conservar sus comentarios cuando realiza un viaje de ida y vuelta, debe utilizar ruamel.yaml.

Actualizar el ejemplo de @ Jon es fácil:

import ruamel.yaml as yaml

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

Úselo a safe_load()menos que realmente tenga control total sobre la entrada, la necesite (rara vez el caso) y sepa lo que está haciendo.

Si está utilizando pathlib Pathpara manipular archivos, es mejor utilizar la nueva API que ruamel.yaml proporciona:

from ruamel.yaml import YAML
from pathlib import Path

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

Primero instale pyyaml ​​usando pip3.

Luego importe el módulo yaml y cargue el archivo en un diccionario llamado 'my_dict':

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

Eso es todo lo que necesitas. Ahora todo el archivo yaml está en el diccionario 'my_dict'.

Ejemplo:

defaults.yaml

url: https://www.google.com

ambiente.py

from ruamel import yaml

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

Yo uso ruamel.yaml . Detalles y debate aquí .

from ruamel import yaml

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

El uso de ruamel.yaml es compatible (con algunos problemas solucionables simples) con los viejos usos de PyYAML y, como se indica en el enlace que proporcioné, use

from ruamel import yaml

en vez de

import yaml

y solucionará la mayoría de tus problemas.

EDITAR : PyYAML no está muerto como resultado, solo se mantiene en un lugar diferente.

#!/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:]))