Як я можу розібрати YAML-файл у Python

Як я можу розібрати YAML-файл у Python?

Найпростіший і найчистіший метод, не покладаючись на заголовки C, - це PyYaml ( документація ), яку можна встановити за допомогою 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)

І це все. Проста yaml.load()функція також існує, але yaml.safe_load()завжди слід віддати перевагу, якщо вам явно не потрібна довільна серіалізація / десеріалізація об'єкта, що надається, щоб уникнути можливості здійснення довільного виконання коду.

Зверніть увагу, що проект PyYaml підтримує версії, створені за допомогою специфікації YAML 1.1 . Якщо потрібна підтримка специфікації YAML 1.2 , див. Ruamel.yaml, як зазначено у цій відповіді .

Читання та запис файлів YAML з Python 2 + 3 (та 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

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

Загальні закінчення файлів

.yml і .yaml

Альтернативи

• CSV: надзвичайно простий формат ( читання та запис )
• JSON: приємно для написання даних, прочитаних людиною ДУЖЕ часто використовується ( читати та писати )
• YAML: YAML - це сукупність JSON, але простіша для читання ( читання та запис , порівняння JSON та YAML )
• соління: формат серіалізації Python ( читання та запис )
• MessagePack ( пакет Python ): більш компактне представлення ( читання та запис )
• HDF5 ( пакет Python ): приємно для матриць ( читання та запис )
• XML: існує занадто * зітхання * ( читання та запис )

Для вашої заявки може бути важливим наступне:

• Підтримка іншими мовами програмування
• Виконання читання / письма
• Компактність (розмір файлу)

Дивіться також: Порівняння форматів серіалізації даних

Якщо ви шукаєте спосіб створення файлів конфігурації, ви можете прочитати мою коротку статтю Конфігураційні файли в Python

Якщо у вас є YAML, що відповідає специфікації YAML 1.2 (випущена 2009 р.), Тоді вам слід використовувати ruamel.yaml (відмова від відповідальності: я автор цього пакета). По суті це суперкомплект PyYAML, який підтримує більшу частину YAML 1.1 (з 2005 року).

Якщо ви хочете зберегти свої коментарі під час кругового відключення, вам неодмінно слід використовувати ruamel.yaml.

Оновити приклад Джона легко:

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()якщо ви справді не маєте повного контролю над входом, потребуєте цього (рідко справа) і знайте, що ви робите.

Якщо ви використовуєте pathlib Pathдля маніпулювання файлами, то краще використовувати новий API ruamel.yaml:

from ruamel.yaml import YAML
from pathlib import Path

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

Спочатку встановіть pyyaml ​​за допомогою pip3.

Потім імпортуйте модуль yaml і завантажте файл у словник під назвою "my_dict":

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

Це все, що вам потрібно. Тепер весь файл yaml знаходиться у словнику "my_dict".

Приклад:

defaults.yaml

url: https://www.google.com

environment.py

from ruamel import yaml

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

Я використовую ruamel.yaml . Деталі та дискусії тут .

from ruamel import yaml

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

Використання ruamel.yaml сумісне (з деякими простими розв’язуваними проблемами) зі старими звичаями PyYAML, і як зазначено у наданому посиланням, використовуйте

from ruamel import yaml

замість

import yaml

і це виправить більшість ваших проблем.

EDIT : PyYAML не мертвий, як виявляється, він просто підтримується в іншому місці.

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