10 чекори до YAML Зен

Сите го сакаме Ansible, но Ansible е YAML. Постојат многу формати за конфигурациски датотеки: списоци на вредности, парови на параметар-вредност, INI датотеки, YAML, JSON, XML и многу други. Сепак, поради неколку причини од сите нив, YAML често се смета за особено тежок. Особено, и покрај неговиот освежувачки минимализам и импресивни способности за работа со хиерархиски вредности, синтаксата YAML може да биде досадна со нејзиниот пристап сличен на Python за вовлекување.

Ако YAML ве налути, можете - и треба! – преземете ги следните 10 чекори за да ја намалите вашата фрустрација на прифатливо ниво и да се заљубите во YAML. Како што доликува на оваа листа, нашите десет совети ќе бидат нумерирани од нула, ќе додадеме медитација и духовни практики по желба 😉

0. Направете вашиот уредник да работи

Не е важно каков уредувач на текст имате, веројатно постои барем еден додаток за работа со YAML. Ако немате, веднаш пронајдете го и инсталирајте го. Времето поминато во пребарување и поставување ќе се исплати многукратно секој пат кога ќе треба да уредувате YAML.

На пример, уредник Атом стандардно поддржува YAML, но за GNU Emacs ќе мора да инсталирате дополнителни пакети, на пример, yaml-режим.

Emacs во режим YAML и прикажување празни места.

Ако вашиот омилен уредник нема режим YAML, тогаш некои од проблемите може да се решат со работа со поставките. На пример, стандардниот уредувач на текст GNOME Gedit нема режим на YAML, но стандардно ја нагласува синтаксата на YAML и ви овозможува да ја конфигурирате работата со вдлабнатини:

Поставување вовлекувања во Gedit.

Приклучок простори за цртање за Gedit, ги прикажува празнините како точки, елиминирајќи ги нејаснотијата со нивоата на вовлекување.

Со други зборови, поминете време за учење за вашиот омилен уредник. Дознајте што тој или неговата развојна заедница има да понуди за работа со YAML и искористете ги тие функции. Дефинитивно нема да зажалите.

1. Користете линтер

Идеално, програмските јазици и јазиците за означување користат предвидлива синтакса. Компјутерите се добри во предвидливоста, поради што концептот на линтера. Ако во 40-те години од своето постоење помина покрај вас и сè уште не користите YAML линтер, тогаш време е да пробате јамлинт.

Инсталирај јамлинт Можете да го користите стандардниот менаџер на пакети на Linux. На пример, во Линк Linux на Red Hat Enterprise 8 или Fedora направено е вака:

$ sudo dnf install yamllint

Потоа едноставно стартувате yamllint, пренесувајќи ја датотеката YAML за проверка. Вака изгледа ако префрлите датотека со грешка на линтерот:

$ yamllint errorprone.yaml
errorprone.yaml
23:10     error    syntax error: mapping values are not allowed here
23:11     error    trailing spaces  (trailing-spaces)

Броевите лево не се времето, туку координатите на грешката: број на ред и колона. Описот на грешката можеби нема да ви каже ништо, но точно знаете каде е. Само погледнете го ова место во кодот, и најверојатно сè ќе стане јасно.

Кога yamllint не наоѓа грешки во датотеката, ништо не се печати на екранот. Ако таквата тишина ве плаши и сакате малку повеќе повратни информации, тогаш можете да го вклучите линтерот со командата за условно ехо преку двоен амперсанд (&&), вака:

$ yamllint perfect.yaml && echo "OK"
OK

Во POSIX, двоен амперсенд се активира ако и само ако претходната команда врати 0. И yamllint само го враќа бројот на пронајдени грешки, поради што функционира целата оваа условна конструкција.

2. Пишувајте во Python, а не YAML

Ако YAML навистина ве налути, едноставно не пишувајте во него, буквално. Се случува YAML да е единствениот формат што апликацијата го разбира. Но, дури и во овој случај, не е неопходно да се создаде датотека YAML. Напишете на она што ви се допаѓа и потоа претворете. На пример, постои одлична библиотека за Python pyyaml и два методи на конверзија: самоконверзија и конверзија преку скрипти.

Самопреобразување

Во овој случај, датотеката со податоци е исто така Python скрипта што генерира YAML. Овој метод најдобро одговара за мали збирки податоци. Едноставно ги запишувате податоците од JSON во променливата на Python, му ставате предговор со директива за увоз и на крајот од датотеката додавате три линии за да го имплементирате излезот.

#!/usr/bin/python3	
import yaml 

