网站首页 > 技术文章 正文
引言:
代码目的是提供一个简单、灵活、健壮的接口,能够高效地操作 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删除列表元素的3种方法,你都会吗?
- 下一篇: Python 中删除列表元素的三种方法
猜你喜欢
- 2025-01-05 Python教程:Python中列表的创建和删除详解
- 2025-01-05 Python轻松管理你的CSV文件:读取、写入、删除一步到位!
- 2025-01-05 Python——pandas删除指定行或列
- 2025-01-05 从 Python 列表中删除 NaN:完整指南
- 2025-01-05 Python文件、文件夹删除之os、shutil
- 2025-01-05 从 Python 字符串中删除特殊字符:完整指南
- 2025-01-05 Python 中删除列表元素的三种方法
- 2025-01-05 Python删除列表元素的3种方法,你都会吗?
- 2025-01-05 删除 Python 列表中的最后一个元素
- 2025-01-05 python目录、文件删除方法及详细示例
- 05-25Python 3.14 t-string 要来了,它与 f-string 有何不同?
- 05-25Python基础元素语法总结
- 05-25Python中的变量是什么东西?
- 05-25新手常见的python报错及解决方案
- 05-2511-Python变量
- 05-2510个每个人都是需要知道Python问题
- 05-25Python编程:轻松掌握函数定义、类型及其参数传递方式
- 05-25Python基础语法
- 257℃Python短文,Python中的嵌套条件语句(六)
- 257℃python笔记:for循环嵌套。end=""的作用,图形打印
- 256℃PythonNet:实现Python与.Net代码相互调用!
- 251℃Python操作Sqlserver数据库(多库同时异步执行:增删改查)
- 251℃Python实现字符串小写转大写并写入文件
- 106℃原来2025是完美的平方年,一起探索六种平方的算吧
- 91℃Python 和 JavaScript 终于联姻了!PythonMonkey 要火?
- 81℃Ollama v0.4.5-v0.4.7 更新集合:Ollama Python 库改进、新模型支持
- 最近发表
- 标签列表
-
- python中类 (31)
- python 迭代 (34)
- python 小写 (35)
- python怎么输出 (33)
- python 日志 (35)
- python语音 (31)
- python 工程师 (34)
- python3 安装 (31)
- python音乐 (31)
- 安卓 python (32)
- python 小游戏 (32)
- python 安卓 (31)
- python聚类 (34)
- python向量 (31)
- python大全 (31)
- python次方 (33)
- python桌面 (32)
- python总结 (34)
- python浏览器 (32)
- python 请求 (32)
- python 前端 (32)
- python验证码 (33)
- python 题目 (32)
- python 文件写 (33)
- python中的用法 (32)