ruamel.yaml - 如何在 default_flow_style=None 时使用 output null 而不是 !!null ''

Question

在 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时 output 对于 null 仍然是!!null ''当使用default_flow_style=None时。

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

Answer 1

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

最简单的解决方案是使用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}

Answer 2

往返转储器尝试将None转储为空字符串，这将无法正确解析（然后在流式序列的末尾与带有尾随逗号的序列无法区分）。

标记的 output 是发射器检测到的结果，无法解析回来，但它很丑，这在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 语言无关类型值之一（ 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: ~}