Svi volimo Ansible, ali Ansible je YAML. Za konfiguracijske datoteke postoji mnogo formata: liste vrijednosti, parovi 'ključ-vrijednost', INI datoteke, YAML, JSON, XML i mnogi drugi. Međutim, iz nekoliko razloga, među njima se YAML često smatra posebno teškim. Konkretno, unatoč svom osvježavajućem minimalizmu i impresivnim mogućnostima za rad s hijerarhijskim vrijednostima, sintaksa YAML-a može iritirati svojim Python-sličnim pristupom uvlacenju.

Ako vas iritira YAML, možete – i trebate! – poduzeti sljedećih 10 koraka kako biste smanjili svoje nezadovoljstvo na prihvatljivu razinu i zavoljeli YAML. Kao što to i priliči pravom popisu, naša desetka savjeta će biti numerirana od nule, meditaciju i duhovne prakse dodajte po želji 😉
0. Natjerajte svoj urednik da radi
Nije važno koji tekstualni urednik imate – sigurno postoji barem jedan dodatak za rad s YAML-om. Ako ga nemate, odmah ga potražite i instalirajte. Vrijeme provedeno u potrazi i podešavanju će se višestruko isplatiti svaki put kada budete morali uređivati YAML.
Na primjer, urednik podržava YAML po defaultu, dok za GNU Emacs morate instalirati dodatne pakete, na primjer, .

Emacs u YAML modu i prikazu razmaka.
Ako vaš omiljeni urednik nema YAML način rada, dio problema možete riješiti radu s postavkama. Na primjer, standardni GNOME tekstualni urednik Gedit nema YAML način rada, ali po defaultu ističe sintaksu YAML i omogućava podešavanje uvlaka:

