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

【问题标题】：ruamel.yaml - how to output null instead of !!null '' when default_flow_style=Noneruamel.yaml - default_flow_style=None 时如何输出 null 而不是 !!null ''
【发布时间】：2021-01-12 21:41:51
【问题描述】：

在 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 输出仍然是!!null '' 使用default_flow_style=None 时。

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

【问题讨论】：

您能否在问题中包含一个重现此行为的最小示例？如果我使用ruamel.yaml 转储具有None 值的字典，则无论default_flow_style 的设置如何，它都会在输出中显示为简单的null。
@larsks 我已经更新了

标签： python yaml ruamel.yaml

【解决方案1】：

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

最简单的解决方案是使用typ='safe' 而不是typ='rt'。这是我通常做的，但如果你依赖ruamel.yaml 的能力来保存像 cmets 这样的东西，这不是一个选择。

您可以像这样为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}

【讨论】：

【解决方案2】：

往返转储器尝试将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 Language-Indepenent Type 值之一（Null， NULL, ~) 最有意义：

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: ~}

【讨论】：