YAML是一種數據序列化格式，方便人類閱讀，且容易和腳本語言交互。常用于配置文件，也用于數據存儲或傳輸。

YAML格式

YAML三種基本數據類型：

1.標量：如字符串、整數和浮點數、日期

• 布爾值：“true”、“True”、“TRUE”、“yes”、“Yes"和"YES”，“false”、“False”、“FALSE”、“no”、“No"和"NO”
• 空：null、Null、~或不指定值；

2.數組：使用前導符號-表示，且符號與值間要有空格；

3.對象：鍵值對集合；用冒號+空格: 分割；

YAML文件

文件基本規則：

區分大小寫；

使用縮進表示層級關系：

• 縮進要用空格（非Tab）；
• 相同層級元素要左對齊；

字符串不需要使用引號括起，但有特殊字符串（如空格、冒號等）時必須使用引號；

使用#注釋；

一個文件中可包含多份YAML文檔：

用---（即三個中劃線）表示一份文檔的開始；

[可選]用...（即三個小數點）表示一份文檔的結束；

---
# 這是第一份文檔
one: 1
# 其他內容...
...

---
# 這是第二份文檔
two: 2
# 其他內容...

YAML操作

Python中有兩個YAML模塊：PyYAML和ruamel.yaml（pip3 install pyyaml，pip3 install ruamel.yaml）。

讀取

通過load函數可方便加載文檔內容，返回的內容可能是字典、列表或空：

import yaml
def readYaml(file):  # -> Union[dict, list, None]:
    with open(file, 'r', encoding='utf-8') as f:
        return yaml.load(f, yaml.Loader)

若文件中有多個文檔，需要使用load_all來加載；此時返回的是一個生成器，需要一次獲取每個文檔：

def readAllDoc(file) -> list:
    with open(file, 'r', encoding='utf-8') as f:
        docs = yaml.load_all(f, yaml.Loader)
        # return [d for d in docs]
        return list(docs)

存儲

yaml.dump()方法不會將列表或字典數據進行轉化yaml標準模式。需要通過ruamel.yaml來生成標準的yaml文檔。

import ruamel.yaml
def createYaml(file, data: dict):
    with open(file, 'w', encoding='utf-8') as f:
        writer = ruamel.yaml.YAML()
        writer.indent(mapping=2, sequence=4, offset=2)
        writer.dump(data, f)

通過dump_all可把數組中的每個元素序列化為一個文檔：

def createAllDoc(file, data: list):
    with open(file, 'w', encoding='utf-8') as f:
        writer = ruamel.yaml.YAML()
        writer.indent(mapping=2, sequence=4, offset=2)
        writer.dump_all(data, f)

把[{'name': 'Mike', 'age': 12}, {'name': 'luce', 'age': 15}]序列化。

dump會生成如下包含數組元素的yaml文件：

  - name: Mike
    age: 12
  - name: luce
    age: 15

dump_all會生成如下yaml文件（包含兩個文檔）：

name: Mike
age: 12
---
name: luce
age: 15

示例

yaml讀取后為列表或字典。

轉字典

讀取的內容為一個字典：

name: mike
age: 25
score: 80.5

返回的值為：

{
? "name": "mike",
? "age": 25,
? "score": 80.5
}

獲取里面值，先判斷是否存在，再讀取：

if 'name' in data:
  print(data['name'])

轉列表

讀取內容為一個列表：

- name: mike
  age: 24
- name: tom
  age: 30

返回的值為：

[
? {
? ? "name": "mike",
? ? "age": 24
? },
? {
? ? "name": "tom",
? ? "age": 30
? }
]