YAML介绍
YAML是一种比XML和JSON更轻的文件格式,也更简单更强大,它可以通过缩进来表示结构,可读性好,脚本语言的交互性好,使用实现语言的数据类型。
YAML文件规则
- 区分大小写;
- 使用缩进表示层级关系;
- 使用空格键缩进,而非Tab键缩进
- 缩进的空格数目不固定,只需要相同层级的元素左侧对齐;
- 文件中的字符串不需要使用引号标注,但若字符串包含有特殊字符则需用引号标注;
- 注释标识为#
YAML文件数据结构
- 对象:键值对的集合(简称 "映射或字典"),键值对用冒号 “:” 结构表示,冒号与值之间需用空格分隔
- 数组:一组按序排列的值(简称 "序列或列表"),数组前加有 “-” 符号,符号与值之间需用空格分隔
- 纯量(scalars):单个的、不可再分的值(如:字符串、bool值、整数、浮点数、时间、日期、null等),None值:可用null、可 ~ 表示
python中读取yaml配置文件
pip install pyyaml # 如果是py2,使用 pip install yaml
#A.读取yaml文件数据
import yaml
def get_yaml_data(yaml_file):
# 打开yaml文件
with open(yaml_file, 'r', encoding="utf-8") as file:
file_data = file.read()
print(file_data)
print("对象类型是:",type(file_data))
# 将字符串转化为字典或列表
print("***转化yaml数据为字典或列表***")
data = yaml.load(file_data,Loader=yaml.SafeLoader)
print(data)
print("对象类型:", type(data))
return data
#测试代码
get_yaml_data("data_test.yaml")
python中读取多个yaml文档
1. 多个文档在一个yaml文件,使用 --- 分隔方式来分段
# 分段yaml文件中多个文档
---
student1: zhangsan
age: 18
---
student2: lisi
age: 20
2. python脚本读取一个yaml文件中多个文档方法
load_all函数来解析全部的文档,再从中读取对象中的数据
# yaml文件中含有多个文档时,分别获取文档中数据
import yaml
def get_yaml_data(yaml_file):
# 打开yaml文件
with open(yaml_file, 'r', encoding="utf-8") as file:
file_data = file.read()
all_data = yaml.load_all(file_data,Loader=yaml.SafeLoader)
for data in all_data:
print(data)
get_yaml_data("data_test.yaml")
python对象生成yaml文档
1. 直接导入yaml(即import yaml)生成的yaml文档
通过yaml.dump()方法会将数据生成到yaml文档中
# 将python对象生成yaml文档
import yaml
def generate_yaml(yaml_file):
info_object = {'school': 'wood',
'students': ['zhangsan', 'lisi']}
file = open(yaml_file, 'w', encoding='utf-8')
yaml.dump(info_object, file) #yaml.dump()方法将数据生成到yaml文档中
file.close()
#测试代码
generate_yaml("data_test.yaml")
2. 使用ruamel模块中的yaml方法生成标准的yaml文档
(1)使用ruamel模块中yaml前提条件
- 使用yaml需要安装的模块:ruamel.yaml(pip3 install ruamel.yaml);
- 导入的模块:from ruamel import yaml
(2)ruamel模块生成yaml文档
from ruamel import yaml
def generate_yaml_ruamel(yaml_file):
info_object = {'school': 'wood',
'students': ['zhangsan', 'lisi']}
with open(yaml_file, 'w', encoding='utf-8') as file:
yaml.dump(info_object, file, Dumper=yaml.RoundTripDumper)
#测试代码
generate_yaml_ruamel("data_test.yaml")
执行结果:
(3)ruamel模块读取yaml文档
# 通过from ruamel import yaml读取yaml文件
from ruamel import yaml
def get_yaml_data_ruamel(yaml_file):
with open(yaml_file, 'r', encoding='utf-8') as file:
data = yaml.load(file.read(), Loader=yaml.SafeLoader)
print(data)
#测试代码
get_yaml_data_ruamel("data_test.yaml")