Python'da bir YAML dosyasını nasıl ayrıştırabilirim

Python'da bir YAML dosyasını nasıl ayrıştırabilirim?

C başlıklarına dayanmadan en kolay ve en saf yöntem PyYaml'dir ( belgeler ) 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)

Ve bu kadar. Düz bir yaml.load()işlev de vardır, ancak yaml.safe_load()rastgele kod yürütme olasılığını getirmekten kaçınmak için açıkça keyfi nesne serileştirmesi / serileştirmesi gerekmedikçe her zaman tercih edilmelidir.

PyYaml projesinin YAML 1.1 spesifikasyonu üzerinden sürümleri desteklediğini unutmayın . Eğer YAML 1.2 spesifikasyonu destek gerekirse, bkz ruamel.yaml belirtildiği gibi bu cevap .

Python 2 + 3 (ve unicode) ile YAML dosyalarını okuma ve yazma

# -*- 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)

Oluşturulan YAML dosyası

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

Ortak dosya sonları

.yml ve .yaml

Alternatifler

• CSV: Süper basit format ( okuma ve yazma )
• JSON: İnsan tarafından okunabilir veriler yazmak için güzel; ÇOK yaygın olarak kullanılan ( okuma ve yazma )
• YAML: YAML, JSON'un bir üst kümesidir, ancak okunması daha kolaydır ( okuma ve yazma , JSON ve YAML karşılaştırması )
• turşu: Python serileştirme formatı ( okuma ve yazma )
• MessagePack ( Python paketi ): Daha kompakt gösterim ( okuma ve yazma )
• HDF5 ( Python paketi ): Matrisler için güzel ( okuma ve yazma )
• XML: çok var * iç çekme * ( okuma ve yazma )

Başvurunuz için aşağıdakiler önemli olabilir:

• Diğer programlama dillerinin desteği
• Okuma / yazma performansı
• Kompaktlık (dosya boyutu)

Ayrıca bkz: Veri serileştirme formatlarının karşılaştırılması

Yapılandırma dosyaları oluşturmanın bir yolunu arıyorsanız , Python'daki yapılandırma dosyamdaki kısa makalemi okumak isteyebilirsiniz.

YAML 1.2 şartnamesine (2009'da piyasaya sürülen) uyan YAML varsa, ruamel.yaml kullanmalısınız (feragatname: Ben bu paketin yazarıyım ). Aslında, YAML 1.1'in çoğunu (2005'ten itibaren) destekleyen PyYAML'in bir üst kümesidir.

Yuvarlak açma sırasında yorumlarınızı korumak istiyorsanız, kesinlikle ruamel.yaml kullanmalısınız.

@ Jon'un örneğini yükseltmek kolaydır:

import ruamel.yaml as yaml

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

safe_load()Giriş üzerinde tam kontrole sahip olmadığınız sürece kullanın (buna nadiren ihtiyaç duyarsınız) ve ne yaptığınızı bilin.

PathDosyaları işlemek için pathlib kullanıyorsanız, yeni ruamel.yaml API'sini kullanmak daha iyidir:

from ruamel.yaml import YAML
from pathlib import Path

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

İlk önce pip3 kullanarak pyyaml ​​yükleyin.

Ardından yaml modülünü içe aktarın ve dosyayı 'my_dict' adlı sözlüğe yükleyin:

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

Tek ihtiyacınız olan bu. Şimdi yaml dosyasının tamamı 'my_dict' sözlüğünde.

Misal:

defaults.yaml

url: https://www.google.com

environment.py

from ruamel import yaml

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

Kullandığım ruamel.yaml . Detaylar ve tartışma burada .

from ruamel import yaml

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

Kullanımı ruamel.yaml PyYAML eski kullanımlar ile (bazı basit çözülebilir sorunları olan) uyumludur ve bu, bağlantıya belirtildiği gibi, kullanımı sağlanır

from ruamel import yaml

onun yerine

import yaml

ve sorunlarınızın çoğunu çözecektir.

EDIT : PyYAML ortaya çıktığı gibi ölmedi, sadece farklı bir yerde tutulur.

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