YAML - YAML

YAML (а рекурсивный акроним для "YAML Ain't Markup Language") является человек читаемый язык сериализации данных. Обычно используется для файлы конфигурации и в приложениях, где данные хранятся или передаются. YAML нацелен на многие из тех же коммуникационных приложений, что и расширяемый язык разметки (XML), но имеет минимальный синтаксис, который намеренно отличается от SGML.^[1] Он использует оба Python отступ в стиле для обозначения вложенности и более компактный формат, использующий [...] для списков и {...} для карт^[1] создание YAML 1.2 a суперсет из JSON.^[2]

Разрешены пользовательские типы данных, но YAML кодирует изначально скаляры (Такие как струны, целые числа, и поплавки ), списки, и ассоциативные массивы (также известные как карты, словари или хеши). Эти типы данных основаны на Perl язык программирования, хотя все обычно используемые языки программирования высокого уровня имеют очень похожие концепции.^{[нужна цитата ]} Синтаксис с центром в двоеточии, используемый для выражения пары ключ-значение, вдохновлен электронная почта заголовки, как определено в RFC  822, а разделитель документов --- заимствовано из MIME (RFC  2046 ). Последовательности выхода повторно используются из C, а перенос пробелов для многострочных строк вдохновлен HTML. Списки и хэши могут содержать вложенные списки и хэши, образующие древовидная структура; произвольный графики могут быть представлены с использованием псевдонимов YAML (аналогично XML в МЫЛО ).^[1] YAML предназначен для чтения и записи в потоках, функция вдохновлена SAX.^[1]

Поддержка чтения и записи YAML доступна для многих языков программирования.^[3] Некоторые редакторы исходного кода, такие как Emacs^[4] и различные интегрированные среды разработки^[5][6][7] есть функции, которые упрощают редактирование YAML, такие как сворачивание вложенных структур или автоматическое выделение синтаксических ошибок.

Чиновник рекомендовал расширение имени файла для файлов YAML был .yaml^[8] с 2006 года.^[9]

История и название

YAML (/ˈjæмəl/, рифмуется с верблюд^[2]) был впервые предложен Кларком Эвансом в 2001 году,^[10] кто разработал его вместе с Ingy döt Net^[11] и Орен Бен-Кики.^[11] Первоначально YAML означал Еще один язык разметки,^[12] ссылаясь на его цель как на язык разметки с еще один построить, но затем он был перепрофилирован как YAML - это не язык разметки, а рекурсивный акроним, чтобы определить его цель как ориентированную на данные, а не на разметку документа.

Дизайн

Эта секция написано как руководство или путеводитель. Пожалуйста помоги переписать этот раздел из описательного, нейтральная точка зрения, и удалите совет или инструкцию. (Август 2016 г.) (Узнайте, как и когда удалить этот шаблон сообщения)

Синтаксис

Шпаргалка и полная спецификация доступны на официальном сайте.^[13] Ниже приводится краткое изложение основных элементов.

YAML принимает весь набор символов Unicode, за исключением некоторых управляющие символы, и может быть закодирован в UTF-8, UTF-16 и UTF-32. (Хотя UTF-32 не является обязательным, синтаксический анализатор должен иметь JSON совместимость.)^[14]

