我可以在yaml / pyyaml中转储空白而不是null吗？

Question

使用PyYAML，如果我在dict中读入包含空值的文件：

test_str = '''
attrs:
  first:
  second: value2
'''

这将返回密钥None的first：

>>> data = yaml.load(test_str)
>>> data
{'attrs': {'second': 'value2', 'first': None}}

但在写作时，None值被null取代：

>>> print(yaml.dump(data, default_flow_style=False))
attrs:
  first: null
  second: value2

有没有办法格式化转储输出以打印空白标量而不是null？

Answer 1

基于@ Anthon的excellent answer，我能够制作出这个解决方案：

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

yaml.add_representer(type(None), represent_none)

根据我对PyYAML code的理解，为现有类型添加一个代表应该只是替换现有的代表。

这是一个全局更改，这意味着所有后续转储都使用空白。如果程序中某些不相关的其他代码依赖于None以“正常”方式表示，例如您导入的库以及使用PyYAML的库，该库将不再以正确的方式正确工作，在这种情况下，子类化是正确的方法。

Answer 2

你得到null因为dump()使用Representer()子类SafeRepresenter()并代表None，所以调用以下方法：

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

由于字符串null是硬编码的，因此没有选择让dump()改变它。

在PyYAML中解决这个问题的正确方法是制作你自己的Dumper子类，它有来自Emitter使用的标准Serializer的Resolver，Dumper和dump()，但是Representer的子类以你想要的方式代表None：

import sys
import yaml

from yaml.representer import Representer
from yaml.dumper import Dumper
from yaml.emitter import Emitter
from yaml.serializer import Serializer
from yaml.resolver import Resolver


yaml_str = """\
attrs:
  first:
  second: value2
"""

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

class MyDumper(Emitter, Serializer, MyRepresenter, Resolver):
    def __init__(self, stream,
            default_style=None, default_flow_style=None,
            canonical=None, indent=None, width=None,
            allow_unicode=None, line_break=None,
            encoding=None, explicit_start=None, explicit_end=None,
            version=None, tags=None):
        Emitter.__init__(self, stream, canonical=canonical,
                indent=indent, width=width,
                allow_unicode=allow_unicode, line_break=line_break)
        Serializer.__init__(self, encoding=encoding,
                explicit_start=explicit_start, explicit_end=explicit_end,
                version=version, tags=tags)
        MyRepresenter.__init__(self, default_style=default_style,
                default_flow_style=default_flow_style)
        Resolver.__init__(self)

MyRepresenter.add_representer(type(None),
                              MyRepresenter.represent_none)

data = yaml.load(yaml_str)
yaml.dump(data, stream=sys.stdout, Dumper=MyDumper, default_flow_style=False)

给你：

attrs:
  first:
  second: value2

如果这听起来像是为了摆脱null的大量开销，那就是。您可以使用一些快捷方式，甚至可以尝试将备用函数移植到现有的Representer上，但由于实际函数在查找表中引用（由add_representer填充），因此您至少需要处理该引用。

更简单的解决方案是用ruamel.yaml替换PyYAML并使用其round_trip功能（免责声明：我是该软件包的作者）：

import ruamel.yaml

yaml_str = """\
# trying to round-trip preserve empty scalar
attrs:
  first:
  second: value2
"""

data = ruamel.yaml.round_trip_load(yaml_str)
assert ruamel.yaml.round_trip_dump(data) == yaml_str

除了将None作为空标量发出外，它还保留了映射键，注释和标记名称的顺序，PyYAML没有。 ruamel.yaml也遵循YAML 1.2规范（从2009年开始），其中PyYAML使用较旧的YAML 1.1。

---

ruamel.yaml软件包可以安装来自PyPI的pip，或者使用现代的基于Debian的发行版，也可以使用apt-get python-ruamel.yaml

Answer 3

只需使用字符串替换

print(yaml.dump(data).replace("null", ""))