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，則可以使用以下方法來安裝：
# curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py # 下載安裝指令碼
# python get-pip.py # 執行安裝指令碼 或則：python3 get-pip.py 根據使用的Python決定
# 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檔案
[[email protected] yaml]# cat demo_01_obj.yml
---
name: zhang
age:
Python解析
[[email protected] yaml]# cat demo_01_obj.py
#!/usr/bin/env python
# -*- coding: utf- -*-
# Author: zhang import yaml file_path = "./demo_01_obj.yml"
file = open(file_path, 'r')
ys = yaml.load(file.read(), Loader=yaml.Loader)
print ys
輸出結果
[[email protected] yaml]# python demo_01_obj.py
{'age': , 'name': 'zhang'}
多個物件檔案檔案
yaml檔案，仔細對比下加了”---“和”...“ 的區別
[[email protected] yaml]# cat demo_02_obj.yml
---
name: zhang
age:
...
---
name: Jane
age:
key:
child-key: value
child-key2: value2
...
---
obj: {obj_key1: value1, obj_key2: value2}
...
Python解析
[[email protected] yaml]# cat demo_02_obj.py
#!/usr/bin/env python
# -*- coding: utf- -*-
# Author: zhang import yaml
import json file_path = "demo_02_obj.yml"
file = open(file_path, 'r') ys = yaml.load_all(file.read(), Loader=yaml.Loader)
for y in ys:
# 兩種列印方式都嘗試下
#print y
print json.dumps(y, indent=)
輸出結果
[[email protected] yaml]# python demo_02_obj.py
{'age': , 'name': 'zhang'}
{'age': , 'name': 'Jane', 'key': {'child-key2': 'value2', 'child-key': 'value'}}
{'obj': {'obj_key1': 'value1', 'obj_key2': 'value2'}}
# 或者如下
[[email protected] yaml]# python demo_02_obj.py
{
"age": ,
"name": "zhang"
}
{
"age": ,
"name": "Jane",
"key": {
"child-key2": "value2",
"child-key": "value"
}
}
{
"obj": {
"obj_key1": "value1",
"obj_key2": "value2"
}
}
YAML-陣列資料型別
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
陣列型別：一組連詞線開頭的行，構成一個陣列
yaml檔案
[[email protected] yaml]# cat demo_03_list.yml
# 書寫方式1
color:
- red
- blue
- green
- orange
- white
# 書寫方式2：行內表示法
fruits: [orange, apple, banana]
Python解析
[[email protected] yaml]# cat demo_03_list.py
#!/usr/bin/env python
# -*- coding: utf- -*-
# Author: zhang import yaml
import json file_path = "demo_03_list.yml"
file = open(file_path, 'r') ys = yaml.load_all(file.read(), Loader=yaml.Loader)
for y in ys:
# 兩種列印方式都嘗試下
#print y
print json.dumps(y, indent=)
輸出結果
[[email protected] yaml]# python demo_03_list.py
{'color': ['red', 'blue', 'green', 'orange', 'white'], 'fruits': ['orange', 'apple', 'banana']}
# 或者結果如下
[[email protected] yaml]# python demo_03_list.py
{
"color": [
"red",
"blue",
"green",
"orange",
"white"
],
"fruits": [
"orange",
"apple",
"banana"
]
}
YAML-複合結構
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
複合結構：物件和陣列可以結合使用，形成複合結構
yaml檔案，注意其書序格式，並細細對比輸出結果
[[email protected] yaml]# cat demo_04_compose.yml
shop: GoodShopping
address: BJ
goods:
Food:
- sell_time: "AM 08:30"
food01: rice
food02: pork
Fruits:
- sell_time: "AM 09:00"
- fruit01: orange
price: 3.50
- fruit02: banana
price: 3.00
clothes:
- sell_time: "AM 09:30"
- clothe01
- clothe02
Python解析
[[email protected] yaml]# cat demo_04_compose.py
#!/usr/bin/env python
# -*- coding: utf- -*-
# Author: zhang import yaml
import json file_path = "demo_04_compose.yml"
file = open(file_path, 'r') ys = yaml.load_all(file.read(), Loader=yaml.Loader)
for y in ys:
# 兩種列印方式都嘗試下
print y
#print json.dumps(y, indent=)
輸出結果，仔細對比下
[[email protected] yaml]# python demo_04_compose.py
{'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'}
# 或者結果如下
[[email protected] yaml]# python demo_04_compose.py
{
"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"
}
YAML-純量資料型別
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
純量是最基本的，不可再分的值，包括：
字串
布林值
整數
浮點數
Null
時間
日期
常用資料型別的表示格式進行了約定
[[email protected] yaml]# cat demo_05_scalars.yml
boolean:
- TRUE # true,True都可以
- FALSE # false，False都可以
float:
- 3.14
- 6.8523015e+5 #可以使用科學計數法
int:
-
null:
nodeName: 'node'
parent: ~ # 使用~表示null
string:
- 哈哈
- 'Hello world' # 可以使用雙引號或者單引號包裹特殊字元
- newline
newline2 # 字串可以拆成多行，非尾行的每一行換行符都轉為空格
date:
- -- # 日期必須使用ISO 8601格式，即yyyy-MM-dd
datetime:
- --17T15::+: #時間使用ISO 8601格式，時間和日期之間使用T連線，最後使用+代表時區
雙歎號強制轉換型別
yaml檔案
[[email protected] yaml]# cat demo_06_switch.yml
# 原資訊
ori01: 3.14
ori02: ""
# 強制轉換
int_str: !!str 3.14 # value 整數強制轉換為字串
str_int: !!int "" # value 字串強制轉換為整數
Python解析
[[email protected] yaml]# cat demo_06_switch.py
#!/usr/bin/env python
# -*- coding: utf- -*-
# Author: zhang import yaml
import json file_path = "demo_06_switch.yml"
file = open(file_path, 'r') ys = yaml.load_all(file.read(), Loader=yaml.Loader)
for y in ys:
# 兩種列印方式都嘗試下
print y
#print json.dumps(y, indent=)
輸出結果，仔細對比下
[[email protected] yaml]# python demo_06_switch.py
{'ori01': 3.14, 'int_str': '3.14', 'ori02': '', 'str_int': }
# 或者輸出如下
[[email protected] yaml]# python demo_06_switch.py
{
"ori01": 3.14,
"int_str": "3.14",
"ori02": "",
"str_int":
}
YAML-引用
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
&用來建立錨點（defaults），<<表示合併到當前資料，*用來引用錨點。
yaml檔案
[[email protected] yaml]# cat demo_07_anchor.yml
---
hr:
- Mark McGwire
# Following node labeled SS
- &SS Sammy Sosa # 定義要複製的資料
rbi:
- *SS # Subsequent occurrence 這裡是資料複製目標
- Ken Griffey
...
---
defaults: &defaults
adapter: postgres
host: localhost development:
database: myapp_development
<<: *defaults test:
database: myapp_test
info: *defaults
...
Python解析
[[email protected] yaml]# cat demo_07_anchor.py
#!/usr/bin/env python
# -*- coding: utf- -*-
# Author: zhang import yaml
import json file_path = "demo_07_anchor.yml"
file = open(file_path, 'r') ys = yaml.load_all(file.read(), Loader=yaml.Loader)
for y in ys:
# 兩種列印方式都嘗試下
print y
#print json.dumps(y, indent=)
輸出結果，仔細對比下
[[email protected] yaml]# python demo_07_anchor.py
{'hr': ['Mark McGwire', 'Sammy Sosa'], 'rbi': ['Sammy Sosa', 'Ken Griffey']}
{'development': {'adapter': 'postgres', 'host': 'localhost', 'database': 'myapp_development'}, 'test': {'info': {'adapter': 'postgres', 'host': 'localhost'}, 'database': 'myapp_test'}, 'defaults': {'adapter': 'postgres', 'host': 'localhost'}}
# 或者結果如下
[[email protected] yaml]# python demo_07_anchor.py
{
"hr": [
"Mark McGwire",
"Sammy Sosa"
],
"rbi": [
"Sammy Sosa",
"Ken Griffey"
]
}
{
"development": {
"adapter": "postgres",
"host": "localhost",
"database": "myapp_development"
},
"test": {
"info": {
"adapter": "postgres",
"host": "localhost"
},
"database": "myapp_test"
},
"defaults": {
"adapter": "postgres",
"host": "localhost"
}
}
YAML-字串
備註：之所以對yaml檔案使用Python進行解析，是因為我們要測驗yaml檔案格式是否書寫正確。
字串是最常見，也是最複雜的一種資料型別。
字串預設不使用引號表示。
str: 這是一行字串
如果字串之中包含空格或特殊字元，需要放在引號之中。
str: '內容： 字串'
單引號和雙引號都可以使用，雙引號不會對特殊字元轉義。
s1: '內容\n字串'
s2: "內容\n字串"
單引號之中如果還有單引號，必須連續使用兩個單引號轉義。
str: 'labor''s day'
字串可以寫成多行，從第二行開始，必須有空格縮排。換行符會被轉為空格。
str: 這是一段
多行
字串
多行字串可以使用 | 保留換行符，也可以使用 > 摺疊換行。
this: |
Foo
Bar
that: >
Foo
Bar
+ 表示保留字序列末尾的換行，- 表示刪除字串末尾的換行。
s1: |
Foo s2: |+
Foo s3: |-
Foo
字串之中可以插入 HTML 標記。
message: | <p style="color: red">
段落
</p>
字串測驗案例
yaml檔案
[[email protected] yaml]# cat demo_08_str.yml
str01: zhangsan
str02: 'Q: What are you doing?' str03: 'zhangsan\nlisi\nwangwu'
str04: "zhangsan\nlisi\nwangwu" str05: 'What''s your name?'
str06: "What's your name?" str07:
'Ken: Hello,
My name is Ken.
What''s your name?' str08:
"Ken: Hello,
My name is Ken.
What's your name?" str11: | str12: >
aaa xxx
bbb yyy
ccc zzz # 之後有2行空行
str16: |
zhangsan
lisi
wangwu # 之後有2行空行
str17: |+
zhangsan
lisi
wangwu # 之後有2行空行
str18: |-
zhangsan
lisi
wangwu message: | <p style="color: red">
one line str
</p>
Python解析
[[email protected] yaml]# cat demo_08_str.py
#!/usr/bin/env python
# -*- coding: utf- -*-
# Author: zhang import yaml
import json file_path = "demo_08_str.yml"
file = open(file_path, 'r') ys = yaml.load_all(file.read(), Loader=yaml.Loader)
for y in ys:
# 兩種列印方式都嘗試下
print y
#print json.dumps(y, indent=)
輸出結果，仔細對比下
[[email protected] yaml]# python demo_08_str.py
{'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?"}
# 或者輸出如下
[[email protected] yaml]# python demo_08_str.py
{
"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": "\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?"
}
完畢！
———END———
如果覺得不錯就關注下唄 (-^O^-) ！
