Skip to main content
 首页 » 编程设计

python之使 yaml/ruamel.yaml 始终内联转储列表

2024年11月24日6itcoder

如何使 PyYAML 或 ruamel.yaml 始终内联转储列表?无论是从现有文件加载还是从我的代码添加的 YAML 元素列表。

当我从文件加载 YAML 然后转储它时,它转储内联列表(请参见下面的代码)。但是,如果我向现有父对象添加一个带有列表的新 YAML 元素,然后转储它,它转储的列表不是内联的。

我尝试使用 Python 3.7.3、PyYAML 5.1.1 和 ruamel.yaml 0.15.97。

>>> import ruamel.yaml 
>>> ruamel.yaml.__version__ 
'0.15.97' 
>>> raw_yaml = """ 
... users: 
...   user1: 
...     comment: comment1 
...     keys: ["user1 key1", "user1 key2"] 
...     groups: ["user1 group1", "user1 group2"] 
... """ 
>>> yaml = ruamel.yaml.round_trip_load(raw_yaml, preserve_quotes=True) 
>>> dump = ruamel.yaml.round_trip_dump(yaml, default_flow_style=None) 
>>> print(dump) 
users: 
  user1: 
    comment: comment1 
    keys: ["user1 key1", "user1 key2"] 
    groups: ["user1 group1", "user1 group2"] 
# So far so good, 'keys' and 'groups' are dumped inline 
>>> yaml['users']['user2'] = {} 
>>> yaml['users']['user2']['comment'] = 'comment2' 
>>> yaml['users']['user2']['keys'] = [] 
>>> yaml['users']['user2']['keys'].append('user2 key1') 
>>> yaml['users']['user2']['keys'].append('user2 key2') 
>>> yaml['users']['user2']['groups'] = [] 
>>> yaml['users']['user2']['groups'].append('user2 group1') 
>>> yaml['users']['user2']['groups'].append('user2 group2') 
>>> dump = ruamel.yaml.round_trip_dump( 
...     yaml, default_flow_style=False, default_style="'", 
...     indent=2, block_seq_indent=2) 
# desired result: 
# users: 
#   user1: 
#     comment: comment1 
#     keys: ["user1 key1", "user1 key2"] 
#     groups: ["user1 group1", "user1 group2"] 
#   user2: 
#     comment: comment2 
#     keys: ["user2 key1", "user2 key2"] 
#     groups: ["user2 group1", "user2 group2"] 
>>> print(dump) 
'users': 
    'user1': 
        'comment': 'comment1' 
        'keys': ["user1 key1", "user1 key2"] 
        'groups': ["user1 group1", "user1 group2"] 
    'user2': 
        'comment': 'comment2' 
        'keys': 
            - 'user2 key1' 
            - 'user2 key2' 
        'groups': 
            - 'user2 group1' 
            - 'user2 group2' 

见上文,当我转储刚刚加载的 YAML (users['user1']) 时,列表是内联的:

keys: ["user1 key1", "user1 key2"] 
groups: ["user1 group1", "user1 group2"] 

但是当我添加用户 ['user2'] 然后转储整个 YAML 对象时,列表不是内联的:

'keys': 
    - 'user2 key1' 
    - 'user2 key2' 
'groups': 
    - 'user2 group1' 
    - 'user2 group2' 

如果我设置“default_flow_style=True”,它会内联转储整个元素:

'user2': {'comment': 'comment2', 'keys': ['user2 key1', 'user2 key2'], 'groups': [ 'user2 group1', 'user2 group2']} 

这不是我想要的。我希望将“评论”、“键”和“组”转储到单独的行中,并内联列表:

user2: 
  comment: comment2 
  keys: ["user2 key1", "user2 key2"] 
  groups: ["user2 group1", "user2 group2"] 

对于 PyYaml,情况几乎相同。

我希望列表始终以内联方式转储(对于用户 ['user1'])。我该怎么做?

请您参考如下方法:

你所说的内联在 YAML 中被称为流式 文档。两者都有一个选项(default_flow_style) ruamel.yaml 在全局范围内拥有一切流式, 一切都是 block 式的,或者叶节点是流式的(rest block 风格)。这是 PyYAML 的旧行为。

但这不是你想要的,因为它会影响序列和 映射,而您只需要映射。

ruamel.yaml,在往返模式下,可以保存个体 流式/ block 式,因为它们出现在你的文件中,所以你可以 例如离开节点和他们的 parent 是流式的,或者所有的序列 (Python 列表)流式和所有映射(Python 字典) block 式 后者当然只在映射不“在”一个 顺序,因为您不能在流样式中使用 block 样式。

如果您从头开始或使用具有正确格式的加载 YAML, 只需确保任何添加的列表实际上是特殊的内部列表子类 ruamel.yaml 用于保留注释、样式等并设置流样式 在添加的列表上

import sys 
import ruamel.yaml 
from ruamel.yaml.scalarstring import DoubleQuotedScalarString as dq 
 
def L(*l): 
   ret = ruamel.yaml.comments.CommentedSeq(l) 
   ret.fa.set_flow_style() 
   return ret    
 
 
raw_yaml = """\ 
users: 
   user1: 
    comment: comment1 
    keys: ["user1 key1", "user1 key2"] 
    groups: ["user1 group1", "user1 group2"] 
""" 
 
yaml = ruamel.yaml.YAML() 
# yaml.indent(mapping=4, sequence=4, offset=2) 
yaml.preserve_quotes = True 
data = yaml.load(raw_yaml) 
data['users']['user2'] = {} 
data['users']['user2']['comment'] = 'comment2' 
data['users']['user2']['keys'] = L() 
data['users']['user2']['keys'].append('user2 key1') 
data['users']['user2']['keys'].append('user2 key2') 
data['users']['user2']['groups'] = L('abc', L('user2 group1', dq('user2 group2'))) 
# print(data) 
yaml.dump(data, sys.stdout) 

给出:

users: 
  user1: 
    comment: comment1 
    keys: ["user1 key1", "user1 key2"] 
    groups: ["user1 group1", "user1 group2"] 
  user2: 
    comment: comment2 
    keys: [user2 key1, user2 key2] 
    groups: [abc, [user2 group1, "user2 group2"]] 

由于您希望每个 列表都表示为流样式 序列,也可以更改所有列表的表示, 通过对 Representer 进行子类化,但上面的内容可以让您更好地控制 并允许您以流动方式准确地流动那些您想要的列表。


ruamel.yaml(和 PyYAML)使用流接口(interface),做 print(dump(data)) 而不是 dump(data, sys.stdout) 进行转储 对内存中的缓冲区完成,然后流式传输该缓冲区。这是 时间和空间效率低下,不要做。