🥇YAML ज़ेन के लिए 10 कदम

हम सभी को Ansible पसंद है, लेकिन Ansible YAML है। कॉन्फ़िगरेशन फ़ाइलों के लिए कई प्रारूप हैं: मानों की सूची, पैरामीटर-मूल्य जोड़े, INI फ़ाइलें, YAML, JSON, XML और कई अन्य। हालाँकि, उन सभी में से कई कारणों से, YAML को अक्सर विशेष रूप से कठिन माना जाता है। विशेष रूप से, पदानुक्रमित मूल्यों के साथ काम करने के लिए इसकी ताज़ा अतिसूक्ष्मवाद और प्रभावशाली क्षमताओं के बावजूद, YAML सिंटैक्स इंडेंटेशन के लिए अपने पायथन-जैसे दृष्टिकोण से परेशान हो सकता है।

यदि YAML आपको परेशान करता है, तो आप ऐसा कर सकते हैं—और आपको ऐसा करना भी चाहिए! - अपनी निराशा को स्वीकार्य स्तर तक कम करने और YAML के साथ प्यार में पड़ने के लिए निम्नलिखित 10 कदम उठाएं। जैसा कि इस सूची में है, हमारी दस युक्तियाँ शुरू से ही क्रमांकित की जाएंगी, हम इच्छानुसार ध्यान और आध्यात्मिक अभ्यास जोड़ देंगे 😉

0. अपने संपादक को काम पर लगायें

इससे कोई फर्क नहीं पड़ता कि आपके पास कौन सा टेक्स्ट एडिटर है, संभवतः YAML के साथ काम करने के लिए कम से कम एक प्लगइन है। यदि आपके पास यह नहीं है, तो इसे तुरंत ढूंढें और इंस्टॉल करें। खोज और सेटअप में बिताया गया समय आपके द्वारा YAML को संपादित करने में लगने वाली हर बार की तुलना में कई गुना अधिक लाभदायक होगा।

उदाहरण के लिए, संपादक परमाणु डिफ़ॉल्ट रूप से YAML का समर्थन करता है, लेकिन GNU Emacs के लिए आपको अतिरिक्त पैकेज स्थापित करने होंगे, उदाहरण के लिए, yaml-मोड.

YAML मोड में Emacs और रिक्त स्थान प्रदर्शित करना।

यदि आपके पसंदीदा संपादक के पास YAML मोड नहीं है, तो सेटिंग्स के साथ काम करके कुछ समस्याओं का समाधान किया जा सकता है। उदाहरण के लिए, मानक GNOME टेक्स्ट एडिटर Gedit में YAML मोड नहीं है, लेकिन डिफ़ॉल्ट रूप से यह YAML सिंटैक्स को हाइलाइट करता है और आपको इंडेंटेशन के साथ काम को कॉन्फ़िगर करने की अनुमति देता है:

Gedit में इंडेंट सेट करना।

एक प्लगइन ड्रॉस्पेस जीएडिट के लिए, रिक्त स्थान को बिंदुओं के रूप में प्रदर्शित करता है, इंडेंटेशन स्तरों के साथ अस्पष्टता को समाप्त करता है।

दूसरे शब्दों में, अपने पसंदीदा संपादक के बारे में जानने में समय व्यतीत करें। पता लगाएं कि वह या उसका विकास समुदाय YAML के साथ काम करने के लिए क्या पेशकश कर सकता है, और उन सुविधाओं का उपयोग करें। आपको निश्चित रूप से इसका पछतावा नहीं होगा।

1. लिंटर का प्रयोग करें

आदर्श रूप से, प्रोग्रामिंग भाषाएं और मार्कअप भाषाएं पूर्वानुमानित वाक्यविन्यास का उपयोग करती हैं। कंप्यूटर पूर्वानुमेयता में अच्छे हैं, यही कारण है कि इसकी अवधारणा लिन्टेरा. यदि अपने अस्तित्व के 40 वर्षों में यह आपके पास से गुजर चुका है और आप अभी भी YAML लिंटर का उपयोग नहीं करते हैं, तो यह yamllint को आज़माने का समय है।

