yaml模块

一、yaml介绍

yaml是一个专门用来写配置文件的语言。
yaml的可读性好。
yaml和脚本语言的交互性好。
目前现有的语言实现广泛：Ruby，Java，Perl，Python，PHP，OCaml，JavaScript。

python还有一个内置configparse模块也可以用于编写配置文件

• 如果需要和其他语言特别是Java共享配置文件，那么推荐yaml
• 如果纯python语言使用，可以使用configparse

1. yaml文件规则

• 区分大小写
• 使用缩进表示层级关系
• 使用空格键缩进，而非Tab键缩进
• 缩进的空格数目不固定，只需要相同层级的元素左侧对齐
• 文件中的字符串不需要使用引号标注，但若字符串包含有特殊字符则需用引号标注
• 注释标识为 #

2. yaml文件数据结构

• 对象：键值对的集合（简称 "映射或字典"）
• 键值对用冒号 “:” 结构表示，冒号与值之间需用空格分隔
• 数组：一组按序排列的值（简称 "序列或列表"）
• 数组前加有 “-” 符号，符号与值之间需用空格分隔
• 纯量(scalars)：单个的、不可再分的值（如：字符串、bool值、整数、浮点数、时间、日期、null等）
• None值可用null可 ~ 表示

二、python中读取yaml配置文件

1、安装

pip3 install pyyaml

2、导入

import yaml

3、 读取yaml文件数据

python通过open方式读取文件数据，再通过load函数将数据转化为列表或字典

import yaml

with open(r'config.yml',encoding='utf-8') as f:
    loaded = yaml.safe_load(f)

config = {}
for k in loaded:
    if k.isupper():
        config[k] = loaded[k]
print(config)

如果使用yaml.load(f)会报不安全提示：
YAMLLoadWarning: calling yaml.load() without Loader=... is deprecated, as the default Loader is unsafe. Please read https://msg.pyyaml.org/load for full details.
  loaded = yaml.load(f)

使用yaml.safe_load(f)即可

4、yaml文件数据为键值对

（1）yaml文件中内容为键值对,即python中字典

user: user1
password: 123456

python解析yaml文件后获取的数据：
{'user': 'user1', 'password': 123456}

（2）yaml文件中内容为“键值对'嵌套"键值对",即python中字典嵌套字典

user1:
  name: a
  psw: 123
user2:
  name: b
  psw: 456

python解析yaml文件后获取的数据：
{'user1': {'name': 'a', 'psw': 123}, 'user2': {'name': 'b', 'psw': 456}}

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

user3:
  - a
  - b
  - c
user4:
  - b

python解析yaml文件后获取的数据：
{'user3': ['a', 'b', 'c'], 'user4': ['b']}

5、 yaml文件数据为数组

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

- aa
- bb
- 11

python解析yaml文件后获取的数据：
['aa', 'bb', 11]

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

- user1: aaa
- user2: bbb
  age: 10
  sex: male


python解析yaml文件后获取的数据：
[{'usr1': 'aaa'}, {'usr2': 'bbb', 'age': 10, 'sex': 'male'}]

6、 yaml文件中基本数据类型

• s_val: name # 字符串：{'s_val': 'name'}
• spec_s_val: "name " # 特殊字符串：{'spec_s_val': 'name '}
• 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)}

三、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）安装、导入

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文件
from ruamel import yaml

def get_yaml_data_ruamel(yaml_file):
    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)