10 koraka do YAML zen

Svi volimo Ansible, ali Ansible je YAML. Za konfiguracijske datoteke postoji mnoštvo formata: liste vrijednosti, parovi "ključ-vrijednost", INI datoteke, YAML, JSON, XML i mnogi drugi. Međutim, iz nekoliko razloga, od svih njih YAML se često smatra posebno teškim. Naime, i pored svog osvježavajućeg minimalizma i impresivnih mogućnosti za rad s hijerarhijskim vrijednostima, sintaksa YAML može iritirati svojim Python-sličnim pristupom u pogledu uvlaka.

10 koraka do YAML zen

Ako vas YAML živcira, možete – i trebate! – poduzeti 10 sljedećih koraka kako biste smanjili svoje iritacije na prihvatljivu razinu i zavoljeli YAML. Kao i pravi popis, naša desetka savjeta bit će numerisana od nule, meditaciju i duhovne prakse dodajte po želji 😉

0. Natjerajte vaš uređivač da radi

Nije bitno koji tekstualni uređivač imate – za njega sigurno postoji barem jedan dodatak za rad s YAML-om. Ako ga nemate, odmah ga potražite i instalirajte. Vrijeme utrošeno na pretragu i postavljanje će se višestruko isplatiti svaki put kada budete morali uređivati YAML.

Na primjer, uređivač Atom podržava YAML po defaultu, dok za GNU Emacs trebate instalirati dodatne pakete, kao što je yaml-mode.

10 koraka do YAML zen

Emacs u YAML modu i prikazivanje praznina.

Ako vaš omiljeni uređivač nema YAML modu, dio problema možete riješiti igrajući se s postavkama. Na primjer, standardni GNOME tekstualni uređivač Gedit nema YAML mod, ali po defaultu označava sintaksu YAML i omogućava podešavanje rada s uvlakama:

10 koraka do YAML zen

Podešavanje uvlaka u Gedit.

A dodatak drawspaces za Gedit prikazuje praznine u obliku tačaka, eliminirajući nejasnoće s razinama uvlaka.

Drugim riječima, potrošite vrijeme na upoznavanje s vašim omiljenim uređivačem. Otkrijte što on sam ili njegova razvojna zajednica nude za rad s YAML-om i iskoristite te mogućnosti. Sigurno nećete zažaliti.

1. Koristite linters

U idealnom slučaju, programski jezici i jezici označavanja koriste predvidljiv sintaksu. Računari se dobro snalaze s predvidljivošću, zbog toga je koncept linters. Ako vas je tokom 40 godina zaobišao i još uvijek ne koristite YAML linter, sada je pravo vrijeme da isprobate yamllint.

Instalirati yamllint može se koristiti putem standardnog menadžera paketa Linux. Na primjer, u Red Hat Enterprise Linux 8 ili Fedora to se radi ovako:

$ sudo dnf install yamllint

Zatim jednostavno pokrećete yamllint, proslijedivši mu YAML datoteku na provjeru. Ovako izgleda kada se linteru proslijedi datoteka s greškom:

$ yamllint errorprone.yaml
errorprone.yaml
23:10     greška    sintaktička greška: mapping vrijednosti ovdje nije dozvoljen
23:11     greška    preostali razmak  (trailing-spaces)

Brojevi lijevo nisu vrijeme, već koordinate greške: broj reda i stupca. Opis greške možda vam neće značiti ništa, ali ćete sigurno znati gdje se nalazi. Samo pogledajte to mjesto u kodu, i vjerojatno će sve biti jasno.

Kada yamllint ne nađe greške u datoteci, na ekran se ne ispisuje ništa. Ako vas plaši tako tiha reakcija i želite malo više povratnih informacija, možete pokrenuti linter s uslovnom komandom echo kroz dupli ampersand (&&), ovako:

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

U POSIX-u, dupli ampersand funkcioniše samo kada prethodna komanda vraća 0. A yamllint zapravo vraća broj pronađenih grešaka, pa tako cijela ta uslovna konstrukcija i funkcioniše.

2. Pišite na Pythonu, a ne na YAML-u

