YAML 語言教程與使用案例
阿新 • • 發佈：2020-07-11
YAML語言教程與使用案例，如何編與讀懂寫YAML檔案。
YAML概要
YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一種標記語言）的遞迴縮寫。在開發的這種語言時，YAML 的意思其實是：”Yet Another Markup Language”（仍是一種標記語言）。
YAML是一個類似 XML、JSON 的標記性語言。YAML 強調以資料為中心，並不是以標識語言為重點。因而 YAML 本身的定義比較簡單，號稱“一種人性化的資料格式語言”。
基本語法
1、大小寫敏感
2、使用縮排表示層級關係
3、縮排時不允許使用Tab鍵，只允許使用空格
4、縮排的空格數不重要，只要相同層級的元素左側對齊即可。【實際使用中建議兩個空格作為一個層級的縮排】
5、# 表示註釋，從這個字元一直到行尾，都會被直譯器忽略
6、冒號，以冒號結尾除外，其他所有冒號後面必須有空格
7、短橫線，表示列表項，使用一個短橫線加一個空格；多個項使用同樣的縮排級別作為同一列表
支援的資料結構
1、物件：鍵值對的集合，又稱為對映（mapping）/ 雜湊（hashes） / 字典（dictionary）
2、陣列：一組按次序排列的值，又稱為序列（sequence） / 列表（list）
3、字面量/純量（數字、字串、布林值）(scalars)：單個的、不可再分的值
YAML 組織結構
YAML 檔案可以由一或多個文件組成（即相對獨立的組織結構組成），文件間使用“---”（三個橫線）在每文件開始作為分隔符(可選)。同時，文件也可以使用“...”（三個點號）作為結束符（可選）。如下圖所示：
備註：如果只是單個文件，分隔符“---”可省略。
每個文件並不需要使用結束符“...”來表示結束，但是對於網路傳輸或者流來說，有明確結束的符號，有利於軟體處理。（例如不需要知道流關閉就能知道文件結束）
Python中yaml模組的使用
Python pip 安裝
如果未安裝pip，則可以使用以下方法來安裝：
1 # curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py # 下載安裝指令碼 2 # python get-pip.py # 執行安裝指令碼 或則：python3 get-pip.py 根據使用的Python決定 3 # pip --version # 版本檢視
用哪個版本的 Python 執行安裝指令碼，pip 就被關聯到哪個版本。
pip安裝yaml與匯入
安裝pyyaml
# pip install pyyaml # 或者pip3 install pyyaml
檢查是否安裝成功：
1、命令列輸入：python
2、再輸入：import yaml
安裝成功後，在腳本里匯入的語句，都是 import yaml
YAML-物件資料型別
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
物件資料：是一組鍵值對，使用冒號結構表示。
單個物件文件檔案
yaml檔案
1 [root@docker02 yaml]# cat demo_01_obj.yml 2 --- 3 name: zhang 4 age: 22
Python解析
1 [root@docker02 yaml]# cat demo_01_obj.py 2 #!/usr/bin/env python 3 # -*- coding: utf-8 -*- 4 # Author: zhang 5 6 import yaml 7 8 file_path = "./demo_01_obj.yml" 9 file = open(file_path, 'r') 10 ys = yaml.load(file.read(), Loader=yaml.Loader) 11 print ys
輸出結果
1 [root@docker02 yaml]# python demo_01_obj.py
2 {'age': 22, 'name': 'zhang'}
多個物件文件檔案
yaml檔案，仔細對比下加了”---“和”...“ 的區別
1 [root@docker02 yaml]# cat demo_02_obj.yml
2 ---
3 name: zhang
4 age: 22
5 ...
6 ---
7 name: Jane
8 age: 20
9 key:
10 child-key: value
11 child-key2: value2
12 ...
13 ---
14 obj: {obj_key1: value1, obj_key2: value2}
15 ...
Python解析
1 [root@docker02 yaml]# cat demo_02_obj.py 2 #!/usr/bin/env python 3 # -*- coding: utf-8 -*- 4 # Author: zhang 5 6 import yaml 7 import json 8 9 file_path = "demo_02_obj.yml" 10 file = open(file_path, 'r') 11 12 ys = yaml.load_all(file.read(), Loader=yaml.Loader) 13 for y in ys: 14 # 兩種列印方式都嘗試下 15 #print y 16 print json.dumps(y, indent=2)
輸出結果
1 [root@docker02 yaml]# python demo_02_obj.py
2 {'age': 22, 'name': 'zhang'}
3 {'age': 20, 'name': 'Jane', 'key': {'child-key2': 'value2', 'child-key': 'value'}}
4 {'obj': {'obj_key1': 'value1', 'obj_key2': 'value2'}}
5 # 或者如下
6 [root@docker02 yaml]# python demo_02_obj.py
7 {
8 "age": 22,
9 "name": "zhang"
10 }
11 {
12 "age": 20,
13 "name": "Jane",
14 "key": {
15 "child-key2": "value2",
16 "child-key": "value"
17 }
18 }
19 {
20 "obj": {
21 "obj_key1": "value1",
22 "obj_key2": "value2"
23 }
24 }
YAML-陣列資料型別
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
陣列型別：一組連詞線開頭的行，構成一個數組
yaml檔案
1 [root@docker02 yaml]# cat demo_03_list.yml 2 # 書寫方式1 3 color: 4 - red 5 - blue 6 - green 7 - orange 8 - white 9 # 書寫方式2：行內表示法 10 fruits: [orange, apple, banana]
Python解析
1 [root@docker02 yaml]# cat demo_03_list.py 2 #!/usr/bin/env python 3 # -*- coding: utf-8 -*- 4 # Author: zhang 5 6 import yaml 7 import json 8 9 file_path = "demo_03_list.yml" 10 file = open(file_path, 'r') 11 12 ys = yaml.load_all(file.read(), Loader=yaml.Loader) 13 for y in ys: 14 # 兩種列印方式都嘗試下 15 #print y 16 print json.dumps(y, indent=2)
輸出結果
1 [root@docker02 yaml]# python demo_03_list.py
2 {'color': ['red', 'blue', 'green', 'orange', 'white'], 'fruits': ['orange', 'apple', 'banana']}
3 # 或者結果如下
4 [root@docker02 yaml]# python demo_03_list.py
5 {
6 "color": [
7 "red",
8 "blue",
9 "green",
10 "orange",
11 "white"
12 ],
13 "fruits": [
14 "orange",
15 "apple",
16 "banana"
17 ]
18 }
YAML-複合結構
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
複合結構：物件和陣列可以結合使用，形成複合結構
yaml檔案，注意其書序格式，並細細對比輸出結果
1 [root@docker02 yaml]# cat demo_04_compose.yml 2 shop: GoodShopping 3 address: BJ 4 goods: 5 Food: 6 - sell_time: "AM 08:30" 7 food01: rice 8 food02: pork 9 Fruits: 10 - sell_time: "AM 09:00" 11 - fruit01: orange 12 price: 3.50 13 - fruit02: banana 14 price: 3.00 15 clothes: 16 - sell_time: "AM 09:30" 17 - clothe01 18 - clothe02
Python解析
1 [root@docker02 yaml]# cat demo_04_compose.py 2 #!/usr/bin/env python 3 # -*- coding: utf-8 -*- 4 # Author: zhang 5 6 import yaml 7 import json 8 9 file_path = "demo_04_compose.yml" 10 file = open(file_path, 'r') 11 12 ys = yaml.load_all(file.read(), Loader=yaml.Loader) 13 for y in ys: 14 # 兩種列印方式都嘗試下 15 print y 16 #print json.dumps(y, indent=2)
輸出結果，仔細對比下
1 [root@docker02 yaml]# python demo_04_compose.py
2 {'shop': 'GoodShopping', 'goods': {'Food': [{'food02': 'pork', 'sell_time': 'AM 08:30', 'food01': 'rice'}], 'Fruits': [{'sell_time': 'AM 09:00'}, {'fruit01': 'orange', 'price': 3.5}, {'price': 3.0, 'fruit02': 'banana'}], 'clothes': [{'sell_time': 'AM 09:30'}, 'clothe01', 'clothe02']}, 'address': 'BJ'}
3 # 或者結果如下
4 [root@docker02 yaml]# python demo_04_compose.py
5 {
6 "shop": "GoodShopping",
7 "goods": {
8 "Food": [
9 {
10 "food02": "pork",
11 "sell_time": "AM 08:30",
12 "food01": "rice"
13 }
14 ],
15 "Fruits": [
16 {
17 "sell_time": "AM 09:00"
18 },
19 {
20 "fruit01": "orange",
21 "price": 3.5
22 },
23 {
24 "price": 3.0,
25 "fruit02": "banana"
26 }
27 ],
28 "clothes": [
29 {
30 "sell_time": "AM 09:30"
31 },
32 "clothe01",
33 "clothe02"
34 ]
35 },
36 "address": "BJ"
37 }
YAML-純量資料型別
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
純量是最基本的，不可再分的值，包括：
字串 布林值 整數 浮點數 Null 時間 日期
常用資料型別的表示格式進行了約定
1 [root@docker02 yaml]# cat demo_05_scalars.yml 2 boolean: 3 - TRUE # true,True都可以 4 - FALSE # false，False都可以 5 float: 6 - 3.14 7 - 6.8523015e+5 #可以使用科學計數法 8 int: 9 - 123 10 null: 11 nodeName: 'node' 12 parent: ~ # 使用~表示null 13 string: 14 - 哈哈 15 - 'Hello world' # 可以使用雙引號或者單引號包裹特殊字元 16 - newline 17 newline2 # 字串可以拆成多行，非尾行的每一行換行符都轉為空格 18 date: 19 - 2018-02-17 # 日期必須使用ISO 8601格式，即yyyy-MM-dd 20 datetime: 21 - 2018-02-17T15:02:31+08:00 #時間使用ISO 8601格式，時間和日期之間使用T連線，最後使用+代表時區
雙歎號強制轉換型別
yaml檔案
1 [root@docker02 yaml]# cat demo_06_switch.yml 2 # 原資訊 3 ori01: 3.14 4 ori02: "123" 5 # 強制轉換 6 int_str: !!str 3.14 # value 整數強制轉換為字串 7 str_int: !!int "123" # value 字串強制轉換為整數
Python解析
1 [root@docker02 yaml]# cat demo_06_switch.py 2 #!/usr/bin/env python 3 # -*- coding: utf-8 -*- 4 # Author: zhang 5 6 import yaml 7 import json 8 9 file_path = "demo_06_switch.yml" 10 file = open(file_path, 'r') 11 12 ys = yaml.load_all(file.read(), Loader=yaml.Loader) 13 for y in ys: 14 # 兩種列印方式都嘗試下 15 print y 16 #print json.dumps(y, indent=2)
輸出結果，仔細對比下
1 [root@docker02 yaml]# python demo_06_switch.py
2 {'ori01': 3.14, 'int_str': '3.14', 'ori02': '123', 'str_int': 123}
3 # 或者輸出如下
4 [root@docker02 yaml]# python demo_06_switch.py
5 {
6 "ori01": 3.14,
7 "int_str": "3.14",
8 "ori02": "123",
9 "str_int": 123
10 }
YAML-引用
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
& 用來建立錨點（defaults），<< 表示合併到當前資料，* 用來引用錨點。
yaml檔案
1 [root@docker02 yaml]# cat demo_07_anchor.yml 2 --- 3 hr: 4 - Mark McGwire 5 # Following node labeled SS 6 - &SS Sammy Sosa # 定義要複製的資料 7 rbi: 8 - *SS # Subsequent occurrence 這裡是資料複製目標 9 - Ken Griffey 10 ... 11 --- 12 defaults: &defaults 13 adapter: postgres 14 host: localhost 15 16 development: 17 database: myapp_development 18 <<: *defaults 19 20 test: 21 database: myapp_test 22 info: *defaults 23 ...
Python解析
1 [root@docker02 yaml]# cat demo_07_anchor.py 2 #!/usr/bin/env python 3 # -*- coding: utf-8 -*- 4 # Author: zhang 5 6 import yaml 7 import json 8 9 file_path = "demo_07_anchor.yml" 10 file = open(file_path, 'r') 11 12 ys = yaml.load_all(file.read(), Loader=yaml.Loader) 13 for y in ys: 14 # 兩種列印方式都嘗試下 15 print y 16 #print json.dumps(y, indent=2)
輸出結果，仔細對比下
1 [root@docker02 yaml]# python demo_07_anchor.py
2 {'hr': ['Mark McGwire', 'Sammy Sosa'], 'rbi': ['Sammy Sosa', 'Ken Griffey']}
3 {'development': {'adapter': 'postgres', 'host': 'localhost', 'database': 'myapp_development'}, 'test': {'info': {'adapter': 'postgres', 'host': 'localhost'}, 'database': 'myapp_test'}, 'defaults': {'adapter': 'postgres', 'host': 'localhost'}}
4 # 或者結果如下
5 [root@docker02 yaml]# python demo_07_anchor.py
6 {
7 "hr": [
8 "Mark McGwire",
9 "Sammy Sosa"
10 ],
11 "rbi": [
12 "Sammy Sosa",
13 "Ken Griffey"
14 ]
15 }
16 {
17 "development": {
18 "adapter": "postgres",
19 "host": "localhost",
20 "database": "myapp_development"
21 },
22 "test": {
23 "info": {
24 "adapter": "postgres",
25 "host": "localhost"
26 },
27 "database": "myapp_test"
28 },
29 "defaults": {
30 "adapter": "postgres",
31 "host": "localhost"
32 }
33 }
YAML-字串
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
字串是最常見，也是最複雜的一種資料型別。
字串預設不使用引號表示。
str: 這是一行字串
如果字串之中包含空格或特殊字元，需要放在引號之中。
str: '內容： 字串'
單引號和雙引號都可以使用，雙引號不會對特殊字元轉義。
s1: '內容\n字串' s2: "內容\n字串"
單引號之中如果還有單引號，必須連續使用兩個單引號轉義。
str: 'labor''s day'
字串可以寫成多行，從第二行開始，必須有空格縮排。換行符會被轉為空格。
str: 這是一段 多行 字串
多行字串可以使用 | 保留換行符，也可以使用 > 摺疊換行。
1 this: | 2 Foo 3 Bar 4 that: > 5 Foo 6 Bar
+ 表示保留字串行末尾的換行，- 表示刪除字串末尾的換行。
1 s1: | 2 Foo 3 4 s2: |+ 5 Foo 6 7 s3: |- 8 Foo
字串之中可以插入 HTML 標記。
1 message: | 2 3 <p style="color: red"> 4 段落 5 </p>
字串測驗案例
yaml檔案
1 [root@docker02 yaml]# cat demo_08_str.yml 2 str01: zhangsan 3 str02: 'Q: What are you doing?' 4 5 str03: 'zhangsan\nlisi\nwangwu' 6 str04: "zhangsan\nlisi\nwangwu" 7 8 str05: 'What''s your name?' 9 str06: "What's your name?" 10 11 str07: 12 'Ken: Hello, 13 My name is Ken. 14 What''s your name?' 15 16 str08: 17 "Ken: Hello, 18 My name is Ken. 19 What's your name?" 20 21 str11: | 22 111 23 222 24 333 25 str12: > 26 aaa xxx 27 bbb yyy 28 ccc zzz 29 30 # 之後有2行空行 31 str16: | 32 zhangsan 33 lisi 34 wangwu 35 36 37 # 之後有2行空行 38 str17: |+ 39 zhangsan 40 lisi 41 wangwu 42 43 44 # 之後有2行空行 45 str18: |- 46 zhangsan 47 lisi 48 wangwu 49 50 51 message: | 52 53 <p style="color: red"> 54 one line str 55 </p>
Python解析
1 [root@docker02 yaml]# cat demo_08_str.py 2 #!/usr/bin/env python 3 # -*- coding: utf-8 -*- 4 # Author: zhang 5 6 import yaml 7 import json 8 9 file_path = "demo_08_str.yml" 10 file = open(file_path, 'r') 11 12 ys = yaml.load_all(file.read(), Loader=yaml.Loader) 13 for y in ys: 14 # 兩種列印方式都嘗試下 15 print y 16 #print json.dumps(y, indent=2)
輸出結果，仔細對比下
1 [root@docker02 yaml]# python demo_08_str.py
2 {'str02': 'Q: What are you doing?', 'str01': 'zhangsan', 'str05': "What's your name?", 'str08': "Ken: Hello, My name is Ken. What's your name?", 'str06': "What's your name?", 'str18': 'zhangsan\nlisi\nwangwu', 'str17': 'zhangsan\nlisi\nwangwu\n\n\n', 'str16': 'zhangsan\nlisi\nwangwu\n', 'message': u'\n<p style="color: red">\n one line str\n</p>\n', 'str03': 'zhangsan\\nlisi\\nwangwu', 'str04': 'zhangsan\nlisi\nwangwu', 'str12': 'aaa xxx bbb yyy ccc zzz\n', 'str11': '111\n222\n333\n', 'str07': "Ken: Hello, My name is Ken. What's your name?"}
3 # 或者輸出如下
4 [root@docker02 yaml]# python demo_08_str.py
5 {
6 "str02": "Q: What are you doing?",
7 "str01": "zhangsan",
8 "str05": "What's your name?",
9 "str08": "Ken: Hello, My name is Ken. What's your name?",
10 "str06": "What's your name?",
11 "str18": "zhangsan\nlisi\nwangwu",
12 "str17": "zhangsan\nlisi\nwangwu\n\n\n",
13 "str16": "zhangsan\nlisi\nwangwu\n",
14 "message": "\n<p style=\"color: red\">\n one line str\n</p>\n",
15 "str03": "zhangsan\\nlisi\\nwangwu",
16 "str04": "zhangsan\nlisi\nwangwu",
17 "str12": "aaa xxx bbb yyy ccc zzz\n",
18 "str11": "111\n222\n333\n",
19 "str07": "Ken: Hello, My name is Ken. What's your name?"
20 }
完畢！
———END———
如果覺得不錯就關注下唄 (-^O^-) ！
&n