使用ruamel保持YAML文件顺序
ruamel.yaml 是一个功能强大的 Python 库，用于处理 YAML 文件。它支持保留 YAML 文件中的顺序和注释，这在需要修改现有 YAML 文件而不破坏其结构时非常有用。以下是如何使用 ruamel.yaml 保持 YAML 文件顺序的示例。
安装 ruamel.yaml
首先，确保你已经安装了 ruamel.yaml。你可以使用 pip 进行安装：
pip install ruamel.yaml读取和写入 YAML 文件
以下是一个示例，展示了如何使用 ruamel.yaml 读取、修改和写入 YAML 文件，同时保持其顺序和注释。
示例 YAML 文件 (example.yaml)
# This is a comment
key1: value1
key2: value2
key3:
subkey1: subvalue1
subkey2: subvalue2Python 代码
from ruamel.yaml import YAML
from ruamel.yaml.comments import CommentedMap
# 创建 YAML 对象
yaml = YAML()
# 读取 YAML 文件
with open('example.yaml', 'r') as file:
data = yaml.load(file)
# 确保数据是 CommentedMap 类型，以保留顺序和注释
if not isinstance(data, CommentedMap):
raise TypeError("Expected data to be a CommentedMap")
# 修改数据
data['key2'] = 'new_value2'
data['key4'] = 'value4'
# 写回 YAML 文件
with open('example.yaml', 'w') as file:
yaml.dump(data, file)详细解释
- 导入库： from ruamel.yaml import YAML from ruamel.yaml.comments import CommentedMap
- 创建 YAML 对象： yaml = YAML()
- 读取 YAML 文件： with open('example.yaml', 'r') as file: data = yaml.load(file)
- 确保数据类型： 确保读取的数据是
CommentedMap类型，以保留顺序和注释。 if not isinstance(data, CommentedMap): raise TypeError("Expected data to be a CommentedMap") - 修改数据： 你可以像操作普通字典一样修改数据。 data['key2'] = 'new_value2' data['key4'] = 'value4'
- 写回 YAML 文件： with open('example.yaml', 'w') as file: yaml.dump(data, file)
保留注释
ruamel.yaml 还可以保留和处理注释。以下是一个示例，展示了如何在修改 YAML 文件时保留注释：
示例 YAML 文件 (example_with_comments.yaml)
# This is a comment
key1: value1 # Inline comment
key2: value2
key3:
subkey1: subvalue1
subkey2: subvalue2Python 代码
from ruamel.yaml import YAML
from ruamel.yaml.comments import CommentedMap
# 创建 YAML 对象
yaml = YAML()
# 读取 YAML 文件
with open('example_with_comments.yaml', 'r') as file:
data = yaml.load(file)
# 确保数据是 CommentedMap 类型，以保留顺序和注释
if not isinstance(data, CommentedMap):
raise TypeError("Expected data to be a CommentedMap")
# 修改数据
data['key2'] = 'new_value2'
data['key4'] = 'value4'
# 写回 YAML 文件
with open('example_with_comments.yaml', 'w') as file:
yaml.dump(data, file)通过这种方式，你可以使用 ruamel.yaml 读取、修改和写入 YAML 文件，同时保留其顺序和注释。这对于需要维护现有 YAML 文件结构和注释的场景非常有用。
相关·内容
1回答
我正在尝试将新元素添加到YAML文件中，但我希望新元素能够保持视觉顺序，使文件更易于阅读。我希望用orderdict来保持顺序，但是这样我们得到了!!omap指令“污染”了YAML文件。我希望新元素具有相同的顺序，在下面的代码中有"yaml_doc“示例。 有没有一种方法可以向YAML添加新元素，并且在转储文件时保持顺序</em
浏览 83提问于2019-07-02得票数 1
回答已采纳
1回答
我使用ruamel.yaml将dict转储到yaml文件。在这样做的同时，我想保持字典的顺序。这就是为什么我遇到了这个问题。python/object/apply:ruamel.yaml.comments.CommentedMap或dictitemsfrom ruamel.yaml.comments:
浏览 5提问于2022-04-13得票数 1
回答已采纳
我试图使用ruamel.yaml将Python转储到YAML文件中。，我已经做到了with open('outfile.yaml', 'w') as f:
ruamel.yaml.round_trip_dump(mydictruamel.yaml也是，在谷歌上搜索"ruamel
浏览 4提问于2016-10-24得票数 8
我希望使用ruamel.yaml对一个大型的人工编辑的YAML文件执行一些自动编辑。输入文件包含合并键，如下所示： foo: &foo name: qux
<<: *foo 如果可能，我希望保留显式name键和<<合并键的相对顺序，但看起来ruamel确实希望合并键排在第一位。以下是我在ruamel中来回访问这个YAML时得到的结果： fo
浏览 22提问于2019-01-16得票数 1
回答已采纳
我希望输出如下面的YAML： Food: category: fruit我使用了下面的代码以与上面相同的顺序打印，但是输出并不像预期的那样。代码：
yaml_result = [{'item': 'Food_eat', 'Food': {'fo
浏览 1提问于2019-11-06得票数 2
回答已采纳
1回答
我还想保持字典的顺序。这是一个MWE：from ruamel.yaml import YAML
'a':[[1,('\n')这是我实际得到的：- [1, 2]b: 1
a:
浏览 33提问于2017-08-21得票数 3
回答已采纳
2回答
我正在尝试读取一个YAML文件，并按照它在文件中的顺序打印出我在上面的列表。b: ...for key, value in yaml.load(open(input_file)).items():输出变为：b
然而，我需要它是
浏览 7提问于2017-08-02得票数 2
回答已采纳
我有以下Python代码：target = open("target.yaml", "r")sourceValues = ruamel.yaml.load(source, ruamel.yaml.RoundTripLoader, preserve_quotes=Tr
浏览 16提问于2022-08-09得票数 -1
回答已采纳
1回答
我使用ruamel.yaml进行往返加载/转储，但是在一些带有手工创建的字符串的文件中，我希望保留它们。有时这很好，因为格式实际上很漂亮(可读性)，或者是复制/粘贴能力。这是我的代码：import sysmydict:
command: "my_shell_scri
浏览 1提问于2020-03-06得票数 1
回答已采纳
1回答
我在一个文件中有一个YAML文档，我需要用一些结构化的信息来更新它，这是我从一个库获得的。转储此信息中的密钥的顺序非常重要。YAML文件(input.yaml)如下所示：---- element 2
path = Path('input.<em
浏览 0提问于2018-08-21得票数 2
回答已采纳
下面有用于将YAML文档生成(转储)到文件的python代码。import yamldevice_name = "NN41_R11"port = "2022" data', 'w') as outfile:生成以下<
浏览 3提问于2018-02-21得票数 1
回答已采纳
1回答
我是python和YAML的新手，我需要保存这个文件，并附上相关数据。settings': {}}
outfile.write( yaml.dump
浏览 0提问于2016-05-27得票数 1
回答已采纳
3回答
PyYAML转储格式
、、、、
我使用读取(.load())一个.yml文件，修改或添加一个密钥，然后再次写入(.dump())。问题是，我想保持文件格式后转储，但它改变了。Python: self.dict = yaml.load(yaml_file)
然后= False, allow_unicode = True, encoding = No
浏览 4提问于2013-12-27得票数 54
3回答
我使用python在Yaml中插入一个键，但我想在yaml中保留顺序和注释 ParentTest:test: name: testjob现在我正在使用下面的代码插入新的键
params['ParentTest']['test']['new_key
浏览 2提问于2017-11-19得票数 10
回答已采纳
2回答
我试图使用ruamel.yaml解析yaml文件的注释。问题是，我想以某种特定的方式(我认为这是逻辑的)来解析注释。我有以下yaml文件：# comment for the foo variablebar: ['item1', 'item2']from ruamel.<
浏览 5提问于2021-11-12得票数 1
回答已采纳
我有一个yaml文件，其中包含几个yaml块。这个文件可以看到。import ruamel.yaml
yaml_path = 'app.yaml</e
浏览 2提问于2018-06-18得票数 2
回答已采纳
2回答
鲁亚姆:可以定义线宽吗？
、、、
当使用ruyaml转储文件时，可以设置YAML线宽吗？from ruyaml import YAML as RUYAML
from ruamel.yaml import YA
浏览 17提问于2022-02-21得票数 2
回答已采纳
我写的yaml文件是这样的 yaml.safe_dump({'allow':'', 'deny': ''}, f,
浏览 0提问于2015-05-09得票数 21
这是我第一个使用app engine的项目。我已经创建了包含所需文件的应用程序。但是，当我尝试在cloud sdk cmd (和其他cmd程序)中启动服务器时，它返回一个与方法解析顺序(MRO)相关的错误。我尝试从包含gcloud skd的文件夹(同时提供应用程序forlder)和应用程序文件夹(c:\path-to-app> dev_appserver.py )运行dev_appserver.py。google-cloud-sdk\lib\third_party\ruamel\<
浏览 0提问于2019-05-12得票数 1
我使用的是ruamel.yaml (0.15.37)，其数据结构如下： Name: my message - !Variable Length: 8 Unit: % # ruamelparser erro
如果我读了YAML-文件，就会得到错误。文件"_<em
浏览 0提问于2018-03-28得票数 1
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频活动推荐
腾讯云开发者