Ako vas stvarno iritira YAML, jednostavno ne pišite na njemu, u doslovnom smislu. Ponekad je YAML jedini format koji aplikacija prihvaća. Ali čak i u tom slučaju nije nužno kreirati YAML datoteku. Pišite na onome što volite, a zatim konvertujte. Na primjer, za Python postoji odlična biblioteka pyyaml i dva načina konvertovanja: samokoverzija i konvertovanje putem skripti.

Samokoverzija

U ovom slučaju, datoteka sa podacima također je Python skripta koja generiše YAML. Ovaj način je najbolje odgovara za male skupove podataka. Jednostavno pišete JSON podatke u Python promenljivu, prethodite to direktivom import, a na kraju datoteke dodajte tri reda za implementaciju izlaza.

#!/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 Pythonu 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: 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

Ovo je apsolutno ispravan YAML, ali yamllint će dati upozorenje da ne počinje s —. Pa, to se može lako popraviti ručno ili malo doraditi Python skriptu.

Pretvaranje putem skripti

U ovom slučaju prvo pišemo na JSON-u, a zatim pokrećemo konverter u obliku posebne Python skripte koja na izlazu daje YAML. U poređenju sa prethodnim, ovaj način bolje skalira, pošto je konvertovanje odvojeno od podataka.

Na početku ćemo kreirati JSON fajl example.json, na primer, možete ga preuzeti sa json.org:

{
	"glossary": {
	  "title": "primjer rječnika",
	  "GlossDiv": {
		"title": "S",
		"GlossList": {
		  "GlossEntry": {
			"ID": "SGML",
			"SortAs": "SGML",
			"GlossTerm": "Standardna generalizovana markup jezik",
			"Acronym": "SGML",
			"Abbrev": "ISO 8879:1986",
			"GlossDef": {
			  "para": "Meta-markup jezik, korišćen za kreiranje markup jezika kao što je DocBook.",
			  "GlossSeeAlso": ["GML", "XML"]
			  },
			"GlossSee": "markup"
			}
		  }
		}
	  }
	}

Zatim ćemo kreirati jednostavnu konverter skriptu i sačuvati je pod imenom json2yaml.py. Ova skripta uvozi oba modula — YAML i JSON Python, kao i učitava korisnički navedeni JSON fajl, vrši konvertovanje i beleži podatke u fajl 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 često i u velikim količinama

Ponekad je korisno posmatrati problem iz drugog ugla. Ako vam je teško zamisliti odnose između podataka u YAML-u, možete privremeno pretvoriti u nešto poznatije.

Na primer, ako vam je lakše raditi sa rečničkim listama ili sa JSON-om, tada se YAML može pretvoriti u JSON sa samo dve komande u interaktivnoj Python konzoli. Recimo, imate YAML fajl mydata.yaml, evo kako bi to izgledalo:

$ 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. Mogao bi biti bolji.'}

Na ovu temu možete pronaći mnoštvo drugih primjera. Takođe, dostupni su mnogi online konverteri i lokalni parseri. Zato se ne plašite da preformatirate podatke kada vidite u njima samo nejasnu mešavinu.

4. Čitajte specifikacije

Vraćajući se k YAML-u nakon duže pauze, korisno je otići na yaml.org i pročitati specifikacije. Ako imate poteškoća sa YAML-om, a još niste došli do specifikacija, vreme je da to ispravite. Specifikacije su iznenađujuće lako napisane, a zahtev za sintaksom ilustrovan je brojnim primerima u Poglavlju 6.

5. Pseudo konfiguracije

Kada pišete knjigu ili članak, uvijek je korisno prvo napraviti preliminarni plan, barem u obliku sadržaja. Tako je i sa YAML-om. Verovatno već imate predstavu o tome koje podatke treba zapisati u YAML datoteku, ali ne razumete baš kako ih međusobno povezati. Zato pre nego što počnete s pisanjem YAML-a, nacrtajte pseudokonfiguraciju.

