百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

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

nanshan 2025-01-12 17:27 23 浏览 0 评论

引言:

代码目的是提供一个简单、灵活、健壮的接口,能够高效地操作 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)

相关推荐

Linux 的磁盘系统,和你了解的Windows差别很大

我的C盘去哪了?一个系统,如果没有存储,那么也就不能称之为系统。存储性是一个完整系统的重要组成部分。例如AWS最开始的服务就是S3(用来存储数据的云服务),足以见得存储对于一个应用平台是多么的重要。...

一文读懂 Linux 硬盘挂载:从问题到解决方案

各位互联网大厂的后端开发伙伴们!在咱们日常工作中,操作Linux系统是常有的事儿吧。你们有没有遇到过这样的场景:新添加了一块硬盘,满心欢喜准备用来存储重要数据或者部署新的应用服务,却突然发现不知道...

硬盘分区(硬盘分区格式)

 磁盘(硬盘)分区,可以分C、D、E等分区,大家可能都会用,会根据自已的需要确定所需的空间,但分区是如何工作的呢,内容如下。Windows中有3类:MBR分区:MasterBootRecord,也...

parted命令工具分区介绍(particle命令)

linux系统磁盘分区通常可以使用fdisk和parted命令,当分区大小小于2TB的时候,两种皆可以使用,当分区大于2TB的话,就需要用parted分区。以下介绍parted命令相关使用,以sdb为...

Linux 服务器上查看磁盘类型的方法

方法1:使用lsblk命令lsblk输出说明:TYPE列显示设备类型,如disk(物理磁盘)、part(分区)、rom(只读存储)等。NAME列显示设备名称(如sda、nvme0n1)。TR...

Linux分区命令fdisk和parted使用介绍

摘要:一般情况下,Linux分区都是选择fdisk工具,要求硬盘格式为MBR格式,能支持的最大分区空间为2T。但是目前在实际生产环境中使用的磁盘空间越来越大,呈TB级别增长;而常用的fdisk这个工具...

linux 分区原理与名词解释(linux操作系统中的分区类型)

分区的意义将磁盘分成几份,每份挂在到文件系统的那个目录在linux里的文件系统Ext2:早期的格式,不支持日志功能Ext3:ext2改良版,增加了日志功能,是最基本且最常用的使用格式了Ext4:针对e...

linux 分区合并(linux合理分区)

查看虚拟机当前磁盘挂载情况fdisk-l选择磁盘fdisk/dev/sda查看磁盘分区情况p重新选择分区n选择主分区p保存w创建物理卷pvcreate/dev/sda3查看物理卷信息pvdi...

如何在 Linux 系统中永久禁用交换分区 ?

Linux操作系统中的交换分区或交换文件充当硬盘上的临时存储区域,当物理内存(RAM)满时,系统使用该存储区域。它用于交换较少使用的内存页,这样系统就不会因为运行应用程序而耗尽物理内存。随着技术的发...

Linux 如何知道硬盘已用多少空间、未用多少空间

刚出社会时,去了一家公司上班,老板为了省钱,买的服务器是低配的,硬盘大小只有40G,有一次网站突然不能访问了,排查半天才知道原来服务器的硬盘空间已用完,已无可用空间。第一步是查看硬盘的使用情况,第二步...

用Linux系统管理磁盘空间 就该这么来

要想充分有效的管理使用Linux系统中的存储空间,用户必须要做的就是双管齐下,一边扩充空间一边限制空间。不得不说的就是很多时候磁盘空间就像水资源,需节制水流。说到要如何实现限制空间就离不开使用LVM技...

Windows 11 磁盘怎么分区?(windows11磁盘怎么分区)

Windows11磁盘分区技术解析与操作指南:构建高效存储体系一、磁盘分区的技术本质与系统价值磁盘分区作为存储系统的基础架构,通过逻辑划分实现数据隔离与管理优化。Windows11采用NTF...

linux上创建多个文件分区,格式化为 ext2、ext3、ext4、XFS 文件

以下是在Linux系统上创建多个20GB文件分区并格式化为不同文件系统的分步指南:步骤1:创建基础文件(4个20GB文件)bash#创建4个20GB稀疏文件(实际占用空间随写入量增长)ddif=/...

救命的U盘低格哪家最强?(低格优盘)

周二时有位童鞋留言说U盘之前做过引导盘,现在格式化不了,用各种工具都不行,而且因为U盘厂商的关系,查不到U盘主控,无法量产恢复,特来求助。小编花了点时间特意弄坏一个U盘分区,终于试出方法了,特来分享一...

Linux 查看硬件磁盘存储大小和磁盘阵列(RAID)的组合方式

一、查看硬件磁盘存储大小查看所有磁盘信息:#lsblk该命令会列出所有磁盘(如/dev/sda、/dev/nvme0n1)及其分区和挂载点。查看磁盘总容量:fdisk-l#或parted-...

取消回复欢迎 发表评论: