YAML

Материал из Википедии — свободной энциклопедии
Перейти к навигации Перейти к поиску
YAML
YAML Logo.svg
Расширение .yaml или .yml
MIME-тип application/x-yaml[1][2], text/yaml[3][2] и text/x-yaml[4]
Разработчик Кларк Эванс[d]
Опубликован 11 мая 2001[5]
Последний выпуск 1.2 (Third Edition) (1 октября 2009; 11 лет назад (2009-10-01))
Тип формата Обмен данными
Расширен из XML, Perl и JSON
Открытый формат? Да
Сайт yaml.org​ (англ.)

YAML (акроним англ.  «Yet Another Markup Language» — «Ещё один язык разметки», позже — рекурсивный акроним англ. «YAML Ain't Markup Language» — «YAML — не язык разметки») — «дружественный» формат сериализации данных, концептуально близкий к языкам разметки, но ориентированный на удобство ввода-вывода типичных структур данных многих языков программирования.

В трактовке названия отражена история развития: на ранних этапах YAML расшифровывался как Yet Another Markup Language («Ещё один язык разметки») и даже позиционировался как конкурент XML, но позже был переименован с целью акцентировать внимание на данных, а не на разметке документов[6].

Цели создания[править | править код]

Согласно целям, озвученным Кларком Эвансом (англ. Clark Evans), YAML 1.0 призван[7]:

  1. быть понятным человеку;
  2. поддерживать структуры данных, родные для языков программирования;
  3. быть переносимым между языками программирования;
  4. использовать цельную модель данных для поддержки обычного инструментария;
  5. поддерживать потоковую обработку;
  6. быть выразительным и расширяемым;
  7. быть лёгким в реализации и использовании;

К текущей редакции YAML (1.2) в эти цели были внесены некоторые изменения[8]:

  • пункты 2 и 3 поменялись местами
  • пункт 5 был заменен на «YAML поддерживает обработку в один проход»

Синтаксис[править | править код]

Синтаксис YAML минималистичен, особенно по сравнению с XML-синтаксисом. В спецификации указывают, что большое влияние оказал стандарт RFC 822. Ниже приведены образцы различных компонентов разметки. Следует заметить, что наличие варианта записи в однострочном формате делает JSON допустимым подмножеством YAML.

Последовательности[править | править код]

 --- # Список фильмов: последовательность в блочном формате
 - Casablanca
 - Spellbound
 - Notorious
 --- # Список покупок: последовательность в однострочном формате
 [milk, bread, eggs, juice]

Сопоставления имени и значения[править | править код]

 --- # Блочный формат
 name: John Smith
 age: 33
 --- # Однострочный формат
 {name: John Smith, age: 33}

Блочные литералы[править | править код]

Переводы строк сохраняются[править | править код]

 --- |
   There was a young fellow of Warwick
   Who had reason for feeling euphoric
       For he could, by election
       Have triune erection
   Ionic, Corinthian, and Doric

Переводы строк исчезают[править | править код]

 --- >
   Wrapped text
   will be folded
   into a single
   paragraph
   
   Blank lines denote
   paragraph breaks

Последовательности из сопоставлений[править | править код]

 - {name: John Smith, age: 33}
 - name: Mary Smith
   age: 27

Сопоставления из последовательностей[править | править код]

 men: [John Smith, Bill Jones]
 women:
   - Mary Smith
   - Susan Williams

Основные элементы YAML:

  • потоки YAML используют печатаемые Unicode-символы, как UTF-8, так и UTF-16
  • отступы из пробелов (символы табуляции не допускаются) используются для обозначения структуры
  • комментарии начинаются с символа «решётки» (#), могут начинаться в любом месте строки и продолжаются до конца строки
  • списки обозначаются начальным дефисом (-) с одним членом списка на строку, либо члены списка заключаются в квадратные скобки ([ ]) и разделяются запятой и пробелом (, )
  • ассоциативные массивы представлены двоеточием с пробелом (: ) в виде ключ: значение, по одной паре ключ-значение на строку, либо в виде пар, заключённых в фигурные скобки и разделенных запятой и пробелом (, )
    • ключ в ассоциативном массиве может иметь в качестве префикса вопросительный знак (?), что позволяет указать сложный ключ, например представленный в виде списка
  • строки записываются без кавычек, однако могут быть заключены в одиночные или двойные кавычки
    • внутри двойных кавычек могут быть использованы экранированные символы в C-стиле, начинающиеся с обратной косой (\)
  • YAML позволяет задавать подстановки с помощью якорей & и псевдонимов (*). Пример
 aliases:  #последовательность настроек
  - &myAlias1
    datakey: dataval 1
    moredata: morevals 1
  - &myAlias2
    datakey: dataval 2
    moredata: morevals 2
 config:
  - *myAlias1  # *myAlias1 после парсинга будет заменен на [{"datakey": "dataval 1", "moredata": "morevals 1"}]
  • явное задание типа оформляется путём '!![указание типа]'. Пример, !!str 100 после разбора выдаст строковое значение «100» вместо целого числа 100.
  • значения типа Дата/Время задаются в формате YYYY-MM-DD или YYYY-MM-DD HH:MM:SS. Если необходимо задать дату, как строку, нужно заключать её в кавычки («2012-12-21»)

Пример[править | править код]

В некотором проекте нужно хранить конфигурацию, описывающую отображение (англ. bindings) IRC-команд на функции, с помощью регулярных выражений.

Вот исходная конфигурация, представленная в виде таблицы:

ircEvent method regexp
PRIVMSG newUri "^http://.*"
PRIVMSG deleteUri "^delete.*"
PRIVMSG randomUri "^random.*"

В YAML эта конфигурация может быть представлена следующим образом:

bindings:
  - ircEvent: PRIVMSG
    method: newUri
    regexp: '^http://.*'
  - ircEvent: PRIVMSG
    method: deleteUri
    regexp: '^delete.*'
  - ircEvent: PRIVMSG
    method: randomUri
    regexp: '^random.*'

или

bindings: 
  - {ircEvent: PRIVMSG, method: newUri, regexp: '^http://.*'}
  - {ircEvent: PRIVMSG, method: deleteUri, regexp: '^delete.*'}
  - {ircEvent: PRIVMSG, method: randomUri, regexp: '^random.*'}

Для сравнения, в XML-представлении данная конфигурация может быть представлена следующим образом:

<bindings>
    <binding>
        <ircEvent>PRIVMSG</ircEvent>
        <method>newUri</method>
        <regexp>^http://.*</regexp>
    </binding>
    <binding>
        <ircEvent>PRIVMSG</ircEvent>
        <method>deleteUri</method>
        <regexp>^delete.*</regexp>
    </binding>
    <binding>
        <ircEvent>PRIVMSG</ircEvent>
        <method>randomUri</method>
        <regexp>^random.*</regexp>
    </binding>
</bindings>

или

    <bindings>
        <binding ircEvent="PRIVMSG" method="newUri" regexp="^http://.*" />
        <binding ircEvent="PRIVMSG" method="deleteUri" regexp="^delete.*" />
        <binding ircEvent="PRIVMSG" method="randomUri" regexp="^random.*" />
    </bindings>

Вложенные XML-элементы могут использоваться для отображения произвольных структур, а YAML более близок к отображению типичных моделей данных из Ruby, Perl, Python, Java, позволяя описывать свободные сочетания последовательностей, сопоставлений и скалярных типов — то есть ближе к реальным структурам данных языков программирования, и не требует различных соглашений про DOM-отображения структур данных на документы и обратно, как требуется в XML.

Реализации[править | править код]

Библиотеки для работы с YAML существуют для следующих языков программирования:

Использование[править | править код]

YAML в основном используется как формат для файлов конфигурации Ruby on Rails, Dancer, Symfony, GAE framework, Google App Engine и Dart. Является основным языком описания классов, ресурсов и манифестов для пакетов приложений OpenStack Murano Project [источник не указан 2186 дней] и Swagger.io. Также используется по умолчанию для конфигурации умного дома в системе Home Assistant[источник не указан 92 дня].

См. также[править | править код]

Примечания[править | править код]

  1. shared-mime-infoGitLab.
  2. 1 2 RailsGitHub.
  3. shared-mime-infoGitLab.
  4. shared-mime-infoGitLab.
  5. Эванс К. YAML Draft 0.1Yahoo!.
  6. If YAML ain't markup language, what is it? (англ.). StackOverflow (Aug 6 2011). Дата обращения: 15 марта 2021.
  7. Oren Ben-Kiki, Clark Evans, Brian Ingerson. YAML Ain't Markup Language (YAML™) 1.0 (англ.) (2004 Jan 29). Дата обращения: 15 марта 2021.
  8. Oren Ben-Kiki, Clark Evans, Ingy döt Net. YAML Ain’t Markup Language (YAML™) Version 1.2 (1 октября 2009). Дата обращения: 15 марта 2021.
  9. Canonical source repository for LibYAML. GitHub (22 Jun 2020). Дата обращения: 15 марта 2021.
  10. A YAML parser and emitter in C++. GitHub (25 Sep 2019). Дата обращения: 15 марта 2021.
  11. Christophe Lambrechts, Jonathan Slenders. Yaml Library for .NET. SourceForge (3 июня 2006). Дата обращения: 15 марта 2021.
  12. Ferdinand Majerech. dyaml (2020 Sep 19). Дата обращения: 15 марта 2021.
  13. A YAML library for Delphi. GitHub (12 Dec 2019). Дата обращения: 15 марта 2021.
  14. YAML support for the Go language. GitHub (17 Nov 2020). Дата обращения: 15 марта 2021.
  15. JavaScript YAML parser and dumper. Very fast.. GitHub (3 Jan 2021). Дата обращения: 15 марта 2021.
  16. yaml-rust 0.4.5. Дата обращения: 15 марта 2021.
  17. YAXML, the (draft) XML Binding for YAML. YAML (2006). Дата обращения: 15 марта 2021.

Ссылки[править | править код]

  • YAML.ORG (англ.). — официальный сайт. Дата обращения: 29 ноября 2010. Архивировано 10 февраля 2012 года.
  • YAML. CustisWiki. Заказные ИнформСистемы. Дата обращения: 29 апреля 2006. Архивировано 10 февраля 2012 года.
  • YAML Validator (англ.). — Валидатор YAML.