Podešavanje uvlaka u Gedit.
A dodatak za Gedit prikazuje razmake kao točke, eliminirajući nejasnoće s razinama uvlaka.
Drugim riječima, provedite vrijeme istražujući svog omiljenog urednika. Saznajte što on sam ili njegova razvojna zajednica nude za rad s YAML-om i iskoristite te mogućnosti. Sigurno nećete požaliti zbog toga.
1. Koristite linterski alat (linter)
Idealno, programski jezici i markup jezici koriste predvidivu sintaksu. Računala dobro funkcioniraju s predvidivošću, stoga je još 1978. godine nastala koncept . Ako vas je to proteklih 40 godina zaobišlo i još uvijek ne koristite YAML linter, sada je pravo vrijeme da probate yamllint.
Instalirati možete to učiniti pomoću standardnog menadžera paketa Linux. Na primjer, u 8 ili to se radi ovako:
$ sudo dnf install yamllint
Zatim jednostavno pokrenite yamllint, prosljeđujući mu YAML datoteku na provjeru. Ovako to izgleda kada se linterskoj aplikaciji proslijedi datoteka sa greškom:
$ yamllint errorprone.yaml
errorprone.yaml
23:10 greška sintaktička greška: mape vrijednosti ovdje nisu dopuštene
23:11 greška prazna mjesta (trailing-spaces)
Brojevi s lijeve strane nisu vrijeme, već koordinate greške: broj reda i kolone. Opis greške možda vam neće reći mnogo, ali ćete točno znati gdje se nalazi. Samo pogledajte to mjesto u kodu i, vrlo vjerojatno, sve će biti jasno.
Kada yamllint ne pronađe greške u datoteci, ništa se ne ispisuje na ekran. Ako vas plaši takva tišina i želite malo više povratnih informacija, možete pokrenuti linter s uvjetnom komandom echo kroz dvostruki ampersand (&&), ovako:
$ yamllint perfect.yaml && echo "OK"
OK
U POSIX-u, dvostruki ampersand se izvršava tada i samo tada kada prethodna komanda vraća 0. A yamllint zapravo vraća broj pronađenih grešaka, tako da cijela ta uvjetna konstrukcija i radi.
2. Pišite u Pythonu, a ne u YAML-u
Ako vas doista frustrira YAML, jednostavno nemojte pisati u njemu, doslovno. Dogodi se da je YAML jedini format koji aplikacija prihvaća. No, čak ni u tom slučaju nije nužno kreirati YAML datoteku. Pišite onako kako vam se sviđa, a zatim konvertirajte. Na primjer, za Python postoji odlična biblioteka i dva načina konvertiranja: samokonverzija i konverzija putem skripti.
Samokonverzija
U ovom slučaju, datoteka s podacima također je i Python skripta koja generira YAML. Ovaj pristup najbolje odgovara malim skupovima podataka. Jednostavno pišete JSON podatke u Python varijablu, prethodite to direktivom import, a na kraju datoteke dodajte tri retka za implementaciju ispisa.
#!/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
Sada pokrećemo ovu datoteku na Python-u i na izlazu dobijamo datoteku output.yaml:
$ python3 ./example.json
$ cat output.yaml
glossary:
GlossDiv:
GlossList:
GlossEntry:
Abbrev: ISO 8879:1986
Acronym: SGML
GlossDef:
GlossSeeAlso: [GML, XML]
para: Meta-označeni jezik, korišten za stvaranje označenih jezika kao što je DocBook.
GlossSee: markup
GlossTerm: Standardni generalizirani označeni jezik
ID: SGML
SortAs: SGML
title: S
title: primjer glosara
To je potpuno ispravan YAML, ali yamllint će dati upozorenje da ne počinje s —. Pa, to se može lako ispraviti ručno ili malo doraditi Python skriptu.
Konvertiranje putem skripti
U tom slučaju prvo pišemo u JSON-u, a zatim pokrećemo konverter u obliku zasebne Python skripte, koja na izlazu daje YAML. U usporedbi s prethodnim, ovaj način se bolje skalira, jer je konvertiranje odvojeno od podataka.
Za početak stvorimo JSON datoteku example.json, na primjer, možemo je preuzeti sa :
{
"glossary": {
"title": "primjer glosara",
"GlossDiv": {
"title": "S",
"GlossList": {
"GlossEntry": {
"ID": "SGML",
"SortAs": "SGML",
"GlossTerm": "Standardni generalizirani markup jezik",
"Acronym": "SGML",
"Abbrev": "ISO 8879:1986",
"GlossDef": {
"para": "Meta-markup jezik, korišten za kreiranje markup jezika kao što je DocBook.",
"GlossSeeAlso": ["GML", "XML"]
},
"GlossSee": "markup"
}
}
}
}
}
Zatim ćemo stvoriti jednostavnu skriptu konverter i sačuvati je pod imenom json2yaml.py. Ova skripta uvozi oba modula — YAML i JSON Python, kao i učitava datoteku JSON koju korisnik odabere, izvršava konvertiranje i zapisuje podatke u datoteku 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()
Sačuvajte ovu skriptu u sistemskom putu i pokrećite je po potrebi:
$ ~/bin/json2yaml.py example.json
3. Parsirajte puno i često
Ponekad je korisno pogledati problem iz druge perspektive. Ako vam je teško zamisliti odnose između podataka u YAML-u, možete ih privremeno pretvoriti u nešto poznatije.
Na primjer, ako vam je ugodnije raditi sa riječničkim listama ili s JSON-om, tada se YAML može pretvoriti u JSON uz samo dvije naredbe u interaktivnoj Python ljusci. Pretpostavimo da imate YAML datoteku mydata.yaml, onda bi to izgledalo ovako:
$ 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': 'Dobar članak. Moglo bi biti i bolje.'}
Na ovu temu možete pronaći mnoštvo drugih primjera. Osim toga, dostupni su mnogi online konverteri i lokalni parseri. Stoga se ne ustručavajte preformatirati podatke kada ih vidite samo kao nejasnu mješavinu.
4. Čitajte specifikacije
Vraćajući se na YAML nakon dužeg vremena, korisno je posjetiti i pročitati specifikacije (spec). Ako imate poteškoća s YAML-om, ali još niste došli do specifikacije, sada je pravo vrijeme da to ispravite. Specifikacije su iznenađujuće jednostavne za čitanje, a zahtjevi za sintaksu ilustrirani su velikim brojem primjera u .
5. Pseudokonfiguracije
Pri pisanju knjige ili članka uvijek je korisno prvo skicirati preliminarni plan, barem u obliku sadržaja. Tako je i s YAML-om. Vjerojatno imate predstavu o tome koje podatke trebate zapisati u YAML datoteku, ali ne razumijete baš kako ih međusobno povezati. Stoga, prije nego što izađete sa YAML-om, nacrtajte pseudokonfiguraciju.
Pseudokonfiguracija nalikuje pseudokodu, gdje se ne morate brinuti o strukturi ili udaljenostima, vezama 'roditelj-dijete', nasljeđivanju i ugniježđenju. Tako je i ovdje: crtate iteracije podataka kako se javljaju u vašoj glavi.

