YAML Zen을 위한 10단계

우리 모두는 Ansible을 좋아하지만 Ansible은 YAML입니다. 구성 파일에는 값 목록, 매개변수-값 쌍, INI 파일, YAML, JSON, XML 등 다양한 형식이 있습니다. 그러나 그 중에서도 여러 가지 이유로 인해 YAML은 특히 어려운 것으로 간주되는 경우가 많습니다. 특히 계층적 값 작업을 위한 상쾌한 미니멀리즘과 인상적인 기능에도 불구하고 YAML 구문은 들여쓰기에 대한 Python과 유사한 접근 방식으로 인해 짜증스러울 수 있습니다.

YAML이 당신을 화나게 한다면 그렇게 할 수 있습니다. 그리고 그렇게 해야 합니다! – 좌절감을 허용 가능한 수준으로 줄이고 YAML과 사랑에 빠지려면 다음 10단계를 따르세요. 이 목록에 걸맞게 우리의 XNUMX가지 팁은 처음부터 번호가 매겨져 있으며 마음대로 명상과 영적 수행을 추가할 것입니다 😉

0. 편집기를 작동하게 만드세요

어떤 텍스트 편집기를 사용하든 상관없이 YAML 작업을 위한 플러그인이 하나 이상 있을 것입니다. 없는 경우 즉시 찾아 설치하십시오. 검색 및 설정에 소요된 시간은 YAML을 편집해야 할 때마다 여러 번 보상을 받게 됩니다.

예를 들어 편집자 원자 기본적으로 YAML을 지원하지만 GNU Emacs의 경우 추가 패키지를 설치해야 합니다. 예를 들면 다음과 같습니다. yaml 모드.

YAML 모드의 Emacs 및 공백 표시.

즐겨 사용하는 편집기에 YAML 모드가 없으면 설정 작업을 통해 일부 문제를 해결할 수 있습니다. 예를 들어 표준 GNOME 텍스트 편집기 Gedit에는 YAML 모드가 없지만 기본적으로 YAML 구문을 강조 표시하고 들여쓰기 작업을 구성할 수 있습니다.

Gedit에서 들여쓰기를 설정합니다.

플러그인 서랍 공간 Gedit의 경우 공백을 점으로 표시하여 들여쓰기 수준의 모호성을 제거합니다.

즉, 좋아하는 편집기에 대해 배우는 데 시간을 투자하세요. 그 또는 그의 개발 커뮤니티가 YAML 작업을 위해 무엇을 제공하는지 알아보고 해당 기능을 사용하십시오. 당신은 확실히 그것을 후회하지 않을 것입니다.

1. 린터를 사용하세요

이상적으로 프로그래밍 언어와 마크업 언어는 예측 가능한 구문을 사용합니다. 컴퓨터는 예측 가능성에 뛰어나기 때문에 린테라. 40년 동안 존재했지만 여전히 YAML 린터를 사용하지 않는다면 yamllint를 사용해 볼 시간입니다.

설치 얌린트 표준 Linux 패키지 관리자를 사용할 수 있습니다. 예를 들어, 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가 파일에서 오류를 찾지 못하면 화면에 아무것도 인쇄되지 않습니다. 이러한 침묵이 두렵고 좀 더 피드백을 원할 경우 다음과 같이 이중 앰퍼샌드(&&)를 통해 조건부 echo 명령을 사용하여 linter를 실행할 수 있습니다.

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

POSIX에서는 이전 명령이 0을 반환하는 경우에만 이중 앰퍼샌드가 실행됩니다. 그리고 yamllint는 발견된 오류 수만 반환하므로 이 전체 조건부 구성이 작동합니다.

2. YAML이 아닌 Python으로 작성

YAML이 정말로 당신을 화나게 한다면 문자 그대로 쓰지 마십시오. YAML은 애플리케이션이 이해하는 유일한 형식입니다. 하지만 이 경우에도 YAML 파일을 생성할 필요는 없습니다. 당신이 좋아하는 것을 쓴 다음 변환하십시오. 예를 들어 Python을 위한 훌륭한 라이브러리가 있습니다. 피얌 변환 방법에는 자체 변환과 스크립트를 통한 변환의 두 가지가 있습니다.