स्थापित करने के लिए yamlint आप मानक लिनक्स पैकेज मैनेजर का उपयोग कर सकते हैं। उदाहरण के लिए, में Red Hat Enterprise Linux 8 या फेडोरा यह इस प्रकार किया गया है:

$ 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. पायथन में लिखें, YAML में नहीं

यदि YAML वास्तव में आपको परेशान करता है, तो इसमें शाब्दिक रूप से न लिखें। ऐसा होता है कि YAML ही एकमात्र प्रारूप है जिसे एप्लिकेशन समझता है। लेकिन इस मामले में भी, YAML फ़ाइल बनाना आवश्यक नहीं है। आपको जो पसंद है उस पर लिखें और फिर रूपांतरित करें। उदाहरण के लिए, Python के लिए एक बेहतरीन लाइब्रेरी है pyyaml और दो रूपांतरण विधियाँ: स्व-रूपांतरण और स्क्रिप्ट के माध्यम से रूपांतरण।

आत्म रूपांतरण

इस मामले में, डेटा फ़ाइल भी एक पायथन स्क्रिप्ट है जो YAML उत्पन्न करती है। यह विधि छोटे डेटा सेट के लिए सबसे उपयुक्त है। आप बस JSON डेटा को पायथन वेरिएबल में लिखते हैं, इसे एक आयात निर्देश के साथ प्रस्तुत करते हैं, और फ़ाइल के अंत में आउटपुट को लागू करने के लिए तीन पंक्तियाँ जोड़ते हैं।

#!/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 में चलाते हैं और आउटपुट.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 आपको चेतावनी देगा कि यह - से शुरू नहीं होता है। खैर, इसे आसानी से मैन्युअल रूप से ठीक किया जा सकता है या पायथन लिपि में थोड़ा संशोधित किया जा सकता है।

स्क्रिप्ट के माध्यम से रूपांतरण

इस मामले में, हम पहले JSON में लिखते हैं, और फिर कनवर्टर को एक अलग पायथन स्क्रिप्ट के रूप में चलाते हैं, जो आउटपुट के रूप में 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 पायथन मॉड्यूल दोनों को आयात करती है, और उपयोगकर्ता द्वारा निर्दिष्ट JSON फ़ाइल को लोड करती है, रूपांतरण करती है, और डेटा को आउटपुट.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 में परिवर्तित कर सकते हैं। मान लीजिए कि आपके पास एक 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.org और विशिष्टताओं (विनिर्देशों) को फिर से पढ़ें। यदि आपको YAML के साथ कठिनाइयाँ हैं, लेकिन आप विनिर्देशन तक नहीं पहुँच पाए हैं, तो इस स्थिति को ठीक करने का समय आ गया है। विशिष्टताओं को लिखना आश्चर्यजनक रूप से आसान है, और वाक्यविन्यास आवश्यकताओं को बड़ी संख्या में उदाहरणों के साथ चित्रित किया गया है अध्याय 6.

5. छद्म विन्यास

कोई किताब या लेख लिखते समय, पहले एक प्रारंभिक रूपरेखा तैयार करना हमेशा उपयोगी होता है, कम से कम सामग्री की तालिका के रूप में। YAML के साथ भी ऐसा ही है. सबसे अधिक संभावना है, आपको इस बात का अंदाजा है कि YAML फ़ाइल में किस डेटा को लिखने की आवश्यकता है, लेकिन आप वास्तव में यह नहीं समझते हैं कि इसे एक दूसरे से कैसे जोड़ा जाए। इसलिए, YAML को तराशने से पहले, एक छद्म विन्यास बनाएं।

स्यूडो-कॉन्फिग स्यूडो-कोड के समान है, जहां आपको संरचना या इंडेंटेशन, माता-पिता-बच्चे के रिश्ते, विरासत और नेस्टिंग के बारे में चिंता करने की ज़रूरत नहीं है। यहाँ भी वैसा ही है: जैसे ही डेटा आपके दिमाग में उठता है, आप उसकी पुनरावृत्तियाँ बनाते हैं।

