ruamel.yaml - 如何在 default_flow_style=None 时输出 null 而不是 !!null ''

ruamel.yaml - how to output null instead of !!null '' when default_flow_style=None

在 Python 中使用 ruamel.yaml,如果我使用 SafeRepresenter 或 RoundTripRepresenter 和 default_flow_style 默认转储,null 将按预期表示。

import sys
from ruamel.yaml import YAML
yaml = YAML(typ='rt')
yaml.dump({'key1': None, 'url': 'https://lala/', 'key2': None}, sys.stdout)

key1:
url: https://lala/
key2:

但是,如果我将 default_flow_style 更改为 None,null 的表示符似乎被忽略,而是 null 表示为 !!null '' 例如

import sys
from ruamel.yaml import YAML
yaml = YAML(typ='rt')
yaml.default_flow_style = None
yaml.dump({'key1': None, 'url': 'https://lala/', 'key2': None}, sys.stdout)


key: {key1: !!null '', url: https://lala/, key2: !!null ''}

显式设置 null 的表示没有区别,例如

SafeRepresenter.add_representer(type(None), RoundTripRepresenter.represent_none)

我尝试了上面的方法,但是当使用 SafeRepresenter 而不是 RoundTripRepresenter 时, null 的输出在使用 default_flow_style=None.

时仍然是 !!null ''

直接从 ruamel.yaml 使用 default_flow_style=None 而不是对其输出进行后处理(例如查找替换)时,如何输出 null 而不是 !!null ''

我看到两个可能的解决方案。

最简单的解决方案是使用 typ='safe' 而不是 typ='rt'。这是我通常做的事情,但如果您依赖 ruamel.yaml 保留评论等内容的能力,那么这不是一个选择。

您可以像这样为 None 个值创建表示:

def represent_none(self, data):
    return self.represent_scalar('tag:yaml.org,2002:null', 'null')

这将根据需要打印出您的 None 值:

>>> import sys
>>> from ruamel.yaml import YAML
>>> yaml = YAML(typ='rt')
>>> yaml.default_flow_style = None
>>>
>>> def represent_none(self, data):
...     return self.represent_scalar('tag:yaml.org,2002:null', 'null')
...
>>> yaml.representer.add_representer(type(None), represent_none)
>>> yaml.dump({'key1': None, 'url': 'https://lala/', 'key2': None}, sys.stdout)
{key1: null, url: https://lala/, key2: null}

往返转储程序尝试将 None 转储为空字符串,这不会 正确解析回(然后在流式序列结束时将是 与尾随逗号的序列无法区分)。

标记的输出是发射器检测到的结果,无法解析回来,但它很丑而且这个 在 ruamel.yaml 0.16.13 中修复,通过发出 null 而不是 !!null '',这不会影响块样式 发出 None:

import sys
from ruamel.yaml import YAML
yaml = YAML(typ='rt')
yaml.default_flow_style = None
yaml.dump({'key1': None, 'url': 'https://lala/', 'key2': None}, sys.stdout)

给出:

{key1: null, url: https://lala/, key2: null}

您可以获得旧的行为设置 yaml.emitter.alt_null = None。你可以 将其设置为任何值,尽管选择另一个 Null 与语言无关的类型 值(NullNULL, ~) 最有意义:

import sys
import ruamel.yaml
map = ruamel.yaml.comments.CommentedMap

yaml = ruamel.yaml.YAML()
yaml.emitter.alt_null = '~'
b = map(key1=None, url='https://lala/', key2=None)
b.fa.set_flow_style()
yaml.dump(dict(a=None, b=b), sys.stdout)

给出:

a:
b: {key1: ~, url: https://lala/, key2: ~}