Pseudokonfiguracija podseća na pseudokod, gde nije potrebno brinuti se o strukturi ili uvlačenju, odnosima „roditelj-dete“, nasleđivanju i ugnježdenosti. Tako i ovde: crtate iteracije podataka dok ih imate u mislima.

10 koraka do YAML zen

Pseudokonfiguracija s popisom programera (Martin i Tabitha) i njihovim veštinama (programski jezici: Python, Perl, Pascal i Lisp, Fortran, Erlang, redom).

Nakon što nacrtate pseudokonfiguraciju na papiru, pažljivo je analizirajte i, ako je sve u redu, pretvorite je u validnu YAML datoteku.

6. Dilema „tabulacija ili razmaci“

Bićete primorani da rešite dilemu „tabulacija ili razmaci?“. Ne u globalnom smislu, već samo na nivou vaše organizacije, ili barem projekta. Nije važno da li će se koristiti post-processing skriptom sed, podešavanje tekstualnih editora na računarima programera ili će se uzimati izjave o strogoj primeni uputstava linters-a pod pretnjom otkaza, ali svi članovi vašeg tima koji se na bilo koji način bave YAML-om moraju koristiti samo razmake (kako to zahteva YAML specifikacija).

U svakom normalnom tekstualnom editoru može se podesiti automatska zamena tabulacije za zadati broj razmaka, tako da se ne morate plašiti pobune pristalica tastera Tab i nema potrebe za strahom.

Kao što je poznato svakom mrzitelju YAML-a, na ekranu se ne vidi razlika između tabulacije i razmaka. A kada nešto nije vidljivo, obično se na to setimo tek u poslednjem trenutku, nakon što smo proverili i uklonili sve druge moguće probleme. Sat vremena izgubljenog vremena u potrazi za lošom tabulacijom ili blokom razmaka samo dokazuje da je neophodno hitno stvoriti politiku korišćenja jednog ili drugog, a zatim implementirati čvrstu proveru njenog poštovanja (na primer, putem Git hook-a za obavezno pokretanje linters-a).

7. Bolje manje, ali bolje (ili više – manje je više)

Neki ljudi vole pisati u YAML-u jer naglašava strukturu. Pritom aktivno koriste uvlake kako bi istakli blokove podataka. To je neka vrsta varanja za imitaciju markup jezika koji koriste eksplicitne razdjelnike.

Evo primjera takve strukturiranosti iz dokumentacije Ansible:

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

Nekima ovakva opcija pomaže da razjasne strukturu YAML-a u svom umu, dok druge uopće iritira mnoštvom nepotrebnih, po njihovom mišljenju, uvlaka.

No ako ste vlasnik YAML dokumenta i odgovorni ste za njegovo održavanje, tada samo vi trebate određivati kako koristiti uvlake. Ako vas iritiraju velike uvlake, smanjite ih na minimum koji je samo moguć prema YAML specifikaciji. Na primjer, prethodni fajl iz dokumentacije Ansible može se bez ikakvih gubitaka 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 predloške

Ako prilikom popunjavanja YAML fajla stalno ponavljate iste greške, ima smisla uključiti predložak u obliku komentara. Tako sljedeći put možete jednostavno kopirati taj predložak i unijeti stvarne podatke, na primjer:

---
# - <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. Koristite nešto drugo

Ako vas aplikacija ne drži pod strogim okovima, možda je vrijeme da zamijenite YAML drugim formatom. S vremenom, konfiguracijski fajlovi mogu prerasti svoju svrhu i tada je bolje pretvoriti ih u jednostavne skripte na Lua ili Python.

YAML je odlična stvar koju mnogi vole zbog minimalizma i jednostavnosti, ali to nije jedini alat u vašem arsenalu. Ponekad ga se možete riješiti. Za YAML je lako pronaći biblioteke za parsiranje, pa ako ponudite prikladne opcije migracije, vaši korisnici će relativno bezbolno preživjeti takav prekid.

Ako ne možete bez YAML-a, iskoristite ovih 10 savjeta i pobijedite svoje odbojnosti prema YAML-u jednom zauvijek!

Izvor: habr.com

Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere 🔥 Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere | ProHoster