YAML文件管理不再复杂:Python读取、修改、删除轻松搞定
nanshan 2025-01-12 17:27 25 浏览 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)
相关推荐
- 0722-6.2.0-如何在RedHat7.2使用rpm安装CDH(无CM)
-
文档编写目的在前面的文档中,介绍了在有CM和无CM两种情况下使用rpm方式安装CDH5.10.0,本文档将介绍如何在无CM的情况下使用rpm方式安装CDH6.2.0,与之前安装C5进行对比。环境介绍:...
- ARM64 平台基于 openEuler + iSula 环境部署 Kubernetes
-
为什么要在arm64平台上部署Kubernetes,而且还是鲲鹏920的架构。说来话长。。。此处省略5000字。介绍下系统信息;o架构:鲲鹏920(Kunpeng920)oOS:ope...
- 生产环境starrocks 3.1存算一体集群部署
-
集群规划FE:节点主要负责元数据管理、客户端连接管理、查询计划和查询调度。>3节点。BE:节点负责数据存储和SQL执行。>3节点。CN:无存储功能能的BE。环境准备CPU检查JDK...
- 在CentOS上添加swap虚拟内存并设置优先级
-
现如今很多云服务器都会自己配置好虚拟内存,当然也有很多没有配置虚拟内存的,虚拟内存可以让我们的低配服务器使用更多的内存,可以减少很多硬件成本,比如我们运行很多服务的时候,内存常常会满,当配置了虚拟内存...
- 国产深度(deepin)操作系统优化指南
-
1.升级内核随着deepin版本的更新,会自动升级系统内核,但是我们依旧可以通过命令行手动升级内核,以获取更好的性能和更多的硬件支持。具体操作:-添加PPAs使用以下命令添加PPAs:```...
- postgresql-15.4 多节点主从(读写分离)
-
1、下载软件[root@TX-CN-PostgreSQL01-252software]#wgethttps://ftp.postgresql.org/pub/source/v15.4/postg...
- Docker 容器 Java 服务内存与 GC 优化实施方案
-
一、设置Docker容器内存限制(生产环境建议)1.查看宿主机可用内存bashfree-h#示例输出(假设宿主机剩余16GB可用内存)#Mem:64G...
- 虚拟内存设置、解决linux内存不够问题
-
虚拟内存设置(解决linux内存不够情况)背景介绍 Memory指机器物理内存,读写速度低于CPU一个量级,但是高于磁盘不止一个量级。所以,程序和数据如果在内存的话,会有非常快的读写速度。但是,内存...
- Elasticsearch性能调优(5):服务器配置选择
-
在选择elasticsearch服务器时,要尽可能地选择与当前业务量相匹配的服务器。如果服务器配置太低,则意味着需要更多的节点来满足需求,一个集群的节点太多时会增加集群管理的成本。如果服务器配置太高,...
- Es如何落地
-
一、配置准备节点类型CPU内存硬盘网络机器数操作系统data节点16C64G2000G本地SSD所有es同一可用区3(ecs)Centos7master节点2C8G200G云SSD所有es同一可用区...
- 针对Linux内存管理知识学习总结
-
现在的服务器大部分都是运行在Linux上面的,所以,作为一个程序员有必要简单地了解一下系统是如何运行的。对于内存部分需要知道:地址映射内存管理的方式缺页异常先来看一些基本的知识,在进程看来,内存分为内...
- MySQL进阶之性能优化
-
概述MySQL的性能优化,包括了服务器硬件优化、操作系统的优化、MySQL数据库配置优化、数据库表设计的优化、SQL语句优化等5个方面的优化。在进行优化之前,需要先掌握性能分析的思路和方法,找出问题,...
- Linux Cgroups(Control Groups)原理
-
LinuxCgroups(ControlGroups)是内核提供的资源分配、限制和监控机制,通过层级化进程分组实现资源的精细化控制。以下从核心原理、操作示例和版本演进三方面详细分析:一、核心原理与...
- linux 常用性能优化参数及理解
-
1.优化内核相关参数配置文件/etc/sysctl.conf配置方法直接将参数添加进文件每条一行.sysctl-a可以查看默认配置sysctl-p执行并检测是否有错误例如设置错了参数:[roo...
- 如何在 Linux 中使用 Sysctl 命令?
-
sysctl是一个用于配置和查询Linux内核参数的命令行工具。它通过与/proc/sys虚拟文件系统交互,允许用户在运行时动态修改内核参数。这些参数控制着系统的各种行为,包括网络设置、文件...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- linux 查询端口号 (58)
- docker映射容器目录到宿主机 (66)
- 杀端口 (60)
- yum更换阿里源 (62)
- internet explorer 增强的安全配置已启用 (65)
- linux自动挂载 (56)
- 禁用selinux (55)
- sysv-rc-conf (69)
- ubuntu防火墙状态查看 (64)
- windows server 2022激活密钥 (56)
- 无法与服务器建立安全连接是什么意思 (74)
- 443/80端口被占用怎么解决 (56)
- ping无法访问目标主机怎么解决 (58)
- fdatasync (59)
- 405 not allowed (56)
- 免备案虚拟主机zxhost (55)
- linux根据pid查看进程 (60)
- dhcp工具 (62)
- mysql 1045 (57)
- 宝塔远程工具 (56)
- ssh服务器拒绝了密码 请再试一次 (56)
- ubuntu卸载docker (56)
- linux查看nginx状态 (63)
- tomcat 乱码 (76)
- 2008r2激活序列号 (65)