Como posso analisar um arquivo YAML em Python

Como posso analisar um arquivo YAML no Python?

O método mais fácil e puro, sem depender dos cabeçalhos C, é o PyYaml ( documentação ), que pode ser instalado 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)

E é isso. Uma yaml.load()função simples também existe, mas yaml.safe_load()sempre deve ser preferida, a menos que você precise explicitamente da serialização / desserialização arbitrária de objetos fornecida para evitar a introdução da possibilidade de execução arbitrária de código.

Observe que o projeto PyYaml suporta versões através da especificação YAML 1.1 . Se o suporte à especificação YAML 1.2 for necessário, consulte ruamel.yaml, conforme observado nesta resposta .

Ler e gravar arquivos YAML com Python 2 + 3 (e 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)

Arquivo YAML criado

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

Finais de arquivos comuns

.yml e .yaml

Alternativas

• CSV: formato super simples ( leitura e gravação )
• JSON: Bom para escrever dados legíveis por humanos; MUITO comumente usado ( leitura e gravação )
• YAML: YAML é um superconjunto de JSON, mas mais fácil de ler ( leitura e gravação , comparação de JSON e YAML )
• pickle: um formato de serialização Python ( leitura e gravação )
• MessagePack ( pacote Python ): representação mais compacta ( leitura e gravação )
• HDF5 ( pacote Python ): Agradável para matrizes ( leitura e gravação )
• XML: existe também * suspiro * ( leitura e gravação )

Para seu aplicativo, o seguinte pode ser importante:

• Suporte por outras linguagens de programação
• Desempenho de leitura / escrita
• Compacidade (tamanho do arquivo)

Consulte também: Comparação de formatos de serialização de dados

Caso você esteja procurando uma maneira de criar arquivos de configuração, leia meu pequeno artigo Arquivos de configuração em Python

Se você possui o YAML que está em conformidade com a especificação YAML 1.2 (lançada em 2009), use ruamel.yaml (isenção de responsabilidade: sou o autor desse pacote). É essencialmente um superconjunto do PyYAML, que suporta a maior parte do YAML 1.1 (de 2005).

Se você quiser preservar seus comentários ao percorrer o caminho, certamente deve usar o ruamel.yaml.

A atualização do exemplo de Jon é 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)

Use a safe_load()menos que você realmente tenha controle total sobre a entrada, precise dela (raramente é o caso) e saiba o que está fazendo.

Se você estiver usando o pathlib Pathpara manipular arquivos, é melhor usar a nova API que o ruamel.yaml fornece:

from ruamel.yaml import YAML
from pathlib import Path

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

Primeiro instale o pyyaml ​​usando o pip3.

Em seguida, importe o módulo yaml e carregue o arquivo em um dicionário chamado 'my_dict':

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

É tudo o que você precisa. Agora, o arquivo yaml inteiro está no dicionário 'my_dict'.

Exemplo:

defaults.yaml

url: https://www.google.com

environment.py

from ruamel import yaml

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

Eu uso ruamel.yaml . Detalhes e debate aqui .

from ruamel import yaml

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

O uso do ruamel.yaml é compatível (com alguns problemas simples solucionáveis) com os usos antigos do PyYAML e, conforme indicado no link fornecido, use

from ruamel import yaml

ao invés de

import yaml

e corrigirá a maioria dos seus problemas.

EDIT : PyYAML não está morto como se vê, apenas é mantido em um 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:]))