python操作配置文件yaml数据读取数据写入

YAML 语言：它实质上是一种通用的数据串行化格式
一、yaml基本语法规则：

• 大小写敏感
• 使用缩进表示层级关系
• 缩进时不允许使用Tab键，只允许使用空格
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• #表示注释，从这个字符一直到行尾，都会被解析器忽略，这个和python的注释一样

二、yaml支持的数据结构有三种：

• 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
• 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
• 纯量（scalars）：单个的、不可再分的值。字符串、布尔值、整数、浮点数、Null、时间、日期
  对象
  1.python字典

# python
{
"user": "root",
"pwd": "123456,
}

yaml上的格式

    user: root
    pwd: 123456

2.python字典嵌套字典

"qt": {
        "user": "root",
        "pwd": "123456,
        }

yaml上的格式

qt:
    user: root
    pwd: 123456

序列
1.python的list

[{'list1': 123456},
{'list2': 333333}, 
{'list3': 444124}]

yaml格式

- list1: 123456
- list2: 333333
- list3: 444124

纯量
纯量是最基本的、不可再分的值，这里不再举例了。。。。

第三方库需要安装：pip install pyyaml

三、实例

yaml文件写下自己需要的配置
python25.yaml

logger:
  name: python25
  level: DEBUG
  file: python25.txt

excel:
  file: cases.xlsx
  sheet: login

# request配置
request:
  method: post

demo:
  - guiyin
  - hello

用python读取yaml

import yaml
# 读取 yaml 配置, 加载配置项
f = open('python25.yaml', encoding='utf-8')

data = yaml.load(f.read(), Loader=yaml.FullLoader)
print(data)
print(type(data))

f.close()

结果截图：

升级，自己获取yaml的路径，并读取yaml

import yaml
import os

# 获取当前脚本所在文件夹路径
curPath = os.path.dirname(os.path.realpath(__file__))
# 获取yaml文件路径
yamlPath = os.path.join(curPath, "python25.yaml")

# open方法打开直接读出来
f = open(yamlPath, 'r', encoding='utf-8')
cfg = f.read()
print(type(cfg))  # yaml自己读出来是字符串

d = yaml.load(cfg,Loader=yaml.FullLoader)  # 用load方法转字典
print(d)
print(type(d))

运行结果：

---

上边介绍的是yaml文件的读取，下边文件介绍把数据写入yaml
四、把数据写入yaml中

import os
import yaml
data = [{'list1': 123456},
{'list2': 333333}, 
{'list3': 444124}]

curpath = os.path.dirname(os.path.realpath(__file__))
yamlpath = os.path.join(curpath, "data.yaml")

# 写入到yaml文件
with open(yamlpath, "w", encoding="utf-8") as f:
    yaml.dump(data, f,allow_unicode=True)

运行结果截图如下：
data.yaml

五、yaml的封装，封装成类
config_1.yaml

demo:
- guiyin
- hello
excel:
  file: cases.xlsx
  sheet: login
logger:
  file: python25.txt
  level: DEBUG
  name: 修改
request:
  method: post

读取yaml功能，写入yaml功能

import os
import yaml

class YamlHandler:

    def __init__(self,file,encoding = 'utf-8'):
         self.file = file
         self.encoding = encoding
#读取yaml数据
    def get_ymal_data(self):
        with open(self.file,encoding=self.encoding) as f:
            data = yaml.load(f.read(),Loader=yaml.FullLoader)
        return data
#写入yaml数据
    def write_yaml(self,data):
        """
        有中文需要添加allow_unicode=True
        :param yaml_path:
        :param data:
        :param encoding:
        :return:
        """
        with open(self.file,'w',encoding=self.encoding) as f:
            yaml.dump(data,stream=f,allow_unicode = True)



if __name__ == '__main__':
    # 获取当前脚本所在文件夹路径
    curPath = os.path.dirname(os.path.realpath(__file__))
    # 获取yaml文件路径
    yamlPath = os.path.join(curPath, "config_1.yaml")
    # file_path = os.path.join(os.path.dirname(os.path.abspath("__file__")),"config_1.yaml")
    test_yaml = YamlHandler(yamlPath)
    #读取yaml配置文件的值

    data = test_yaml.get_ymal_data()
    print(data)

    #对配置文件的内容进行修改并写入
    data['logger']['name'] = '修改'
    test_yaml.write_yaml(data)
    print(data)
    print(type(data))

运行结果：