Python yaml模块详解：读取、解析与生成配置文件的完整指南
本文详细解析Python中yaml模块的使用方法，涵盖YAML基础语法、数据结构及读写操作。通过pyyaml库实现配置文件的读取与解析，支持键值对、数组及嵌套结构。此外，介绍利用ruamel.yaml生成标准格式YAML文档的技巧，并演示多文档处理与引用功能，帮助开发者高效管理Python项目配置。
一、yaml文件介绍
YAML是一种专为编写配置文件而设计的语言，具有简洁易读的特点。
1. yaml文件规则
- YAML语法严格区分大小写。
- 层级关系通过缩进表示。
- 必须使用空格键进行缩进，禁止使用Tab键。
- 缩进的空格数量无需固定，只要同一层级的元素左侧对齐即可。
- 文件中的字符串通常无需引号，但若字符串包含特殊字符，则必须使用引号包裹。
- 注释符号为井号（#）。
2. yaml文件数据结构
- 对象：即键值对的集合，在Python中常被称为“映射”或“字典”。
键值对通过冒号（:）连接，冒号与值之间必须保留一个空格。
- 数组：指按顺序排列的一组值，在Python中称为“序列”或“列表”。
数组元素前需添加连字符（-），且符号与值之间必须保留一个空格。
- 纯量（scalars）：指单个且不可再分的值，包括字符串、布尔值、整数、浮点数、时间、日期及null等。
None值可以使用null或波浪号（~）来表示。
二、python中读取yaml配置文件
1. 前提条件
在Python中读取yaml文件前，需先安装pyyaml库并导入yaml模块。
- 安装模块的命令为pip3 install pyyaml。
- 导入模块的代码为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文件
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)
以上就是详解Python yaml模块的详细内容，更多关于Python yaml模块的资料请关注本站其它相关文章！
本站声明
本文内容仅供参考，不代表本站观点。转载或引用请注明出处。如发现内容问题，请通过联系我们页面反馈。
