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

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

nanshan 2025-01-12 17:27 19 浏览 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)

相关推荐

Let’s Encrypt免费搭建HTTPS网站

HTTPS(全称:HyperTextTransferProtocoloverSecureSocketLayer),是以安全为目标的HTTP通道,简单讲是HTTP的安全版。即HTTP下加入...

使用Nginx配置TCP负载均衡(nginx tcp负载)

假设Kubernetes集群已经配置好,我们将基于CentOS为Nginx创建一个虚拟机。以下是实验种设置的详细信息:Nginx(CenOS8Minimal)-192.168.1.50Kube...

Nginx负载均衡及支持HTTPS与申请免费SSL证书

背景有两台minio文件服务器已做好集群配置,一台是192.168.56.41:9000;另一台是192.168.56.42:9000。应用程序通过Nginx负载均衡调用这两台minio服务,减轻单点...

HTTPS配置实战(https配置文件)

原因现在网站使用HTTPS是规范操作之一,前些日子买了腾讯云服务,同时申请了域名http://www.asap2me.top/,目前该域名只支持HTTP,想升级为HTTPS。关于HTTPS的链接过程大...

只有IP地址没有域名实现HTTPS访问方法

一般来说,要实现HTTPS,得有个注册好的域名才行。但有时候呢,咱只有服务器的IP地址,没注册域名,这种特殊情况下,也能照样实现HTTPS安全访问,按下面这些步骤来就行:第一步,先确认公网...

超详解:HTTPS及配置Django+HTTPS开发环境

众所周知HTTP协议是以TCP协议为基石诞生的一个用于传输Web内容的一个网络协议,在“网络分层模型”中属于“应用层协议”的一种。在这里我们并不研究该协议标准本身,而是从安全角度去探究使用该协议传输数...

Godaddy购买SSL之后Nginx配置流程以及各种错误的解决

完整流程:参考地址:https://sg.godaddy.com/zh/help/nginx-generate-csrs-certificate-signing-requests-3601生成NGI...

Nginx从安装到高可用,一篇搞定(nginx安装与配置详解)

一、Nginx安装1、去官网http://nginx.org/下载对应的nginx包,推荐使用稳定版本2、上传nginx到linux系统3、安装依赖环境(1)安装gcc环境yuminstallgc...

阿里云免费证书申请,配置安装,使用tomcat,支持http/https访问

参数说明商品类型默认已选择云盾证书服务(无需修改)。云盾证书服务类型SSL证书服务的类型。默认已选择云盾SSL证书(无需修改),表示付费版SSL证书。如果您需要免费领取或付费扩容DV单域名证书【免费试...

你试过两步实现Nginx的规范配置吗?极速生成Nginx配置小工具

NGINX是一款轻量级的Web服务器,最强大的功能之一是能够有效地提供HTML和媒体文件等静态内容。NGINX使用异步事件驱动模型,在负载下提供可预测的性能。是当下最受欢迎的高性能的Web...

从零开始搭建HTTPS服务(搭建https网站)

搭建HTTPS服务的最初目的是为了开发微信小程序,因为wx.request只允许发起HTTPS请求,并且还必须和指定的域名进行网络通信。要从零开始搭建一个HTTPS的服务需要下面4...

群晖NAS使用官网域名和自己的域名配置SSL实现HTTPS访问

安全第一步,群晖NAS使用官网域名和自己的域名配置SSL实现HTTPS访问【新手导向】NAS本质还是一个可以随时随地访问的个人数据存储中心,我们在外网访问的时候,特别是在公网IP下,其实会面临着很多安...

让网站快速升级HTTPS协议提高安全性

为什么用HTTPS网络安全越来越受到重视,很多互联网服务网站,都已经升级改造为https协议。https协议下数据包是ssl/tcl加密的,而http包是明文传输。如果请求一旦被拦截,数据就会泄露产生...

用Https方式访问Harbor-1.9版本(https访问流程)

我上周在头条号写过一篇原创文章《Docker-Harbor&Docker-kitematic史上最详细双系统配置手册》,这篇算是它的姊妹篇吧。这篇文章也将用到我在头条写的另一篇原创文章的...

如何启用 HTTPS 并配置免费的 SSL 证书

在Linux服务器上启用HTTPS并配置免费的SSL证书(以Let'sEncrypt为例)可以通过以下步骤完成:---###**一、准备工作**1.**确保域名已解析**...

取消回复欢迎 发表评论: