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

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

bigegpt 2025-01-03 14:20 66 浏览

引言:

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

相关推荐

数据中台与业务中台总体技术架构设计方案

《数据中台与业务中台总体技术架构设计方案》提出**“开放、稳定、滋养”三原则**,强调通过统一技术架构与框架破除烟囱式系统,构建**“业务中台+数据中台”闭环体系**。方案主张从单体架...

三分钟摸清楚什么叫前后端分离(什么是前后端分离架构?)

什么叫前后端分离?其实,前后端分离的初衷是为了分离前后端开发人员的职责,解决开发模式的问题。说到底,前后端分离就是将前端视图和后端数据进行分离,这样,后端只需要提供接口(后端数据)给前端,而前端也可以...

刚刚,给学妹普及了登录的两大绝学

今天跟大家聊一个比较基础的话题,就是实现登录的方式有哪些?适合刚入行的朋友。华山之Session绝学Session我们称之为会话控制,是一种在服务器端保持会话状态的解决方案。通俗点来讲就是客户...

6种微服务RPC框架,你知道几个?(grpc是微服务框架吗)

开源RPC框架有哪些呢?一类是跟某种特定语言平台绑定的,另一类是与语言无关即跨语言平台的。跟语言平台绑定的开源RPC框架主要有下面几种。Dubbo:国内最早开源的RPC框架,由阿里巴巴公司...

微服务中,Spring Cloud 有哪些注册中心?

SpringCloud是微服务架构中经常使用的一个框架,它提供了一系列工具来帮助开发者构建和管理分布式系统,而服务注册中心又是微服务架构中一个关键组件。那么,SpringCloud支持哪些注册...

Eureka的自我保护机制(eureka自我保护机制原理)

最近遇到一个问题,服务之间调用报错,显示无法路由到指定服务,但是对应的服务是启动的,查询eureka,结果eureka上显示如下,所有实例均消失,我个人对注册中心并没有什么研究,进行正好借此机会简单总...

eureka、zookepeer、nacos的区别(eureka和nacos哪个更好)

前言随着微服务被各大企业应用在项目中,微服务的框架也被更多人学习和使用,但是大部分情况下都是停留在应用层。一、演变过程1.1服务注册和发现基本概念服务注册:将某个或者某些服务的信息(模块的ip和...

40K+Star!Mall电商实战项目开源,附源码、教程合集

最近看了下我的Github,发现mall项目已经突破40K+Star,有点小激动!记得去年8月的时候mall项目刚过20K+Star,时隔1年多已经增长到了40K+Star。今天跟大家聊聊mall项目...

SpringCloud 常见注册中心的比较(springcloud注册过程)

一、概述springcloud是一个非常优秀的微服务框架,要管理众多的服务,就需要对这些服务进行治理,也就是我们说的服务治理,服务治理的作用就是在传统的rpc远程调用框架中,管理每个服务与每个服务之间...

简单介绍Nacos服务注册中心(nacos注册中心有什么用)

Nacos是阿里开源的一个新框架,在分布式的架构中,Nacos同时扮演着服务注册中心和配置中心的角色。今天主要讲的是Nacos作为服务注册中心。分布式中著名的CAP理论,任何一种服务注册中心都只能实现...

入门注册中心——consul(注册中心怎么注册)

基础概念什么是注册中心随着微服务理论发展的成熟,越来越多互联网公司采用微服务架构来支持业务发展。各个微服务之间都需要通过注册中心来实现自动化的注册和发现。注册中心主要有三种角色:服务提供者(RPCS...

08 Eureka的基础知识(eureka replication)

Eureka是Netflix开发的服务发现框架,SpringCloud将它集成在自己的子项目spring-cloud-netflix中,实现SpringCloud的服务发现功能。上图简要描述了Eur...

微服务架构中的服务注册与发现有哪些?Zookeeper、Eu

“大家好,我是码哥,《Redis高手心法》作者,本章节选自《Java面试高手心法58讲》专栏。随着单体应用的拆分,我们面临的首要问题就是采用哪种方式实现服务间的调用,像之前单体应用可能直接在配...

Eureka 都挂了,微服务还能调通吗?

如果你做过微服务开发,这个面试题应该能够立马答出来,如果你没做过微服务开发,但是学过一些SpringCloud组件的用法,这个问题可能要稍微想一下,但是也应该能够答出来。今天就来和大家说说这个问...

ZooKeeper、Eureka、Consul 、Nacos微服务注册中心对比

注册中心前言服务注册中心本质上是为了解耦服务提供者和服务消费者。对于任何一个微服务,原则上都应存在或者支持多个提供者,这是由微服务的分布式属性决定的。更进一步,为了支持弹性扩缩容特性,一个微服务的提供...