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

Question

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

目前，无论 YAML 库（pyyaml、oyaml、 或ruamel）如何，我都遇到了一个问题，调用.dump(MyObject)给了我正确的 YAML，但似乎添加了很多关于我不想要的 Python 对象的元数据，形式如下：

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

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

上的其他问题表明，这个共同的解决方案是使用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（您的标签可能因类的定义位置而异，等等）并且类的每个属性都被转储为映射的键。

有多种方法可以消除该转储中的标记：

注册课程

为每个类添加一个classmethod命名的to_yaml(), 并注册这些类。您必须为每个类都这样做，但这样做可以让您使用安全转储程序。可以在文档中找到有关如何执行此操作的示例

后期过程

对输出进行后处理并删除标记相当容易，对于对象来说，标记总是出现在映射之前的行上，您可以删除!!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]

由于 achors 在标记之前被转储，因此这种“从!!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 类的所有实例，无需额外工作。