• Пробел отступ используется для обозначения структуры; тем не мение, символы табуляции не допускаются как часть отступа.
• Комментарии начинаются с числовой знак (#), может начинаться в любом месте строки и продолжаться до конца строки. Комментарии должны быть отделены от других токенов пробелами.^[15] Если внутри строки появляется # символа, то это знак числа (#) литералы.
• Члены списка обозначаются ведущей дефис (-) с одним членом в строке.
  • Список также можно указать, заключив текст в квадратных скобках ([...]) с каждой записью, разделенной запятые.
• Запись ассоциативного массива представлена ​​с использованием двоеточие Космос в виде ключ: значение с одной записью в строке. YAML требует, чтобы после двоеточия был пробел, чтобы скалярные значения, такие как http://www.wikipedia.org обычно могут быть представлены без необходимости заключать их в кавычки.
  • А вопросительный знак может использоваться перед ключом в форме «? ключ: значение», чтобы ключ мог содержать дефисы, квадратные скобки и т. д. без кавычек.
  • Ассоциативный массив также можно указать с помощью текста, заключенного в Фигурные скобки ({...}), где ключи отделяются от значений двоеточием, а записи разделяются запятыми (пробелы не требуются для совместимости с JSON).
• Струны (скаляры ) обычно не цитируются, но могут быть заключены в двойные кавычки ("), или же одинарные кавычки (').
  • В двойных кавычках специальные символы могут быть представлены с помощью C-стиль escape-последовательности, начинающиеся с обратная косая черта (\). Согласно документации, поддерживается только восьмеричный escape-код. \0.
• Блочные скаляры разделяются отступ с необязательными модификаторами для сохранения (|) или свернуть (>) новые строки.
• Несколько документов в одном потоке разделяются тремя дефисы (---).
  • Три периоды (...) необязательно завершать документ в потоке.
• Повторяющиеся узлы изначально обозначаются значком амперсанд (&) и после этого упоминается звездочка (*).
• Узлы могут быть помечены типом или тегом с помощью восклицательный знак (!!), за которым следует строка, которая может быть расширена до URI.
• Документам YAML в потоке могут предшествовать «директивы», состоящие из знак процента (%), за которым следует имя и параметры, разделенные пробелами. В YAML 1.1 определены две директивы:
  • Директива% YAML используется для определения версии YAML в данном документе.
  • Директива% TAG используется как ярлык для префиксов URI. Эти ярлыки затем можно использовать в тегах типов узлов.

Два дополнительных сигил символы зарезервированы в YAML для возможной будущей спецификации: в знак (@) и обратная кавычка (`).

Основные компоненты

YAML предлагает "встроенный" стиль для обозначения ассоциативных массивов и списков. Вот образец компонентов.

В обычном блочном формате для начала нового элемента в списке используется дефис + пробел.

--- # Любимые фильмы- Касабланка- Север на северо-запад- Человек, которого там не было

Необязательный встроенный формат разделяется запятой + пробел и заключен в квадратные скобки (аналогично JSON ).^[16]

--- # Список покупок[молоко, тыквенный пирог, яйца, сок]

Ключи отделяются от значений двоеточием + пробелом. Блоки с отступом, обычно используемые в файлах данных YAML, используют отступ и новые строки для разделения пар ключ / значение. Встроенные блоки, распространенные в потоках данных YAML, используют запятую + пробел для разделения пар ключ / значение между фигурными скобками.

--- # Блок с отступом  имя: Джон Смит  возраст: 33--- # Встроенный блок{имя: Джон Смит, возраст: 33}

Строки не требуют кавычек. Есть два способа записать многострочные строки: один с сохранением новой строки (используя | символ) и тот, который сворачивает новые строки (используя > символ), за которыми следует символ новой строки.

данные: |   Жил когда-то высокий мужчина из Илинга   Кто сел на автобус в Дарджилинг       Он сказал на двери       "Пожалуйста, не садись на пол"   Поэтому он осторожно сел на потолок

По умолчанию начальный отступ (первой строки) и конечный пробел удаляются, хотя можно явно указать другое поведение.

данные: >   Перенесенный текст   будет сложен   в один   пункт   Пустые строки обозначают   разрывы абзацев

Сложенный текст преобразует символы новой строки в пробелы и удаляет ведущие пробелы.

--- # Кузнецы- {имя: Джон Смит, возраст: 33}- имя: Мэри Смит  возраст: 27- [имя, возраст]: [Рэй Смит, 4]   Поддерживаются # последовательности ключей--- # Люди, по полулюди: [Джон Смит, Билл Джонс]женщины:  - Мэри Смит  - Сьюзан Уильямс

Объекты и списки являются важными компонентами yaml и могут быть смешаны. Первый пример - это список объектов "ключ-значение", все люди из семьи Смит. Второй перечисляет их по полу; это объект "ключ-значение", содержащий два списка.

Расширенные компоненты

Две особенности, которые отличают YAML от возможностей других языков сериализации данных, - это структуры.^[17] и набор данных.

Структуры YAML позволяют хранить несколько документов в одном файле, использовать ссылки для повторяющихся узлов и использовать произвольные узлы в качестве ключей.^[17]

Для ясности, компактности и исключения ошибок ввода данных YAML предоставляет привязки узлов (используя &) и ссылки (используя *). Ссылки на якорь работают для всех типов данных (см. Ссылку на отправку в приведенном ниже примере).

Ниже приведен пример очереди в секвенсоре инструментов, в которой два шага повторно используются повторно, но каждый раз полностью не описываются.

--- # Протоколы секвенсора для лазерной хирургии глаза- шаг:  & id001                  # определяет метку привязки & id001    инструмент:      Lasik 2000    PulseEnergy:     5.4    длительность импульса:   12    репетиция:      1000    Размер пятна:        1мм- шаг: & id002    инструмент:      Lasik 2000    PulseEnergy:     5.0    длительность импульса:   10    репетиция:      500    Размер пятна:        2мм- шаг: * id001                   # относится к первому шагу (с привязкой и id001)- шаг: * id002                   # относится ко второму шагу- шаг: * id002

Явная типизация данных редко встречается в большинстве документов YAML, поскольку YAML автоматически определяет простые типы. Типы данных можно разделить на три категории: основные, определенные и определяемые пользователем. Core - это те, которые, как ожидается, будут присутствовать в любом парсере (например, с плавающей запятой, целыми числами, строками, списками, картами, ...). Многие более сложные типы данных, такие как двоичные данные, определены в спецификации YAML, но поддерживаются не во всех реализациях. Наконец, YAML определяет способ расширения определений типов данных локально, чтобы приспособить определяемые пользователем классы, структуры или примитивы (например, числа с плавающей точкой с точностью до четырех).

YAML автоматически определяет тип данных объекта, но иногда нужно явно указать тип данных. Наиболее распространенная ситуация - когда строка из одного слова, которая выглядит как число, логическое значение или тег, требует устранения неоднозначности путем заключения ее в кавычки или использования явного тега типа данных.

---а: 123                     # целое числоб: "123"                   # строка, различаемая кавычкамиc: 123.0                   # поплавокd: !!плавать 123             # также с плавающей точкой через явный тип данных с префиксом (!!)е: !! ул 123               # строка, неоднозначная по явному типуж: !! ул да               # строка с явным типомграмм: да                     # логическое True (yaml1.1), строка "Yes" (yaml1.2)час: Да у нас нет бананов  # строка "Да" и "Нет", неоднозначная по контексту.

Не каждая реализация YAML имеет каждый тип данных, определенный спецификацией. Эти встроенные типы используют префикс сигил с двойным восклицательным знаком (!!). Особо интересными, не показанными здесь, являются наборы, упорядоченные карты, временные метки и шестнадцатеричные числа. Вот пример base64 -кодированные двоичные данные.

---рисунок: !! двоичный |  R0lGODdhDQAIAIAAAAAAANn  Z2SwAAAAADQAIAAACF4SDGQ  ar3xxbJ9p0qa7R0YxwzaFME  1IAAD =

Многие реализации YAML могут поддерживать определяемые пользователем типы данных для сериализации объектов. Локальные типы данных не являются универсальными типами данных, но определяются в приложении с помощью библиотеки синтаксического анализатора YAML. Для локальных типов данных используется один восклицательный знак (!).

---myObject:  !мой класс { имя: Джо, возраст: 15 }

Пример

Иерархия структуры данных поддерживается за счет отступов контура.

---квитанция:     Счет за покупку Oz-WareДата:        2012-08-06покупатель:    имя:   Дороти    фамилия:  ГейлПредметы:    - part_no:   A4786      описать:   Ведро для воды (заполненное)      цена:     1.47      количество:  4    - part_no:   E1628      описать:   Тапочки "Рубиновые" на высоком каблуке      размер:      8      цена:     133.7      количество:  1Законопроект о:  & id001    улица: |            123 Аллея Торнадо            Люкс 16    город:   East Centerville    государственный:  KSкорабль:  * id001специальная доставка:  >    Следуй за желтым кирпичом    Дорога в Изумрудный город.    Не обращайте внимания на    человек за занавеской....

Обратите внимание, что строки не требуют заключения в кавычки. Конкретное количество пробелов в отступе не имеет значения, пока параллельные элементы имеют одинаковое выравнивание по левому краю, а иерархически вложенные элементы имеют больший отступ. Этот образец документа определяет ассоциативный массив с 7 ключами верхнего уровня: один из ключей, «items», содержит список из 2 элементов, каждый элемент которого сам является ассоциативным массивом с разными ключами. Отображаются реляционные данные и удаление избыточности: содержимое ассоциативного массива «получатель» копируется из содержимого ассоциативного массива «получатель счета», как указано привязкой (&) и ссылка (*) этикетки. Для удобства чтения можно добавить дополнительные пустые строки. В одном файле / потоке могут существовать несколько документов, разделенных символом ---. Необязательный ... может использоваться в конце файла (полезно для сигнализации об окончании потоковой передачи без закрытия канала).

Функции

Разделение с отступом

Поскольку YAML в первую очередь полагается на отступ контура для структуры, он особенно устойчив к коллизия разделителей. Нечувствительность YAML к кавычкам и фигурным скобкам в скалярных значениях означает, что можно встраивать документы XML, JSON или даже YAML в документ YAML, просто сделав отступ в литерале блока (используя | или же >):

---пример: >        HTML переходит в YAML без измененийсообщение: |        <blockquote style="font: italic 1em serif">        
 "Три всегда больше двух,           даже для больших значений в два дюйма         <p>--Author Unknown</p>        </blockquote>Дата: 2007-06-01

YAML может быть помещен в JSON, заключив в кавычки и исключив все внутренние кавычки. YAML может быть помещен в XML путем экранирования зарезервированных символов (<, >, &, ', ") и преобразовывая пробелы, или помещая его в CDATA раздел.

Неиерархические модели данных

В отличие от JSON, который может представлять данные только в иерархической модели с каждым дочерним узлом, имеющим единственного родителя, YAML также предлагает простую реляционную схему, которая позволяет ссылаться на повторяющиеся идентичные данные из двух или более точек в дереве, а не вводить избыточно в эти точки. Это похоже на средство IDREF, встроенное в XML.^[18] Затем синтаксический анализатор YAML расширяет эти ссылки в полностью заполненные структуры данных, которые они подразумевают при чтении, поэтому любая программа, использующая синтаксический анализатор, не должна знать о реляционной модели кодирования, в отличие от процессоров XML, которые не расширяют ссылки. Это расширение может улучшить удобочитаемость, уменьшив количество ошибок ввода данных в файлах конфигурации или протоколах обработки, где многие параметры остаются неизменными в последовательной серии записей, в то время как только некоторые изменяются. Примером может служить то, что записи «получатель» и «получатель счета» в счете-фактуре почти всегда являются одними и теми же данными.

Практические соображения

YAML ориентирован на строки, и поэтому часто бывает просто преобразовать неструктурированный вывод существующих программ в формат YAML, сохранив большую часть внешнего вида исходного документа. Поскольку нет закрывающих тегов, фигурных скобок или кавычек для балансировки, обычно легко сгенерировать правильно сформированный YAML непосредственно из распределенных операторов печати в простых программах. Точно так же разделители пробелов облегчают быструю и грязную фильтрацию файлов YAML с помощью строчно-ориентированных команд в grep, AWK, Perl, Ruby и Python.

В частности, в отличие от языков разметки, фрагменты последовательных строк YAML, как правило, сами являются правильно сформированными документами YAML. Это позволяет очень легко писать парсеры, которым не нужно полностью обрабатывать документ (например, балансировать открывающие и закрывающие теги и перемещаться по кавычкам и экранированным символам) до того, как они начнут извлекать определенные записи внутри. Это свойство особенно целесообразно при итерации за один проход без сохранения состояния по записям в файле, вся структура данных которого слишком велика для хранения в памяти, или для которых восстановление всей структуры для извлечения одного элемента было бы чрезмерно дорогостоящим.

Как ни странно, хотя его разделение с отступом может показаться усложнением глубоко вложенных иерархий, YAML обрабатывает отступы размером с один пробел, и это может обеспечить лучшее сжатие, чем языки разметки. Кроме того, очень глубоких отступов можно полностью избежать: 1) вернуться к «встроенному стилю» (т.е. формату, подобному JSON) без отступов; или 2) использование реляционных якорей, чтобы развернуть иерархию до плоской формы, которую синтаксический анализатор YAML прозрачно воссоздает в полную структуру данных.^{[нужна цитата ]}

Безопасность

YAML - это чисто язык представления данных и поэтому не имеет исполняемых команд.^[19] Пока Проверка и безопасный разбор по своей сути возможно на любом языке данных, реализация является настолько печально известной ловушкой, что отсутствие в YAML связанного командного языка может быть относительным преимуществом безопасности.

Однако YAML допускает языковые теги, так что произвольные локальные объекты могут быть созданы парсером, который поддерживает эти теги. Любой синтаксический анализатор YAML, который позволяет выполнять сложные экземпляры объектов, открывает возможность для атаки путем внедрения. Парсеры Perl, позволяющие загружать объекты произвольных классов, создают так называемые «благословенные» значения. Использование этих значений может вызвать неожиданное поведение, например если в классе используются перегруженные операторы. Это может привести к выполнению произвольного кода Perl.^{[нужна цитата ]}

Аналогичная ситуация и для парсеров Python или Ruby. Согласно документации PyYAML:^[20]

Обратите внимание, что возможность создания произвольного объекта Python может быть опасной, если вы получаете документ YAML из ненадежного источника, такого как Интернет. Функция yaml.safe_load ограничивает эту возможность простыми объектами Python, такими как целые числа или списки. [...]

PyYAML позволяет создавать объект Python любого типа. Даже экземпляры классов Python могут быть созданы с помощью !! питон / объект тег.

Обработка и представление данных

Спецификация YAML определяет экземплярный документ как «презентация» или «символьный поток».^[21] Первичные логические структуры в документе экземпляра YAML - это скаляры, последовательности и отображения.^[22] Спецификация YAML также указывает некоторые основные ограничения, которые применяются к этим первичным логическим структурам. Например, согласно спецификации, ключи отображения не имеют порядка. В каждом случае, когда порядок узлов имеет значение, необходимо использовать последовательность.^[23]

Более того, при определении соответствия для процессоров YAML спецификация YAML определяет две основные операции: свалка и нагрузка. Все YAML-совместимые процессоры должны предоставлять по меньшей мере одна из этих операций, а при необходимости может предоставить обе.^[24] Наконец, спецификация YAML определяет информационная модель или "граф представления", который должен быть создан во время обработки для обоих свалка и нагрузка операций, хотя это представление не обязательно должно быть доступно пользователю через API.^[25]

Сравнение с другими форматами сериализации

Сравнение с JSON

JSON синтаксис является основой YAML версии 1.2, которая была обнародована с явной целью приведения YAML «в соответствие с JSON в качестве официального подмножества».^[2] Хотя предыдущие версии YAML не были полностью совместимы,^[26] расхождения редко были заметны, и большинство документов JSON можно проанализировать некоторыми парсерами YAML, такими как Syck.^[27] Это потому, что семантическая структура JSON эквивалентна необязательному «встроенному стилю» написания YAML. Хотя расширенные иерархии могут быть написаны во встроенном стиле, таком как JSON, это не рекомендуемый стиль YAML, за исключением случаев, когда он способствует ясности.

YAML имеет множество дополнительных функций, которых не хватает в JSON, включая комментарии, расширяемые типы данных, реляционные привязки, строки без кавычек и типы сопоставления, сохраняющие порядок ключей.

Сравнение с TOML

С одной стороны, YAML намного сложнее по сравнению с TOML - было указано, что спецификация YAML содержит 23 449 слов, тогда как спецификация TOML содержит только 3339 слов.^[28]. С другой стороны, YAML менее подробный, более СУХИЙ, синтаксически менее шумный, а иерархия документа очевидна по отступам.^[29].

Сравнение с XML

В YAML отсутствует понятие атрибутов тегов, которые можно найти в XML. Вместо этого YAML имеет расширяемые объявления типов (включая типы классов для объектов).

Сам YAML не имеет определяемых языком дескрипторов схемы документа XML, которые позволяют, например, самопроверку документа. Однако для YAML существует несколько внешне определенных языков дескрипторов схемы (например, Доктрина, Квалифы и Rx), которые выполняют эту роль. Более того, семантика, предоставляемая объявлениями типов, определяемых языком YAML, в самом документе YAML часто снижает потребность в валидаторе в простых, распространенных ситуациях. Кроме того, YAXML, который представляет структуры данных YAML в XML, позволяет импортировать схемы XML и механизмы вывода, такие как XSLT для применения к YAML.

Программное обеспечение (эмиттеры и парсеры)

Для фиксированных структур данных файлы YAML можно просто сгенерировать с помощью Распечатать Команды, которые записывают как данные, так и специфическое украшение YAML. Однако для выгрузки различных или сложных иерархических данных специальный YAML излучатель предпочтительнее. Точно так же простые файлы YAML (например, пары ключ-значение) легко анализируются с помощью регулярных выражений. Для более сложных или разнообразных структур данных используется формальный YAML парсер Рекомендовано.

Эмиттеры и парсеры YAML существуют для многих популярных языков. Большинство из них написано на самом родном языке. Некоторые из них являются языковыми привязками библиотеки C либьямл; они могут бежать быстрее. Раньше была еще одна библиотека C, называемая Syck, написанный и осиротевший почему счастливчик: он не поддерживается, отсутствует комплект авторитетных источников, и веб-сайт был взломан. Следовательно, единственная рекомендуемая библиотека C - либьямл. Первоначально он был разработан Кириллом Симоновым. В 2018 году разработку возобновили новые сопровождающие Ян Кордаско и Ingy döt Net.^[30]

Программисты C ++ могут выбирать между библиотекой C либьямл и библиотека C ++ libyaml-cpp. Оба имеют полностью независимые кодовые базы и совершенно разные API. Библиотека libyaml-cpp по-прежнему имеет основной номер версии 0, что указывает на то, что API может измениться в любой момент, как это действительно произошло после версии 0.3. Существует реализация, ориентированная на грамматику, написанная на C # с целью расширения вложенных элементов.^[31]

Некоторые реализации YAML, такие как Perl YAML.pm, загружают весь файл (поток) и анализируют его. в массовом порядке. Другие реализации, такие как PyYaml, ленивы и перебирают следующий документ только по запросу. Для очень больших файлов, в которых планируется обрабатывать документы независимо, создание экземпляра всего файла перед обработкой может быть недопустимым. Таким образом, в YAML.pm иногда нужно разбивать файл на документы и анализировать их по отдельности. YAML упрощает это, поскольку для этого просто требуется разделение маркера конца документа, который определяется как три точки в отдельной строке. Этот маркер запрещен по содержанию.^[32]

Критика

YAML критиковали за значительный пробел, сбивающие с толку функции, небезопасные значения по умолчанию и его сложная и неоднозначная спецификация:^[28][33][34]

• Файлы конфигурации могут выполнять команды или загружать содержимое, даже если пользователи этого не осознают.^[28]
• Редактировать большие файлы YAML сложно, так как ошибки отступа могут остаться незамеченными.^[28]
• Автоопределение типа является источником ошибок. Например, без кавычек да и НЕТ преобразуются в логические значения, номера версий программного обеспечения могут быть преобразованы в числа с плавающей запятой.^[28][35]
• Усеченные файлы часто интерпретируются как допустимый YAML из-за отсутствия терминаторов.
• Сложность стандарта привела к противоречивым реализациям и сделало язык непереносимым.^[28][36]

Предполагаемые недостатки и сложность YAML привели к появлению StrictYAML, который использует ограниченное подмножество спецификации YAML.^[35]

Смотрите также

• Сравнение форматов сериализации данных
• Легкий язык разметки

Рекомендации

внешняя ссылка

• Официальный веб-сайт