Appearance
YAML: данные, которые приятно читать
JSON — формат для машин: кавычки на каждом ключе, фигурные скобки, двоеточия. Когда данные читает человек — конфиг приложения, документация, черновик — хочется тише. YAML (YAML Ain't Markup Language) делает то же, что JSON, но вложенность задаёт отступами, а кавычки часто пропускает.
Как выглядит YAML
Телефонная книга Виты:
yaml
Серёга:
city: Омск
phone: +7 900 123-45-67
Соня:
city: Москва
phone: +7 911 234-56-78
Дима:
city: Челябинск
phone: +7 922 345-67-89Правила простые:
- вложенность — по отступам (два пробела — один уровень);
- списки — через
-; - комментарии — через
#(у JSON их нет).
Подключение: pip install pyyaml
В отличие от csv и json, модуля YAML в стандартной библиотеке нет. Устанавливается библиотека pyyaml — те же pip, что и в уроке про импорт:
pip install pyyamlИмпортируется она как yaml:
py
import yamlyaml.safe_dump() — в файл, если передать открытый файл-объект; без файла — возвращает строку (как dumps у JSON):
py
import yaml
phone_book = {
'Серёга': {'city': 'Омск', 'phone': '+7 900 123-45-67'},
'Соня': {'city': 'Москва', 'phone': '+7 911 234-56-78'}
}
with open('phone_book.yaml', 'w', encoding='utf-8') as f:
yaml.safe_dump(phone_book, f, allow_unicode=True, sort_keys=False)Параметры:
allow_unicode=True— печатать кириллицу как есть, а не\uXXXX;sort_keys=False— не пересортировывать ключи по алфавиту (иначе «Дима» окажется первым).
Десериализация: yaml.safe_load
Чтение зеркальное: yaml.safe_load() принимает файл или строку — одна функция на оба случая:
py
import yaml
with open('phone_book.yaml', 'r', encoding='utf-8') as f:
phone_book = yaml.safe_load(f)
print(phone_book['Серёга']['phone']) # +7 900 123-45-67Почему именно safe_
У yaml есть «полный» yaml.load(), который умеет восстанавливать произвольные объекты Python из файла. Это значит: вредоносный YAML-файл может заставить программу выполнить чужой код. Правило простое: внешние данные читаются только через safe_load(), пишутся — только через safe_dump(). Слово safe_ здесь не украшение.
Плюсы и минусы
Плюсы:
- самый читаемый из форматов — данные и аннотации рядом;
- вложенность, списки, комментарии;
- кириллица читается как есть.
Минусы:
- нет в стандартной библиотеке — нужен
pip install pyyaml; - медленнее JSON;
- строг к отступам: табы запрещены, сдвиг на «на глазок» ломает структуру;
- безопасность только при
safe_*.
Итог
YAML — «человеческий JSON»: то же содержание, приятнее вид. Есть и четвёртый распространённый формат — XML, где всё обёрнуто в теги. Он старше JSON и живёт там, где нужна строгая структура.
Упражнения
- Убедитесь, что библиотека установлена: выполните в терминале
pip show pyyamlи напишите в комментарии версию. Затем напечатайте, что вернётyaml.safe_dump(), если передать в него словарь без файла-аргумента.
py
import yaml
# допишите код ниже- Сохраните телефонную книгу Виты в
phone_book.yamlсallow_unicode=Trueиsort_keys=False. Прочитайте файл обратно и напечатайте телефон Сони.
py
import yaml
phone_book = {
'Серёга': {'city': 'Омск', 'phone': '+7 900 123-45-67'},
'Соня': {'city': 'Москва', 'phone': '+7 911 234-56-78'},
'Дима': {'city': 'Челябинск', 'phone': '+7 922 345-67-89'}
}
# допишите код ниже- Напишите YAML-строку со списком сериалов Виты, где у каждого сериала есть
titleиyear. Прочитайте её черезyaml.safe_load()и напечатайте первый элемент списка.
py
import yaml
# допишите код ниже- Запишите в YAML-файл словарь, а рядом, в комментарии к коду, покажите, как в YAML-файле выглядит тот же словарь с комментариями
#(JSON это не умеет). Почему для конфигов это важно?
py
import yaml
# допишите код ниже- Сравните форматы: возьмите одну и ту же телефонную книгу, сохраните её в
book.jsonиbook.yaml. Напечатайте длину обоих файлов в байтах и в комментарии объясните, что компактнее и почему.
py
import json
import yaml
import os
phone_book = {
'Серёга': {'city': 'Омск', 'phone': '+7 900 123-45-67'},
'Соня': {'city': 'Москва', 'phone': '+7 911 234-56-78'}
}
# допишите код ниже- Друзья прислали вам YAML-файл с «настройками». Напишите программу, которая читает его только через
safe_load(), и в комментарии объясните, что было бы, если применитьyaml.load()к чужому файлу.
py
import yaml
# допишите код ниже