d={
"glossary": {
  "title": "example glossary",
  "GlossDiv": {
	"title": "S",
	"GlossList": {
	  "GlossEntry": {
		"ID": "SGML",
		"SortAs": "SGML",
		"GlossTerm": "Standard Generalized Markup Language",
		"Acronym": "SGML",
		"Abbrev": "ISO 8879:1986",
		"GlossDef": {
		  "para": "A meta-markup language, used to create markup languages such as DocBook.",
		  "GlossSeeAlso": ["GML", "XML"]
		  },
		"GlossSee": "markup"
		}
	  }
	}
  }
}

f=open('output.yaml','w')
f.write(yaml.dump(d))
f.close

Сега ја извршуваме оваа датотека во Python и ја добиваме датотеката output.yaml:

$ python3 ./example.json
$ cat output.yaml
glossary:
  GlossDiv:
	GlossList:
	  GlossEntry:
		Abbrev: ISO 8879:1986
		Acronym: SGML
		GlossDef:
		  GlossSeeAlso: [GML, XML]
		  para: A meta-markup language, used to create markup languages such as DocBook.
		GlossSee: markup
		GlossTerm: Standard Generalized Markup Language
		ID: SGML
		SortAs: SGML
	title: S
  title: example glossary

Ова е совршено валидно YAML, но yamllint ќе ве предупреди дека не започнува со -. Па, ова може лесно да се коригира рачно или малку да се измени во скриптата на Python.

Конверзија преку скрипти

Во овој случај, прво пишуваме во JSON, а потоа го извршуваме конверторот како посебна Python скрипта, која произведува YAML како излез. Во споредба со претходниот метод, овој метод се зголемува подобро, бидејќи конверзијата е одвоена од податоците.

Прво, ајде да создадеме JSON-датотека example.json, на пример, од која можете да ја преземете json.org:

{
	"glossary": {
	  "title": "example glossary",
	  "GlossDiv": {
		"title": "S",
		"GlossList": {
		  "GlossEntry": {
			"ID": "SGML",
			"SortAs": "SGML",
			"GlossTerm": "Standard Generalized Markup Language",
			"Acronym": "SGML",
			"Abbrev": "ISO 8879:1986",
			"GlossDef": {
			  "para": "A meta-markup language, used to create markup languages such as DocBook.",
			  "GlossSeeAlso": ["GML", "XML"]
			  },
			"GlossSee": "markup"
			}
		  }
		}
	  }
	}

Потоа ќе создадеме едноставна скрипта за конвертор и ќе ја зачуваме под името json2yaml.py. Оваа скрипта ги увезува и YAML и JSON Python модулите и вчитува JSON-датотека одредена од корисникот, ја врши конверзијата и ги запишува податоците во датотеката output.yaml.

#!/usr/bin/python3
import yaml
import sys
import json

OUT=open('output.yaml','w')
IN=open(sys.argv[1], 'r')

JSON = json.load(IN)
IN.close()
yaml.dump(JSON, OUT)
OUT.close()

Зачувајте ја оваа скрипта во системската патека и стартувајте ја по потреба:

$ ~/bin/json2yaml.py example.json

3. Анализирајте многу и често

Понекогаш е корисно да се погледне на проблемот од поинаков агол. Ако имате проблем да ги претставите односите помеѓу вашите податоци во YAML, можете привремено да ги трансформирате во нешто попознато.

На пример, ако ви е удобно да работите со списоци со речник или JSON, можете да конвертирате YAML во JSON со само две команди во интерактивната обвивка на Python. Да речеме дека имате датотека YAML mydata.yaml, тогаш вака би изгледала:

$ python3
>>> f=open('mydata.yaml','r')
>>> yaml.load(f)
{'document': 34843, 'date': datetime.date(2019, 5, 23), 'bill-to': {'given': 'Seth', 'family': 'Kenlon', 'address': {'street': '51b Mornington Roadn', 'city': 'Brooklyn', 'state': 'Wellington', 'postal': 6021, 'country': 'NZ'}}, 'words': 938, 'comments': 'Good article. Could be better.'}

Можете да најдете многу други примери на оваа тема. Покрај тоа, има многу достапни онлајн конвертори и локални парсери. Затоа, не двоумете се да ги реформатирате податоците кога ќе видите само неразбирлив метеж во нив.

4. Прочитајте ги спецификациите

Враќајќи се во YAML по долга пауза, корисно е да се посети yaml.org и повторно прочитајте ги спецификациите (спецификациите). Ако имате потешкотии со YAML, но не сте стигнале до спецификацијата, тогаш е време да ја поправите оваа ситуација. Спецификациите се изненадувачки лесни за пишување, а барањата за синтакса се илустрирани со голем број примери во Поглавје 6.

5. Псевдо-конфигурации

Кога пишувате книга или статија, секогаш е корисно прво да се скицира прелиминарен преглед, барем во форма на табела со содржина. Истото е и со YAML. Најверојатно, имате идеја за тоа кои податоци треба да се запишат во датотека YAML, но навистина не разбирате како да ги поврзете едни со други. Затоа, пред да го извајате YAML, нацртајте псевдо-конфигурација.

