🏇 👎🏿 🧛🏼 यमल ज़ेन के 10 कदम 🖕 ❇️ 👱🏿

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

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

0. अपना संपादक काम करें

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

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

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

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

Gedit इंडेंटेशन सेटिंग्स।

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

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

1. एक लाइनर (लिंटर) का उपयोग करें

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

आप मानक लिनक्स पैकेज प्रबंधक का उपयोग करके याम्लिंट स्थापित कर सकते हैं। उदाहरण के लिए, Red Hat Enterprise Linux 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 perfect.yaml && echo "OK" OK

POSIX में, एक डबल एम्परसेंड ट्रिगर होता है यदि और केवल तभी जब पिछला कमांड वापस आता है 0. और याम्लिंट बस मिली त्रुटियों की संख्या लौटाता है, इसलिए यह संपूर्ण सशर्त निर्माण कार्य करता है।

2. पायथन में लिखें, न कि YAML

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

Samokonvertirovanie

इस मामले में, डेटा फ़ाइल भी पायथन स्क्रिप्ट है जो 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

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

लिपियों के माध्यम से परिवर्तित करें

इस मामले में, हम पहले 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 को Python इंटरैक्टिव शेल में सिर्फ दो कमांड के साथ 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 Road\n', '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 को मूर्तिकला करने से पहले, एक छद्म विन्यास बनाएं।

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

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

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

6. टैब या दुविधा दुविधा

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

किसी भी सामान्य पाठ संपादक में, आप निर्दिष्ट स्थानों पर स्वतः सुधारक टैब सेट कर सकते हैं, जिससे आप टैब दंगों से डर नहीं सकते।

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

7. बेहतर कम बेहतर है (या अधिक कम है)

कुछ लोग YAML में लिखना पसंद करते हैं क्योंकि यह संरचना पर जोर देता है। उसी समय, वे सक्रिय रूप से डेटा ब्लॉकों को उजागर करने के लिए इंडेंटेशन का उपयोग करते हैं। यह मार्कअप भाषाओं का अनुकरण करने के लिए एक प्रकार का घोटाला है जो स्पष्ट सीमांकक का उपयोग करता है।

यहाँ इस तरह की संरचितता का एक उदाहरण Ansible प्रलेखन से लिया गया है :

 # 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 के बिना नहीं कर सकते हैं, तो इन 10 युक्तियों को सेवा में लें और एक बार और सभी के लिए YAML के अपने नापसंद को हराएं!

यमल ज़ेन के 10 कदम