자기 전환

이 경우 데이터 파일은 YAML을 생성하는 Python 스크립트이기도 합니다. 이 방법은 작은 데이터 세트에 가장 적합합니다. JSON 데이터를 Python 변수에 작성하고, 앞에 import 지시문을 추가하고, 파일 끝에 세 줄을 추가하여 출력을 구현하면 됩니다.

#!/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는 -로 시작하지 않는다는 경고를 표시합니다. 글쎄, 이것은 수동으로 쉽게 수정되거나 Python 스크립트에서 약간 수정될 수 있습니다.

스크립트를 통한 변환

이 경우 먼저 JSON으로 작성한 다음 변환기를 별도의 Python 스크립트로 실행하여 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 작업에 익숙하다면 대화형 Python 셸에서 단 두 개의 명령만 사용하여 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 그리고 스펙(specs)을 다시 읽어보세요. YAML에 어려움이 있지만 사양에 도달하지 못했다면 이제 이 상황을 수정해야 할 때입니다. 사양은 놀라울 정도로 작성하기 쉽고 구문 요구 사항은 다음의 많은 예제를 통해 설명됩니다. 제 6 장.

5. 의사 구성

책이나 기사를 작성할 때 최소한 목차 형태로 먼저 예비 개요를 그리는 것이 항상 유용합니다. YAML도 마찬가지입니다. 대부분의 경우 YAML 파일에 어떤 데이터를 기록해야 하는지 알고 있지만 이를 서로 연결하는 방법은 실제로 이해하지 못합니다. 따라서 YAML을 조각하기 전에 의사 구성을 그립니다.

의사 구성은 구조나 들여쓰기, 부모-자식 관계, 상속 및 중첩에 대해 걱정할 필요가 없는 의사 코드와 유사합니다. 여기에서도 마찬가지입니다. 머리 속에 데이터가 나타날 때마다 데이터를 반복해서 그립니다.

의사 구성 목록 프로그래머(Martin 및 Tabitha) 및 해당 기술(프로그래밍 언어: Python, Perl, Pascal 및 Lisp, Fortran, Erlang 각각).

종이에 의사 구성을 그린 후 주의 깊게 분석하고 모든 것이 정상이면 유효한 YAML 파일 형식으로 형식을 지정합니다.

6. 탭과 공백의 딜레마

딜레마를 해결해야 할 것이다. “탭이냐 공백이냐?”. 글로벌한 의미는 아니지만 조직 수준이나 최소한 프로젝트 수준에서만 가능합니다. 여기에는 sed 스크립트를 사용한 후처리 사용, 프로그래머 컴퓨터에 텍스트 편집기 설정, 해고 위협 하에 linter의 지침을 엄격하게 준수했다는 영수증을 보편적으로 받는 것이 포함되는지 여부는 중요하지 않습니다. 어떤 방식으로든 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 사양에 따라 가능한 한 최소한으로 유지하세요. 예를 들어, 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을 다른 형식으로 변경하는 것이 좋습니다. 시간이 지남에 따라 구성 파일이 자체적으로 커질 수 있으므로 Lua 또는 Python의 간단한 스크립트로 변환하는 것이 좋습니다.

YAML은 미니멀리즘과 단순성으로 인해 많은 사람들이 좋아하는 훌륭한 도구이지만 무기고의 유일한 도구는 아닙니다. 그래서 때로는 거절할 수도 있습니다. YAML에 대한 구문 분석 라이브러리는 쉽게 찾을 수 있으므로 손쉬운 마이그레이션 옵션을 제공하면 사용자는 비교적 어려움 없이 이러한 실패를 극복할 수 있습니다.

YAML 없이는 할 수 없다면 다음 10가지 팁을 활용하여 YAML에 대한 혐오감을 완전히 극복하세요!

출처 : habr.com