python - YAML - 转储没有类型/标签的嵌套对象

Question

我正在尝试将一些 Python 对象转储到 YAML 中。

目前，无论是 YAML 库(pyyaml、oyaml 还是 ruamel)，我在调用 时都遇到了问题。 dump(MyObject) 给了我正确的 YAML，但似乎添加了很多关于我不想要的 Python 对象的元数据，其形式如下所示:

!!python/object:MyObject 和其他类似的字符串。

我不需要能够从 YAML 重建对象，所以我可以完全删除此元数据

关于 SO 的其他问题表明，对此的常见解决方案是使用 safe_dump 而不是 dump。

但是，safe_dump 似乎不适用于嵌套对象(或根本对象)，因为它会抛出此错误:

yaml.representer.RepresenterError: ('cannot represent an object', MyObject)

我看到这里常见的解决方法是为我试图转储的对象手动指定 Representers。我的问题是我的对象是我无法控制的生成代码。我还将倾倒各种不同的物体。

底线:有没有办法使用 .dump 转储嵌套对象，但没有添加元数据？

Answer 1

尽管“正确的 YAML”这个词并不准确，最好表述为“YAML 输出看起来像你想要的，除了标签信息”，这幸运地给出了一些有关您希望 YAML 外观的信息，因为有无数种方法可以转储对象。

如果使用 ruamel.yaml 转储对象:

import sys
import ruamel.yaml

class MyObject:
   def __init__(self, a, b):
      self.a = a
      self.b = b
      self.c = [a, b]

data = dict(x=MyObject(42, -1))


yaml = ruamel.yaml.YAML(typ='unsafe')
yaml.dump(data, sys.stdout)

这给出:

x: !!python/object:__main__.MyObject
  a: 42
  b: -1
  c: [42, -1]

你有一个标签 !!python/object:__main__.MyObject类被定义等)并且类的每个属性都被转储为映射的键。

有多种方法可以去除该转储中的标签:

注册类(class)

添加一个名为 to_yaml() 的 classmethod 到您的每个类中，并且注册这些类(class)。你必须为你的每个类(class)做这个，但这样做可以让你使用安全翻车机。一个关于如何做的例子这样做可以在 documentation

后处理

对输出进行后处理并删除标签相当容易，对于对象来说，标签总是出现在线上在映射之前，您可以从 !!python 删除直到行尾

def strip_python_tags(s):
    result = []
    for line in s.splitlines():
        idx = line.find("!!python/")
        if idx > -1:
            line = line[:idx]
        result.append(line)
    return '\n'.join(result)

yaml.encoding = None
yaml.dump(data, sys.stdout, transform=strip_python_tags)

这给出了:

x: 
  a: 42
  b: -1
  c: [42, -1]

由于在标签之前转储 anchor ，因此“从 !!python 中剥离”直到行尾”，也适用于转储具有多个引用。

更换自卸车

您还可以将映射的不安全转储例程更改为识别用于对象的标签并将标签更改为“正常”一个用于字典/映射(通常不输出标签)

yaml.representer.org_represent_mapping = yaml.representer.represent_mapping

def my_represent_mapping(tag, mapping, flow_style=None):
    if tag.startswith("tag:yaml.org,2002:python/object"):
        tag = u'tag:yaml.org,2002:map'
    return yaml.representer.org_represent_mapping(tag, mapping, flow_style=flow_style)

yaml.representer.represent_mapping = my_represent_mapping

yaml.dump(data, sys.stdout)

这再次给出:

x:
  a: 42
  b: -1
  c: [42, -1]

这最后两种方法适用于您定义的所有 Python 类的所有实例，无需额外工作。