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-এ ইন্ডেন্ট সেট করা।

একটি প্লাগইন ড্র স্পেস Gedit-এর জন্য, এটি বিন্দু হিসাবে স্পেস প্রদর্শন করে, ইন্ডেন্টেশন স্তরের সাথে অস্পষ্টতা দূর করে।

অন্য কথায়, আপনার প্রিয় সম্পাদক শিখতে সময় নিন। YAML এর সাথে কাজ করার জন্য তিনি বা তার উন্নয়ন সম্প্রদায় কী অফার করতে হবে তা খুঁজে বের করুন এবং এই সুযোগগুলির সদ্ব্যবহার করুন। আপনি অবশ্যই এটি অনুশোচনা করবেন না.

1. একটি লিন্টার ব্যবহার করুন

আদর্শভাবে, প্রোগ্রামিং ভাষা এবং মার্কআপ ভাষাগুলি অনুমানযোগ্য সিনট্যাক্স ব্যবহার করে। কম্পিউটারগুলি ভবিষ্যদ্বাণীতে ভাল, যে কারণে 1978 সালে ধারণাটি উত্থিত হয়েছিল লিন্টার. যদি এটির অস্তিত্বের 40 বছরের মধ্যে এটি আপনাকে অতিক্রম করে যায় এবং আপনি এখনও YAML লিন্টার ব্যবহার না করেন, তাহলে ইয়ামলিন্ট চেষ্টা করার সময় এসেছে।

স্থাপন করা ইয়ামলিন্ট আপনি নেটিভ লিনাক্স প্যাকেজ ম্যানেজার ব্যবহার করতে পারেন। উদাহরণস্বরূপ, মধ্যে Red Hat Enterprise Linux 8 বা ফেডোরা এটি এভাবে করা হয়:

$ sudo dnf install 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 ফাইল তৈরি করার প্রয়োজন নেই। আপনি যা পছন্দ করেন তা লিখুন এবং তারপরে রূপান্তর করুন। উদাহরণস্বরূপ, পাইথনের জন্য একটি দুর্দান্ত লাইব্রেরি রয়েছে 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

এখন আমরা পাইথনে এই ফাইলটি রান করি এবং 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 এর সাথে সমস্যা হয় তবে আপনার হাত স্পেসিফিকেশনে পৌঁছে না, তাহলে এই পরিস্থিতি সংশোধন করার সময় এসেছে। চশমা লিখতে আশ্চর্যজনকভাবে সহজ, এবং সিনট্যাক্সের প্রয়োজনীয়তাগুলি প্রচুর উদাহরণ দিয়ে চিত্রিত করা হয়েছে অধ্যায় 6.

5. Pseudoconfigs

একটি বই বা নিবন্ধ লেখার সময়, সর্বদা একটি প্রাথমিক রূপরেখা প্রথমে স্কেচ করা একটি ভাল ধারণা, অন্তত একটি বিষয়বস্তুর সারণী আকারে৷ YAML এর সাথে একই। সম্ভবত, YAML ফাইলে কী ডেটা লিখতে হবে সে সম্পর্কে আপনার ধারণা আছে, তবে কীভাবে সেগুলি একে অপরের সাথে সম্পর্কিত করা যায় তা সত্যিই বুঝতে পারছেন না। অতএব, YAML ভাস্কর্য করার আগে, একটি ছদ্ম-কনফিগ আঁকুন।

Pseudoconfig হল pseudocode এর মত যেখানে আপনাকে গঠন বা ইন্ডেন্টেশন, পিতা-মাতা-সন্তানের সম্পর্ক, উত্তরাধিকার এবং নেস্টিং নিয়ে চিন্তা করতে হবে না। সুতরাং এটি এখানে: আপনি ডেটার পুনরাবৃত্তিগুলি আঁকবেন যেমন সেগুলি আপনার মাথায় উপস্থিত হয়।

Pseudoconfig তালিকাভুক্ত প্রোগ্রামার (মার্টিন এবং তাবিথা) এবং তাদের দক্ষতা (প্রোগ্রামিং ভাষা: Python, Perl, Pascal এবং Lisp, Fortran, Erlang, যথাক্রমে)।

কাগজের টুকরোতে একটি ছদ্ম-কনফিগ আঁকলে, সাবধানে এটি বিশ্লেষণ করুন এবং, যদি সবকিছু ঠিকঠাক থাকে তবে এটিকে একটি বৈধ YAML ফাইল হিসাবে ফর্ম্যাট করুন।

6. ট্যাব বা স্পেস দ্বিধা

আপনাকে একটি দ্বিধা সমাধান করতে হবে "ট্যাব বা স্পেস?". বৈশ্বিক অর্থে নয়, তবে শুধুমাত্র আপনার সংস্থার স্তরে বা অন্তত একটি প্রকল্প। এটা কোন ব্যাপার না যে এটি একটি sed স্ক্রিপ্টের সাথে পোস্ট-প্রসেসিং, প্রোগ্রামারদের মেশিনে টেক্সট এডিটর সেট আপ করা, বা বরখাস্ত হওয়ার হুমকির মধ্যে লিন্টারের নির্দেশাবলী কঠোরভাবে মেনে চলার জন্য সম্পূর্ণরূপে রসিদ নেওয়া জড়িত, তবে আপনার দলের সকল সদস্য যারা 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 স্পেসিফিকেশন অনুযায়ী এটিকে ন্যূনতম সম্ভব রাখুন। উদাহরণস্বরূপ, উত্তরযোগ্য ডকুমেন্টেশন থেকে উপরের ফাইলটি কোনও ক্ষতি ছাড়াই এভাবে পুনরায় লেখা যেতে পারে:

---
- 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