YAML Zen मा 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 मा इन्डेन्टहरू सेट गर्दै।

एक प्लगइन ड्रस्पेसहरू Gedit को लागि, बिन्दुको रूपमा खाली ठाउँहरू देखाउँदछ, इन्डेन्टेसन स्तरहरूसँग अस्पष्टताहरू हटाउँदै।

अर्को शब्दमा, आफ्नो मनपर्ने सम्पादकको बारेमा सिक्न समय खर्च गर्नुहोस्। YAML सँग काम गर्नको लागि उसले वा उसको विकास समुदायले के प्रस्ताव गरेको छ पत्ता लगाउनुहोस्, र ती सुविधाहरू प्रयोग गर्नुहोस्। तपाई पक्कै पनि पछुताउनुहुने छैन।

1. एक लिन्टर प्रयोग गर्नुहोस्

आदर्श रूपमा, प्रोग्रामिङ भाषाहरू र मार्कअप भाषाहरूले अनुमानित वाक्यविन्यास प्रयोग गर्छन्। कम्प्युटरहरू भविष्यवाणी गर्नमा राम्रो छन्, त्यसैले यसको अवधारणा lintera। यदि यसको अस्तित्व को 40 वर्ष मा यो तपाईं द्वारा बितिसकेको छ र तपाईं अझै पनि YAML linter प्रयोग गर्नुहुन्न, तब यो yamllint प्रयास गर्ने समय हो।

स्थापना गर्नुहोस् yamllint तपाईं मानक लिनक्स प्याकेज प्रबन्धक प्रयोग गर्न सक्नुहुन्छ। उदाहरण को लागी, मा Red Hat Enterprise Linux 8 वा फेडोरा यो यस्तो भयो:

$ sudo dnf install yamllint

त्यसो भए तपाईले केवल yamllint चलाउनुहोस्, यसलाई जाँच गर्न YAML फाइल पास गर्दै। यदि तपाईंले linter मा त्रुटि भएको फाइल पास गर्नुभयो भने यस्तो देखिन्छ:

$ 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 मा, एक डबल एम्परसेन्ड फायर हुन्छ यदि र अघिल्लो आदेशले ० फर्काउँछ भने मात्र। र yamllint ले फेला परेको त्रुटिहरूको संख्या मात्र फर्काउँछ, त्यसैले यो सम्पूर्ण सशर्त निर्माण कार्य गर्दछ।

2. Python मा लेख्नुहोस्, YAML होइन

यदि YAML ले तपाईंलाई साँच्चै पिसाब दियो भने, त्यसमा शाब्दिक रूपमा नलेख्नुहोस्। यो हुन्छ कि YAML मात्र ढाँचा हो जुन अनुप्रयोगले बुझ्दछ। तर यस अवस्थामा पनि, यो YAML फाइल सिर्जना गर्न आवश्यक छैन। तपाईलाई मनपर्ने कुरामा लेख्नुहोस् र त्यसपछि रूपान्तरण गर्नुहोस्। उदाहरण को लागी, पाइथन को लागी एक महान पुस्तकालय छ 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 मा चलाउँछौं र 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 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 मा अन्तरक्रियात्मक पाइथन शेलमा दुईवटा आदेशहरू प्रयोग गरेर रूपान्तरण गर्न सक्नुहुन्छ। मानौं तपाईंसँग 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 सँग कठिनाइहरू छन्, तर स्पेसिफिकेशनको वरिपरि पुग्नु भएको छैन, तब यो अवस्था सुधार्ने समय हो। चश्मा लेख्न आश्चर्यजनक रूपमा सजिलो छ, र वाक्य रचना आवश्यकताहरू उदाहरणहरूको ठूलो संख्यामा चित्रण गरिएको छ। ग्लाभ ३.

5. छद्म कन्फिगहरू

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

स्यूडो-कन्फिग स्यूडो-कोडसँग मिल्दोजुल्दो छ, जहाँ तपाईंले संरचना वा इन्डेन्टेसन, अभिभावक-बच्चा सम्बन्ध, विरासत र नेस्टिङको बारेमा चिन्ता लिनु पर्दैन। यो यहाँ उस्तै छ: तपाईंले डाटाको पुनरावृत्तिहरू कोर्नुहोस् जब तिनीहरू तपाईंको टाउकोमा उठ्छन्।

स्यूडो-कन्फिगिङ सूचीबद्ध प्रोग्रामरहरू (मार्टिन र ताबिथा) र तिनीहरूका सीपहरू (प्रोग्रामिङ भाषाहरू: पाइथन, पर्ल, पास्कल र लिस्प, फोरट्रान, एर्लांग, क्रमशः)।

कागजको टुक्रामा छद्म कन्फिगरेसन कोरिसकेपछि, यसलाई ध्यानपूर्वक विश्लेषण गर्नुहोस् र, यदि सबै कुरा व्यवस्थित छ भने, यसलाई वैध YAML फाइलको रूपमा ढाँचा गर्नुहोस्।

6. ट्याबहरू बनाम स्पेसेस दुविधा

दुविधा समाधान गर्नु पर्नेछ "ट्याबहरू वा खाली ठाउँहरू?"। विश्वव्यापी अर्थमा होइन, तर केवल तपाईंको संगठनको स्तरमा, वा कम्तिमा एउटा परियोजना। यसले sed स्क्रिप्टको साथ पोस्ट-प्रोसेसिङ प्रयोग गर्ने, प्रोग्रामरहरूको मेसिनमा पाठ सम्पादकहरू सेटअप गर्ने, वा खारेजीको खतरामा लिन्टरको निर्देशनहरूको कडा अनुपालनको विश्वव्यापी रूपमा रसिदहरू लिने कुरा समावेश गर्दैन, तर तपाईंको टोलीका सबै सदस्यहरू जसले एक तरिका वा अर्को 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 विशिष्टता अनुसार यसलाई न्यूनतममा राख्नुहोस्। उदाहरणका लागि, उत्तरदायी कागजातबाट माथिको फाइल कुनै पनि हानि बिना यसरी पुन: लेख्न सकिन्छ:

---
- 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 एउटा ठूलो चीज हो जुन धेरै मानिसहरूले यसको minimalism र सादगीको लागि मन पराउँछन्, तर यो तपाईंको शस्त्रागारको एक मात्र उपकरणबाट टाढा छ। त्यसैले कहिलेकाहीँ तपाईं यसलाई अस्वीकार गर्न सक्नुहुन्छ। पार्सिङ लाइब्रेरीहरू YAML को लागि फेला पार्न सजिलो छ, त्यसैले यदि तपाइँ सजिलो माइग्रेसन विकल्पहरू प्रस्ताव गर्नुहुन्छ भने, तपाइँका प्रयोगकर्ताहरू यस असफलतालाई अपेक्षाकृत पीडारहित रूपमा बाँच्नेछन्।

यदि तपाईं YAML बिना गर्न सक्नुहुन्न भने, त्यसपछि यी 10 सुझावहरू लिनुहोस् र YAML लाई एक पटक र सबैको लागि आफ्नो मन नपराउनेलाई जित्नुहोस्!

स्रोत: www.habr.com