Python中yaml模組的使用教程

Python探索牛發表於2024-08-10
PythonYAML

一、yaml檔案介紹

yaml是一個專門用來寫配置檔案的語言。

1.yaml檔案規則

  • 區分大小寫；
  • 使用縮排表示層級關係；
  • 使用空格鍵縮排，而非Tab鍵縮排
  • 縮排的空格數目不固定，只需要相同層級的元素左側對齊；
  • 檔案中的字串不需要使用引號標註，但若字串包含有特殊字元則需用引號標註；
  • 註釋標識為#

2.yaml檔案資料結構

  • 物件：鍵值對的集合（簡稱 "對映或字典"）
    鍵值對用冒號 “:” 結構表示，冒號與值之間需用空格分隔
  • 陣列：一組按序排列的值（簡稱 "序列或列表"）
    陣列前加有 “-” 符號，符號與值之間需用空格分隔
  • 純量(scalars)：單個的、不可再分的值（如：字串、bool值、整數、浮點數、時間、日期、null等）
    None值可用null可 ~ 表示

二、python中讀取yaml配置檔案

1.前提條件

python中讀取yaml檔案前需要安裝pyyaml和匯入yaml模組：

  • 使用yaml需要安裝的模組為pyyaml（pip3 install pyyaml）;
  • 匯入的模組為yaml（import yaml）

2. 讀取yaml檔案資料

python透過open方式讀取檔案資料，再透過load函式將資料轉化為列表或字典；

import yaml
import os

def get_yaml_data(yaml_file):
    # 開啟yaml檔案
    print("***獲取yaml檔案資料***")
    file = open(yaml_file, 'r', encoding="utf-8")
    file_data = file.read()
    file.close()
    
    print(file_data)
    print("型別：", type(file_data))

    # 將字串轉化為字典或列表
    print("***轉化yaml資料為字典或列表***")
    data = yaml.load(file_data)
    print(data)
    print("型別：", type(data))
    return data
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "config.yaml")
get_yaml_data(yaml_path)

"""
***獲取yaml檔案資料***
# yaml鍵值對：即python中字典
usr: my
psw: 123455
型別：<class 'str'>
***轉化yaml資料為字典或列表***
{'usr': 'my', 'psw': 123455}
型別：<class 'dict'>
"""

3. yaml檔案資料為鍵值對

（1）yaml檔案中內容為鍵值對：

# yaml鍵值對：即python中字典
usr: my
psw: 123455
s: " abc\n"

python解析yaml檔案後獲取的資料：

{'usr': 'my', 'psw': 123455, 's': ' abc\n'}

(2) yaml檔案中內容為“鍵值對'巢狀"鍵值對"

# yaml鍵值對巢狀：即python中字典巢狀字典
usr1:
  name: a
  psw: 123
usr2:
  name: b
  psw: 456

python解析yaml檔案後獲取的資料：

{'usr1': {'name': 'a', 'psw': 123}, 'usr2': {'name': 'b', 'psw': 456}}

（3）yaml檔案中“鍵值對”中巢狀“陣列”

python解析yaml檔案後獲取的資料：

# yaml鍵值對中巢狀陣列
usr3:
  - a
  - b
  - c
usr4:
  - b

python解析yaml檔案後獲取的資料：

{'usr3': ['a', 'b', 'c'], 'usr4': ['b']}

4. yaml檔案資料為陣列

（1）yaml檔案中內容為陣列

# yaml陣列
- a
- b
- 5

python解析yaml檔案後獲取的資料：

['a', 'b', 5]

（2）yaml檔案“陣列”中巢狀“鍵值對”

# yaml"陣列"中巢狀"鍵值對"
- usr1: aaa
- psw1: 111
  usr2: bbb
  psw2: 222

python解析yaml檔案後獲取的資料：

[{'usr1': 'aaa'}, {'psw1': 111, 'usr2': 'bbb', 'psw2': 222}]

5. yaml檔案中基本資料型別：

# 純量
s_val: name              # 字串：{'s_val': 'name'}
spec_s_val: "name\n"    # 特殊字串：{'spec_s_val': 'name\n'
num_val: 31.14          # 數字：{'num_val': 31.14}
bol_val: true           # 布林值：{'bol_val': True}
nul_val: null           # null值：{'nul_val': None}
nul_val1: ~             # null值：{'nul_val1': None}
time_val: 2018-03-01t11:33:22.55-06:00     # 時間值：{'time_val': datetime.datetime(2018, 3, 1, 17, 33, 22, 550000)}
date_val: 2019-01-10    # 日期值：{'date_val': datetime.date(2019, 1, 10)}

6. yaml檔案中引用

yaml檔案中內容

animal3: &animal3 fish
test: *animal3

python讀取的資料

{'animal3': 'fish', 'test': 'fish'}

三、python中讀取多個yaml文件

1. 多個文件在一個yaml檔案，使用 --- 分隔方式來分段

如：yaml檔案中資料

# 分段yaml檔案中多個文件
---
animal1: dog
age: 2
---
animal2: cat
age: 3

2. python指令碼讀取一個yaml檔案中多個文件方法

python獲取yaml資料時需使用load_all函式來解析全部的文件，再從中讀取物件中的資料

# yaml檔案中含有多個文件時，分別獲取文件中資料
def get_yaml_load_all(yaml_file):
    # 開啟yaml檔案
    file = open(yaml_file, 'r', encoding="utf-8")
    file_data = file.read()
    file.close()
    all_data = yaml.load_all(file_data)
    for data in all_data:
        print(data)
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "config.yaml")
get_yaml_load_all(yaml_path)
"""結果
{'animal1': 'dog', 'age': 2}
{'animal2': 'cat', 'age': 3}
"""

四、python物件生成yaml文件

1. 直接匯入yaml（即import yaml）生成的yaml文件

透過yaml.dump()方法不會將列表或字典資料進行轉化yaml標準模式，只會將資料生成到yaml文件中

# 將python物件生成yaml文件
import yaml
def generate_yaml_doc(yaml_file):
    py_object = {'school': 'zhang',
                 'students': ['a', 'b']}
    file = open(yaml_file, 'w', encoding='utf-8')
    yaml.dump(py_object, file)
    file.close()
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "generate.yaml")
generate_yaml_doc(yaml_path)
"""結果
school: zhang
students: [a, b]
"""

2. 使用ruamel模組中的yaml方法生成標準的yaml文件

（1）使用ruamel模組中yaml前提條件

  • 使用yaml需要安裝的模組：ruamel.yaml（pip3 install ruamel.yaml）;
  • 匯入的模組：from ruamel import yaml

（2）ruamel模組生成yaml文件

def generate_yaml_doc_ruamel(yaml_file):
    from ruamel import yaml
    py_object = {'school': 'zhang',
                 'students': ['a', 'b']}
    file = open(yaml_file, 'w', encoding='utf-8')
    yaml.dump(py_object, file, Dumper=yaml.RoundTripDumper)
    file.close()
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "generate.yaml")
generate_yaml_doc_ruamel(yaml_path)
"""結果
school: zhang
students:
- a
- b
"""

（3）ruamel模組讀取yaml文件

# 透過from ruamel import yaml讀取yaml檔案
#學習中遇到問題沒人解答？小編建立了一個Python學習交流群：531509025
def get_yaml_data_ruamel(yaml_file):
    from ruamel import yaml
    file = open(yaml_file, 'r', encoding='utf-8')
    data = yaml.load(file.read(), Loader=yaml.Loader)
    file.close()
    print(data)
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "dict_config.yaml")
get_yaml_data_ruamel(yaml_path)

相關文章