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

Posted 2023-02-26

【中文标题】YAML - 转储没有类型/标签的嵌套对象

【英文标题】：YAML - Dumping a nested object without types/tags

【发布时间】：2019-09-13 13:03:53

【问题描述】：

我正在尝试将一些 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)

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

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

【参考方案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（您的标签可能会有所不同，具体取决于 类被定义等）并且类的每个属性都被转储为映射的键。

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

注册课程

添加一个名为 to_yaml() 的 classmethod 到您的每个类和 注册这些课程。你必须为你的每个班级都这样做， 但这样做可以让您使用安全翻斗车。一个例子说明如何 可以在 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]

由于 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 类的所有实例，无需额外工作。

【讨论】：

感谢您提供详细的演练以及每个选项的示例。 :)

不客气。只是出于好奇：您打算使用哪种解决方案？

写成dictitems: a: 4 state: filename: test.yaml可以忽略写dictitems 和state

@alper 请发布一个问题并将其标记为 ruamel.yaml，然后您可以正确描述您现在获得的内容（带有格式）以及您想要获得的内容。确保您想要的输出是有效的 YAML，因为 a: 4 filename: test.yaml 不是，即使它位于两行时也是如此。

您在该链接上的回答也不起作用，它给出：ruamel.yaml.representer.RepresenterError: cannot represent an object: 'a': 3:***.com/questions/68678764/…。如果我能让它发挥作用，我相信我可以在这里将它与您的答案结合起来。

【参考方案2】：

又快又笨：

"\n".join([re.sub(r" ?!!python/.*$", "", l) for l in yaml.dump(obj).splitlines()]

"\n".join(...) - 将列表连接到字符串 agin yaml.dump(obj).splitlines() – 创建 yaml 行列表 re.sub(r" ?!!python/.*$", "", l) – 用空字符串替换所有 yaml python 标签