Псевдо-конфигурацијата е слична на псевдо-кодот, каде што не треба да се грижите за структурата или вовлекувањето, односите родител-дете, наследството и вгнездувањето. Истото е и овде: цртате повторувања на податоците како што се појавуваат во вашата глава.

Програмери со листа на псевдо-конфигурации (Мартин и Табита) и нивните вештини (програмски јазици: Python, Perl, Pascal и Lisp, Fortran, Erlang, соодветно).

Откако ќе нацртате псевдо-конфигурација на парче хартија, внимателно анализирајте ја и, ако сè е во ред, форматирајте ја во форма на валидна YAML-датотека.

6. Дилемата на јазичиња против простори

Ќе мора да ја решите дилемата „јазичиња или празни места?“. Не во глобална смисла, туку само на ниво на вашата организација, или барем проект. Не е важно дали ова вклучува користење пост-обработка со sed скрипта, поставување уредувачи на текст на машините на програмерите или универзално земање сметки за строго усогласување со упатствата на linter под закана за отпуштање, туку сите членови на вашиот тим кои во еден или друг начин поврзани со YAML мора да користи само празни места (како што се бара со спецификацијата YAML).

Во секој нормален уредувач на текст, можете да ги конфигурирате табовите за автоматска корекција на одреден број празни места, така што ќе предизвика бунт на клучните приврзаници Табот не треба да се плашите.

Како што секој мразител на YAML добро знае, не можете да ја видите разликата помеѓу картичките и празнините на екранот. И кога нешто не е видливо, тоа е обично последното нешто што луѓето го паметат, откако ќе ги средат, проверат и елиминираат сите други можни проблеми. Еден час од времето поминато во потрага по крива на табелирање или блок од празни места едноставно вреска дека итно ви треба за да креирате политика за користење на едното или другото, а потоа спроведете армирано-бетонска проверка за усогласеност со неа (на пример, преку кука Git за да ја натера да помине низ линтер).

7. Помалку е повеќе (или повеќе е помалку)

Некои луѓе сакаат да пишуваат во YAML бидејќи ја нагласува структурата. Во исто време, тие активно користат вовлекување за да ги истакнат блоковите на податоци. Ова е еден вид измама за имитација на јазици за означување кои користат експлицитни разграничувачи.

Еве еден пример за таква структура од Едноставна документација:

# Employee records
-  martin:
        name: Martin D'vloper
        job: Developer
        skills:
            - python
            - perl
            - pascal
-  tabitha:
        name: Tabitha Bitumen
        job: Developer
        skills:
            - lisp
            - fortran
            - erlang

За некои, оваа опција им помага да ја средат структурата на YAML во нивните глави, за други, напротив, ги нервира со многу непотребни, според нив, алинеја.

Но, ако сте сопственик на документот YAML и сте одговорни за негово одржување, тогаш ти и само ти мора да дефинира како да се користи вовлекувањето. Ако ве нервира големото полнење, чувајте го на минимум можно според спецификацијата YAML. На пример, горната датотека од документацијата Ansible може да се препише вака без никаква загуба:

---
- martin:
   name: Martin D'vloper
   job: Developer
   skills:
   - python
   - perl
   - pascal
- tabitha:
   name: Tabitha Bitumen
   job: Developer
   skills:
   - lisp
   - fortran
   - erlang

8. Користете празни места

Ако постојано ги повторувате истите грешки кога пополнувате датотека YAML, има смисла да вметнете шаблон во неа како коментар. Потоа следниот пат можете едноставно да го копирате овој шаблон и да внесете вистински податоци таму, на пример:

---
# - <common name>:
#   name: Given Surname
#   job: JOB
#   skills:
#   - LANG
- martin:
  name: Martin D'vloper
  job: Developer
  skills:
  - python
  - perl
  - pascal
- tabitha:
  name: Tabitha Bitumen
  job: Developer
  skills:
  - lisp
  - fortran
  - erlang

9. Користете нешто различно

Ако апликацијата не ве држи за гушење, тогаш можеби вреди да го смените YAML во различен формат. Со текот на времето, конфигурациските датотеки можат да се надраснат сами по себе, а потоа подобро е да се претворат во едноставни скрипти во Lua или Python.

YAML е одлична работа што многу луѓе ја сакаат поради нејзиниот минимализам и едноставност, но тоа е далеку од единствената алатка во вашиот арсенал. Затоа понекогаш можете да го одбиете. Библиотеките за парсирање лесно се наоѓаат за YAML, па ако понудите лесни опции за миграција, вашите корисници ќе го преживеат овој неуспех релативно безболно.

Ако не можете без YAML, тогаш земете ги овие 10 совети и надминете го вашето несакање кон YAML еднаш засекогаш!

Извор: www.habr.com