Python中yaml模块的使用教程

蜜糖糖

一、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函数将数据转化为列表或字典；

1. import yaml
2. import os
4. def get_yaml_data(yaml_file):
5.     # 打开yaml文件
6.     print("***获取yaml文件数据***")
7.     file = open(yaml_file, 'r', encoding="utf-8")
8.     file_data = file.read()
9.     file.close()
10.    
11.     print(file_data)
12.     print("类型：", type(file_data))
14.     # 将字符串转化为字典或列表
15.     print("***转化yaml数据为字典或列表***")
16.     data = yaml.load(file_data)
17.     print(data)
18.     print("类型：", type(data))
19.     return data
20. current_path = os.path.abspath(".")
21. yaml_path = os.path.join(current_path, "config.yaml")
22. get_yaml_data(yaml_path)
24. """
25. ***获取yaml文件数据***
26. # yaml键值对：即python中字典
27. usr: my
28. psw: 123455
29. 类型：<class 'str'>
30. ***转化yaml数据为字典或列表***
31. {'usr': 'my', 'psw': 123455}
32. 类型：<class 'dict'>
33. """

复制代码

3. yaml文件数据为键值对

（1）yaml文件中内容为键值对：

1. # yaml键值对：即python中字典
2. usr: my
3. psw: 123455
4. s: " abc\n"

复制代码

python解析yaml文件后获取的数据：

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

复制代码

(2) yaml文件中内容为“键值对'嵌套"键值对"

1. # yaml键值对嵌套：即python中字典嵌套字典
2. usr1:
3.   name: a
4.   psw: 123
5. usr2:
6.   name: b
7.   psw: 456

复制代码

python解析yaml文件后获取的数据：

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

复制代码

（3）yaml文件中“键值对”中嵌套“数组”
python解析yaml文件后获取的数据：

1. # yaml键值对中嵌套数组
2. usr3:
3.   - a
4.   - b
5.   - c
6. usr4:
7.   - b

复制代码

python解析yaml文件后获取的数据：

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

复制代码

4. yaml文件数据为数组

（1）yaml文件中内容为数组

1. # yaml数组
2. - a
3. - b
4. - 5

复制代码

python解析yaml文件后获取的数据：

1. ['a', 'b', 5]

复制代码

（2）yaml文件“数组”中嵌套“键值对”

1. # yaml"数组"中嵌套"键值对"
2. - usr1: aaa
3. - psw1: 111
4.   usr2: bbb
5.   psw2: 222

复制代码

python解析yaml文件后获取的数据：

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

复制代码

5. yaml文件中基本数据类型：

1. # 纯量
2. s_val: name              # 字符串：{'s_val': 'name'}
3. spec_s_val: "name\n"    # 特殊字符串：{'spec_s_val': 'name\n'
4. num_val: 31.14          # 数字：{'num_val': 31.14}
5. bol_val: true           # 布尔值：{'bol_val': True}
6. nul_val: null           # null值：{'nul_val': None}
7. nul_val1: ~             # null值：{'nul_val1': None}
8. time_val: 2018-03-01t11:33:22.55-06:00     # 时间值：{'time_val': datetime.datetime(2018, 3, 1, 17, 33, 22, 550000)}
9. date_val: 2019-01-10    # 日期值：{'date_val': datetime.date(2019, 1, 10)}

复制代码

6. yaml文件中引用

yaml文件中内容

1. animal3: &animal3 fish
2. test: *animal3

复制代码

python读取的数据

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

复制代码

三、python中读取多个yaml文档

1. 多个文档在一个yaml文件，使用 --- 分隔方式来分段

如：yaml文件中数据

1. # 分段yaml文件中多个文档
2. ---
3. animal1: dog
4. age: 2
5. ---
6. animal2: cat
7. age: 3

复制代码

2. python脚本读取一个yaml文件中多个文档方法

python获取yaml数据时需使用load_all函数来解析全部的文档，再从中读取对象中的数据

1. # yaml文件中含有多个文档时，分别获取文档中数据
2. def get_yaml_load_all(yaml_file):
3.     # 打开yaml文件
4.     file = open(yaml_file, 'r', encoding="utf-8")
5.     file_data = file.read()
6.     file.close()
7.     all_data = yaml.load_all(file_data)
8.     for data in all_data:
9.         print(data)
10. current_path = os.path.abspath(".")
11. yaml_path = os.path.join(current_path, "config.yaml")
12. get_yaml_load_all(yaml_path)
13. """结果
14. {'animal1': 'dog', 'age': 2}
15. {'animal2': 'cat', 'age': 3}
16. """

复制代码

四、python对象生成yaml文档

1. 直接导入yaml（即import yaml）生成的yaml文档

通过yaml.dump()方法不会将列表或字典数据进行转化yaml标准模式，只会将数据生成到yaml文档中

1. # 将python对象生成yaml文档
2. import yaml
3. def generate_yaml_doc(yaml_file):
4.     py_object = {'school': 'zhang',
5.                  'students': ['a', 'b']}
6.     file = open(yaml_file, 'w', encoding='utf-8')
7.     yaml.dump(py_object, file)
8.     file.close()
9. current_path = os.path.abspath(".")
10. yaml_path = os.path.join(current_path, "generate.yaml")
11. generate_yaml_doc(yaml_path)
12. """结果
13. school: zhang
14. students: [a, b]
15. """

复制代码

2. 使用ruamel模块中的yaml方法生成标准的yaml文档

（1）使用ruamel模块中yaml前提条件

• 使用yaml需要安装的模块：ruamel.yaml（pip3 install ruamel.yaml）;
  
• 导入的模块：from ruamel import yaml
  

（2）ruamel模块生成yaml文档

1. def generate_yaml_doc_ruamel(yaml_file):
2.     from ruamel import yaml
3.     py_object = {'school': 'zhang',
4.                  'students': ['a', 'b']}
5.     file = open(yaml_file, 'w', encoding='utf-8')
6.     yaml.dump(py_object, file, Dumper=yaml.RoundTripDumper)
7.     file.close()
8. current_path = os.path.abspath(".")
9. yaml_path = os.path.join(current_path, "generate.yaml")
10. generate_yaml_doc_ruamel(yaml_path)
11. """结果
12. school: zhang
13. students:
14. - a
15. - b
16. """

复制代码

（3）ruamel模块读取yaml文档

1. # 通过from ruamel import yaml读取yaml文件
2. #学习中遇到问题没人解答？小编创建了一个Python学习交流群：531509025
3. def get_yaml_data_ruamel(yaml_file):
4.     from ruamel import yaml
5.     file = open(yaml_file, 'r', encoding='utf-8')
6.     data = yaml.load(file.read(), Loader=yaml.Loader)
7.     file.close()
8.     print(data)
9. current_path = os.path.abspath(".")
10. yaml_path = os.path.join(current_path, "dict_config.yaml")
11. get_yaml_data_ruamel(yaml_path)

复制代码

来源:https://www.cnblogs.com/djdjdj123/p/18352650
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！