Pseudokonfiguracija s popisom programera (Martin i Tabitha) i njihovih vještina (programski jezici: Python, Perl, Pascal i Lisp, Fortran, Erlang, u odgovarajućem redu).
Nakon što ste nacrtali pseudokonfiguraciju na papiru, pažljivo je analizirajte i, ako je sve u redu, oblikujte je u valjanu YAML datoteku.
6. Dilema 'tabulator ili razmake'
Morat ćete riješiti dilemu . Ne u globalnom smislu, nego samo na razini vaše organizacije ili barem projekta. Bez obzira hoće li to uključivati post-process skriptu sed, postavke tekstualnih uređivača na računalima programera ili puku akciju zadržavanja potvrda o strogom pridržavanju smjernica linterskih pravila pod prijetnjom otkaza, svi članovi vašeg tima koji imaju bilo kakve veze s YAML-om moraju obavezno koristiti samo razmake (kako zahtijeva YAML specifikacija).
U svakom normalnom tekstualnom uređivaču može se postaviti automatska zamjena tabulatora za određeni broj razmaka, tako da nema potrebe za pobunom pristaša tipke Tab ne trebate se bojati.
Kao što je dobro poznato svakom mrzitelju YAML-a, na ekranu se ne vidi razlika između tabulatora i razmaka. A kad nešto nije vidljivo, o tome se obično sjeti u posljednjem trenutku, nakon što su pregledali, provjerili i riješili sve ostale moguće probleme. Sat vremena izgubljen u potrazi za krivim tabulatorom ili blokom razmaka jednostavno zahtijeva da odmah izradite politiku korištenja jednog ili drugog, a zatim provedete čvrstu provjeru njezine primjene (na primjer, putem Git hook-a za prisilno provođenje linterske provjere).
7. Bolje malo, a bolje (ili više – to je manje)
Neki ljudi vole pisati u YAML-u jer naglašava strukturu. Pritom aktivno koriste uvlake za isticanje blokova podataka. To je svojevrsna prevara za imitaciju jezika markup-a koji koriste jasne razdjeljnike.
Evo primjera takve strukturiranosti iz :
# Employee records
- martin:
name: Martin D'vloper
job: Developer
skills:
- python
- perl
- pascal
- tabitha:
name: Tabitha Bitumen
job: Developer
skills:
- lisp
- fortran
- erlang
Nekima ovaj pristup pomaže da razjasne strukturu YAML-a, dok druge frustrira masom suvišnih, po njihovom mišljenju, uvlaka.
No, ako ste vlasnik YAML dokumenta i odgovorni ste za njegovu podršku, onda samo vi trebali biste odrediti kako koristiti uvlake. Ako vas velike uvlake iritiraju, smanjite ih na minimum koji je moguć prema YAML specifikaciji. Na primjer, prethodno navedeni datoteku iz dokumentacije Ansible možete prepisati ovako:
---
- martin:
name: Martin D'vloper
job: Developer
skills:
- python
- perl
- pascal
- tabitha:
name: Tabitha Bitumen
job: Developer
skills:
- lisp
- fortran
- erlang
8. Koristite šablone
Ako stalno ponavljate iste greške pri popunjavanju YAML datoteke, ima smisla umetnuti šablon u obliku komentara. Tada ćete sljedeći put jednostavno moći kopirati ovu šablonu i upisati stvarne podatke, na primjer:
---
# - <common name>:
# name: Dano Prezime
# job: POSAO
# skills:
# - JEZIK
- martin:
name: Martin D'vloper
job: Developer
skills:
- python
- perl
- pascal
- tabitha:
name: Tabitha Bitumen
job: Developer
skills:
- lisp
- fortran
- erlang
9. Koristite nešto drugo
Ako vas aplikacija ne drži čvrsto, možda bi bilo bolje preći na drugi format. S vremenom, konfiguracijske datoteke mogu prerasti svoju svrhu, pa je bolje pretvoriti ih u jednostavne skripte na Lua ili Pythonu.
YAML je sjajan alat koji mnogi vole zbog minimalizma i jednostavnosti, ali to nije jedini alat u vašem arsenalu. Ponekad ga možete jednostavno zanemariti. Za YAML je lako pronaći biblioteke za parsiranje, pa ako ponudite prikladne opcije za migraciju, vaši korisnici će relativno lako preživjeti tu promjenu.
Ako ne možete bez YAML-a, uzmite u obzir ovih 10 savjeta i prevladajte svoju averziju prema YAML-u jednom zauvijek!
Izvor: habr.com
