YAML文件管理不再复杂:Python读取、修改、删除轻松搞定

liftword5个月前 (02-04)技术文章46

引言:

代码目的是提供一个简单、灵活、健壮的接口,能够高效地操作 YAML 文件,同时确保在处理(读取、写入、修改和删除操作)过程中避免常见的错误

代码如下:

import os
import yaml

class YamlFile:
    """
    该类用于处理YAML文件的读取、写入和修改操作。
    支持单文档和多文档的读取,并能动态修改文件内容。
    """

    def __init__(self, yaml_file):
        """
        初始化,检查指定的yaml文件是否存在。
        :param yaml_file: 要处理的YAML文件路径。
        """
        if os.path.exists(yaml_file):  # 判断文件是否存在
            self.yaml_file = yaml_file  # 如果存在,保存文件路径
        else:
            raise FileNotFoundError(f"YAML文件不存在: {yaml_file}")  # 如果文件不存在,抛出异常
        
        self._data = None  # 用于缓存单文档数据
        self._data_all = None  # 用于缓存多文档数据

    def _read_yaml(self, mode='single'):
        """
        内部读取yaml文件的方法,支持单文档或多文档模式。
        :param mode: 'single' 或 'all',分别表示读取单个文档和所有文档。
        :return: 返回yaml文件内容。
        """
        try:
            with open(self.yaml_file, 'r', encoding='utf-8') as f:  # 打开YAML文件,指定编码
                if mode == 'single':
                    return yaml.safe_load(f)  # 读取单个文档
                elif mode == 'all':
                    return list(yaml.safe_load_all(f))  # 读取多个文档并返回为列表
                else:
                    raise ValueError("mode 参数必须是 'single' 或 'all'")  # 如果mode不合法,抛出异常
        except Exception as e:
            raise IOError(f"读取YAML文件时发生错误: {e}")  # 如果读取过程中出现错误,抛出异常

    def read_yaml(self):
        """
        读取YAML文件中的单个文档。
        :return: 返回YAML文件的内容(字典)。
        """
        if not self._data:  # 如果缓存的数据为空,则读取文件
            self._data = self._read_yaml(mode='single')  # 调用内部方法读取单文档
        return self._data  # 返回缓存的数据

    def read_yaml_all(self):
        """
        读取YAML文件中的所有文档。
        :return: 返回一个包含所有YAML文档的列表。
        """
        if not self._data_all:  # 如果缓存的数据为空,则读取文件
            self._data_all = self._read_yaml(mode='all')  # 调用内部方法读取多文档
        return self._data_all  # 返回缓存的数据

    def write_yaml(self, data):
        """
        将数据写入YAML文件,覆盖原文件内容。
        :param data: 要写入的数据(字典或列表)。
        """
        try:
            with open(self.yaml_file, 'w', encoding='utf-8') as f:  # 打开文件进行写入
                yaml.dump(data, f, allow_unicode=True)  # 将数据转为YAML格式写入文件
            self._data = data  # 更新缓存数据
        except Exception as e:
            raise IOError(f"写入YAML文件时发生错误: {e}")  # 如果写入过程中发生错误,抛出异常

    def get_yaml_value(self, key):
        """
        获取YAML文件中指定键的值。
        :param key: 要查找的键。
        :return: 对应的值,如果键不存在,返回None。
        """
        data = self.read_yaml()  # 获取单文档的数据
        return data.get(key, None)  # 获取指定键的值,若键不存在返回None

    def set_yaml_value(self, key, value):
        """
        设置YAML文件中指定键的值,并更新文件。
        :param key: 要设置的键。
        :param value: 要设置的值。
        :return: 操作是否成功,成功返回True,失败返回False。
        """
        data = self.read_yaml()  # 获取当前YAML数据
        data[key] = value  # 修改或添加键值对
        self.write_yaml(data)  # 将修改后的数据写回文件
        return True  # 返回成功

    def remove_yaml_key(self, key):
        """
        删除YAML文件中的指定键及其值,并更新文件。
        :param key: 要删除的键。
        :return: 删除是否成功,成功返回True,键不存在时返回False。
        """
        data = self.read_yaml()  # 获取当前YAML数据
        if key in data:  # 检查键是否存在
            del data[key]  # 删除指定键
            self.write_yaml(data)  # 将修改后的数据写回文件
            return True  # 返回成功
        else:
            return False  # 如果键不存在,返回失败
            
            
if __name__ == "__main__":
    # 示例:使用YamlFile类
    yaml_path = "example.yaml"

    # 创建YamlFile对象
    yaml_handler = YamlFile(yaml_path)

    # 读取YAML单文档内容
    yaml_data = yaml_handler.read_yaml()
    print("YAML单文档数据:", yaml_data)

    # 获取特定键的值
    key_value = yaml_handler.get_yaml_value("key1")
    print("key1的值:", key_value)

    # 修改键值对
    yaml_handler.set_yaml_value("key1", "new_value")
    print("修改后的YAML数据:", yaml_handler.read_yaml())

    # 删除键值对
    result = yaml_handler.remove_yaml_key("key1")
    print("删除key1结果:", result)

相关文章

Python 字典的 10 种强大方法(python字典详解)

clear()clear() 方法用于从字典中删除所有项目。该方法返回一个空字典。在使用此方法之前,应该确保您不再需要字典中的任何项目。例:my_dict = { "name" : "John" ,...

Python.get()方法:改进您的字典操作

Python 字典是通用的数据结构,允许您使用键值对存储和检索数据。虽然访问字典中的值很简单,但有时可能会导致错误,或者在缺少键时需要额外检查。这就是 Python 的 .get() 方法的亮点。了...

详解Python字典格式化输出(python format 字典)

在Python中,字典的格式化输出有多种方法,常见的有下面几种方式:使用print()函数直接输出这是最简单的方法,直接使用print()打印字典my_dict = {'name':...

Python字典和集合(python中字典的基本操作)

上期我们学习了Python的列表和元组,通过相关的练习应该有所收获。今天来讲一讲字典和集合。1.字典 字典是一种可变容器模型,可存储任意类型对象。和之前我们讲过的列表及元组都不相同,字典中存储的是一组...

Python 中的字典推导式(python中字典的运算)

通过本文,你将了解有关 Python 字典推导式的所有信息,包括如何创建字典、使用条件语句(if-else 语句)访问字典以及如何使用易于实现的步骤嵌套推导式!什么是字典Python 中的字典是项目的...

关于Python字典,你了解多少?(python字典总结)

这篇文章主要为大家介绍了python字典,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助字典概述字典是一个映射集合,他储存的是键值对,通过键来查找值,而不是索引字典定义通过大括...