Python+requests 之封装yaml配置文件的读写

简介

YAML语言的设计目标，是方便人类读写。实质上是一种通用的数据串行化格式。它的基本语法规则如下：

• 大小写敏感
• 使用缩进表示层级关系
• 缩进时不允许使用Tab键，只允许使用空格。
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• '#'表示注释, 会被解析器忽略

YAML 支持的数据结构有三种

• 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
• 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
• 纯量（scalars）：单个的、不可再分的值

 

---

open函数

open() 函数用于打开一个文件，创建一个 file 对象，相关的方法才可以调用它进行读写

函数语法：

open(name[, mode[, buffering]])

参数说明：

• name : 一个包含了你要访问的文件名称的字符串值。

• mode : mode 决定了打开文件的模式：只读，写入，追加等。所有可取值见如下的完全列表。这个参数是非强制的，默认文件访问模式为只读(r)。

• buffering : 如果 buffering 的值被设为 0，就不会有寄存。如果 buffering 的值取 1，访问文件时会寄存行。如果将 buffering 的值设为大于 1 的整数，表明了这就是的寄存区的缓冲大小。如果取负值，寄存区的缓冲大小则为系统默认

不同模式打开文件的完全列表：

模式	描述
r	以只读方式打开文件。文件的指针将会放在文件的开头。这是默认模式
rb	以二进制格式打开一个文件用于只读。文件指针将会放在文件的开头。这是默认模式
r+	打开一个文件用于读写。文件指针将会放在文件的开头
rb+	以二进制格式打开一个文件用于读写。文件指针将会放在文件的开头
w	打开一个文件只用于写入。如果该文件已存在则打开文件，并从开头开始编辑，即原有内容会被删除。如果该文件不存在，创建新文件
wb	以二进制格式打开一个文件只用于写入。如果该文件已存在则打开文件，并从开头开始编辑，即原有内容会被删除。如果该文件不存在，创建新文件
w+	打开一个文件用于读写。如果该文件已存在则打开文件，并从开头开始编辑，即原有内容会被删除。如果该文件不存在，创建新文件
wb+	以二进制格式打开一个文件用于读写。如果该文件已存在则打开文件，并从开头开始编辑，即原有内容会被删除。如果该文件不存在，创建新文件
a	打开一个文件用于追加。如果该文件已存在，文件指针将会放在文件的结尾。也就是说，新的内容将会被写入到已有内容之后。如果该文件不存在，创建新文件进行写入
ab	以二进制格式打开一个文件用于追加。如果该文件已存在，文件指针将会放在文件的结尾。也就是说，新的内容将会被写入到已有内容之后。如果该文件不存在，创建新文件进行写入
a+	打开一个文件用于读写。如果该文件已存在，文件指针将会放在文件的结尾。文件打开时会是追加模式。如果该文件不存在，创建新文件用于读写
ab+	以二进制格式打开一个文件用于追加。如果该文件已存在，文件指针将会放在文件的结尾。如果该文件不存在，创建新文件用于读写

---

环境配置：

安装pyyaml：python -m pip install pyyaml

---

Read

import yaml

# 读取yaml文件
class Getyaml():
    def __init__(self, path, param=None):
        self.path = path                                # 文件路径
        self.param = param                              # 读取信息的key,不传默认获取所有数据

    # 获取yaml文件中的数据
    def get_data(self):
        with open(self.path, 'rb') as y:
            cont = y.read()                             # 获取yaml文件中的所有信息
        yaml.warnings({'YAMLLoadWarning': False})       # 禁用加载器warnings报警
        cf = yaml.load(cont)                            # 将bytes格式转成dict格式
        y.close()                                       # 关闭文件
        if self.param == None:
            return cf                                   # 返回所有数据
        else:
            return cf.get(self.param)                   # 获取键为param的值

if __name__ == "__main__":
    p = "Z:\\readwrite.yaml"
    print(Getyaml(path=p, param="key").get_data())

# 注： 若yaml文件中存在重复的key, 读取时则会读取最新写入的

---

Write

import yaml

# 写入yaml文件
class Writeyaml():
    def __init__(self, path, message):
        self.path = path
        self.message = message

    def echo_data(self):
        with open(self.path, "a+", encoding="utf-8") as f:    
        # 注：此模式为追加模式,若想直接重写则将open函数中的模式'a+'改为'w'
            yaml.dump(self.message, f)
        f.close()

if __name__ == "__main__":
    m = {"key1": "value1", "key2": "value2", "dict_1": {"dict_2": {"dict_3": ["test1", "test2", "test3"]}}}
    p = "Z:\\readwrite.yaml"
    Writeyaml(path=p, message=m).echo_data()

多次追加的结果如下：

 

# 除使用pyyaml库外，还可以通过ruamel模块操作yaml文件，pip安装方法：python -m pip install ruamel.yaml