छद्म-कॉन्फिग लिस्टिंग प्रोग्रामर (मार्टिन और टैबीथा) और उनके कौशल (प्रोग्रामिंग भाषाएँ: क्रमशः पायथन, पर्ल, पास्कल और लिस्प, फोरट्रान, एरलांग)।

कागज के एक टुकड़े पर एक छद्म कॉन्फ़िगरेशन बनाने के बाद, इसका सावधानीपूर्वक विश्लेषण करें और, यदि सब कुछ क्रम में है, तो इसे एक वैध YAML फ़ाइल के रूप में प्रारूपित करें।

6. टैब्स बनाम स्पेसेस दुविधा

आपको दुविधा का समाधान करना होगा "टैब या रिक्त स्थान?". वैश्विक अर्थ में नहीं, बल्कि केवल आपके संगठन के स्तर पर, या कम से कम एक परियोजना के स्तर पर। इससे कोई फर्क नहीं पड़ता कि इसमें सेड स्क्रिप्ट के साथ पोस्ट-प्रोसेसिंग का उपयोग करना, प्रोग्रामर की मशीनों पर टेक्स्ट एडिटर्स स्थापित करना, या बर्खास्तगी की धमकी के तहत लिंटर के निर्देशों के सख्त अनुपालन की सार्वभौमिक रसीद लेना शामिल है, लेकिन आपकी टीम के सभी सदस्य जो इसमें शामिल हैं किसी भी तरह से YAML से संबंधित लोगों को केवल रिक्त स्थान का उपयोग करना चाहिए (जैसा कि YAML विनिर्देश द्वारा आवश्यक है)।

किसी भी सामान्य पाठ संपादक में, आप ऑटो-सही टैब को निर्दिष्ट संख्या में रिक्त स्थान पर कॉन्फ़िगर कर सकते हैं, इसलिए कुंजी अनुयायियों का विद्रोह टैब आपको डरने की जरूरत नहीं है.

जैसा कि प्रत्येक YAML से नफरत करने वाला अच्छी तरह से जानता है, आप स्क्रीन पर टैब और रिक्त स्थान के बीच अंतर नहीं देख सकते हैं। और जब कुछ दिखाई नहीं देता है, तो यह आम तौर पर आखिरी चीज होती है जिसे लोग याद रखते हैं, जब वे अन्य सभी संभावित समस्याओं को हल कर लेते हैं, जांच लेते हैं और समाप्त कर देते हैं। सारणीकरण वक्र या रिक्त स्थान के ब्लॉक की खोज में बिताया गया एक घंटा बस चिल्लाता है कि आपको तत्काल एक या दूसरे के उपयोग के लिए एक नीति बनाने की आवश्यकता है, और फिर इसके अनुपालन के लिए एक प्रबलित कंक्रीट जांच लागू करें (उदाहरण के लिए, के माध्यम से) लिंटर के माध्यम से इसे मजबूर करने के लिए एक गिट हुक)।

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 को एक अलग प्रारूप में बदलना उचित हो सकता है। समय के साथ, कॉन्फ़िगरेशन फ़ाइलें स्वयं बड़ी हो सकती हैं और फिर उन्हें लुआ या पायथन में सरल स्क्रिप्ट में परिवर्तित करना बेहतर होता है।

YAML एक बेहतरीन चीज़ है जिसे बहुत से लोग इसके अतिसूक्ष्मवाद और सरलता के कारण पसंद करते हैं, लेकिन यह आपके शस्त्रागार में एकमात्र उपकरण से बहुत दूर है। इसलिए कभी-कभी आप इसे मना भी कर सकते हैं. YAML के लिए पार्सिंग लाइब्रेरी ढूंढना आसान है, इसलिए यदि आप आसान माइग्रेशन विकल्प प्रदान करते हैं, तो आपके उपयोगकर्ता इस विफलता से अपेक्षाकृत दर्द रहित तरीके से बच जाएंगे।

यदि आप YAML के बिना काम नहीं कर सकते, तो इन 10 युक्तियों को अपनाएं और YAML के प्रति अपनी नापसंदगी को हमेशा के लिए दूर कर लें!

स्रोत: www.habr.com

YAML ज़ेन के लिए 10 कदम