Python使用yaml模块操作YAML文档的方法

# 对象：yaml键值对；即python中字典
user: 'admin'
pwd: 'admin@123'
site: "www.yaml.com"
# 解析后: {'user': 'admin', 'passWord': 'admin@123', 'site': 'www.yaml.com'}

# 2. 数组：yaml键值对中嵌套数组
user2:
 - a
 - b
 - c
user3:
 - d
# 解析后：{'user2':['a','b','c'],'user3':['d']}

# 3. 纯量
val_name: name      # 字符串: {'val_name': 'name'}
spec_val: "name\n" # 特殊字符串: {'spec_val': 'name\n'}
pi_val: 3.14        # 数字: {'pi_val': 3.14}
bol_val: true       # 布尔值: {'bol_val': true}
nul_val: null       # null值: {'nul_val': None}
nul_val: ~          # null值: {'nul_val': None}
time_val: 2023-02-03t22:33:22.33-03:00      # 时间值：{'time_val': datetime.datetime(2023, 2, 3, 22, 33, 22, 330000)}
date_val: 2024-01-01        # 日期值：{'date_val': datetime.date(2024, 1, 1)}

# 4. 引用
name: &name 白云
tester: *name
# 相当于
name: 白云
tester: 白云
# 解析后内容：{'name': '白云', 'tester': '白云'}

# 5. 强制转换
str: !!str 3.14
int: !!int "666"
# 输出: {'str': '3.14','int': 123}

pip install pyyaml

user1:
 name: xm
 stu: 101
user2:
 name: xh
 stu: 102
user3:
 name: xl
 stu: 103

import yaml
import os
class ReadYAML(object):
    def read_yaml(self,yaml_file):
        with open(yaml_file,'r',encoding='utf-8') as f:
            file_data = f.read()
            print("file_data类型：",type(file_data))
            data = yaml.safe_load(file_data)
            print("data类型:",type(data))
        
        return data



if __name__ == "__main__":
    base_name = os.path.dirname(os.path.realpath(__file__))
    yaml_path = os.path.join(base_name,'test.yaml')
    ry = ReadYAML()
    res = ry.read_yaml(yaml_path)
    print(res)

class1:
 - stu1
 - stu2
 - stu3
class2:
 - stu2

import yaml
import os
class ReadArraysYAML(object):
    def read_yaml(self,yaml_file):
        with open(yaml_file,'r',encoding='utf-8') as f:
            file_data = f.read()
            # print("file_data类型：",type(file_data))
            data = yaml.safe_load(file_data)
            # print("data类型:",type(data))
        
        return data


if __name__ == "__main__":
    base_name = os.path.dirname(os.path.realpath(__file__))
    yaml_path = os.path.join(base_name,'arrays.yaml')
    ry = ReadArraysYAML()
    res = ry.read_yaml(yaml_path)
    print(res)

# 分段yaml文件中存在多个文档
---
animal1: dog
age: 1
---
animal2: cat
age: 2

"""
多文档同在一份yaml文件中时的读取方法（使用yaml.safe_load_all()）
"""
import yaml
import os
def get_yaml_load_all(yaml_file):
    file = open(yaml_file,'r',encoding='utf-8')
    file_data = file.read()
    file.close()
    all_data = yaml.safe_load_all(file_data)
    for data in all_data:
        print(data)
if __name__ == "__main__":
    current_path = os.path.dirname(__file__)
    print(current_path)
    yaml_path = os.path.join(current_path,'muti.yaml')
    get_yaml_load_all(yaml_path)

"""
使用yaml.dump()方法将列表或字典数据写入进已存在的yaml文档
"""
import yaml
import os
def generate_yaml_doc(yaml_file):
    py_object = {'school':'Fxxking U','student':['stu1','stu2']}
    file = open(yaml_file,'w',encoding='utf-8')
    yaml.safe_dump(py_object,file)
    file.close()
if __name__ == "__main__":
    current_path = os.path.dirname(__file__)
    print(current_path)
    yaml_path = os.path.join(current_path,'generateYAML.yaml')
    generate_yaml_doc(yaml_path)

school: Fxxking U
student:
- stu1
- stu2

school: Fxxking U
student:
- stu1
- stu2

import yaml
import os
from readArraysYAML import ReadArraysYAML

def update_yaml(k,v,yaml_file):
    readY = ReadArraysYAML()
    old_data = readY.read_yaml(yaml_file)
    old_data[k] = v     # 修改读取的数据，如果k不存在则新增一组键值对
    with open(yaml_file,'w',encoding='utf-8') as f:
        yaml.safe_dump(old_data,f)

if __name__ == "__main__":
    current_path = os.path.dirname(__file__)
    yaml_path = os.path.join(current_path,'generateYAML.yaml')
    k = 'school'
    v = 'SZ U'
    update_yaml(k,v,yaml_path)

school: SZ U
student:
- stu1
- stu2

pip install ruamel.yaml

from ruamel import yaml
import os
def generate_yaml_doc_ruamel(yaml_file):
    py_object = {'file_type':'ruamel_yaml','school':'Fxxking U','student':['c','d']}
    with open(yaml_file,'w',encoding='utf-8') as f:
        yaml.dump(py_object,f,Dumper=yaml.RoundTripDumper)
if __name__ == "__main__":
    current_path = os.path.dirname(__file__)
    yaml_path = os.path.join(current_path,'ruamelGenerateYAML.yaml')
    generate_yaml_doc_ruamel(yaml_path)
    print("写入成功！")

file_type: ruamel_yaml
school: Fxxking U
student:
- c
- d