在 Python 中解析带有重复锚点的 YAML

Question

我刚刚开始使用 YAML 和 Python，我正在尝试在 Python 中解析包含锚点和别名的 YAML。
在这个 YAML 中，我覆盖了锚点以使某些节点具有不同的值。

我的 YAML 示例：

Some Colors: &some_colors
 color_primary: &color_primary "#112233FF"
 color_secondary: &color_secondary "#445566FF"

Element: &element
 color: *color_primary

Overwrite some colors: &overwrite_colors
 color_primary: &color_primary "#000000FF"

Another element: &another_element
 color: *color_primary

具有（JSON 格式）的预期结果：

{
    "Some Colors": {
        "color_primary": "#112233FF",
        "color_secondary": "#445566FF"
    },
    "Element": {
        "color": "#112233FF"
    },
    "Overwrite some colors": {
        "color_primary": "#000000FF"
    },
    "Another element": {
        "color": "#000000FF"
    }
}

我测试了上面的 YAML sn-p here

根据我在 YAML 文档中阅读的内容；这应该从 1.1 版开始（我认为），但至少 YAML 1.2 版应该支持它。

但每当我尝试使用 PyYAML（使用 yaml.load()）或 ruamel,yaml 包（使用 ruamel.yaml.load()）解析 YAML 时，我都会收到“重复锚点”错误。

我在这里做错了什么？以及如何解决这个问题？

编辑：

在ruamel 的所有者的帮助下，我找到了上述问题的解决方案。

从ruamel v0.12.3 开始，上述工作按预期工作，尽管您将收到ReusedAnchorWarnings。
可以使用以下 sn-p 抑制这些警告：

import warnings
from ruamel.yaml.error import ReusedAnchorWarning

warnings.simplefilter("ignore", ReusedAnchorWarning)

在到期时给予学分；他们都去ruamel的所有者。

---

作为附加问题；当我将上述 YAML 修改为 时（注意 // <-- Added this 处的更改）：

Some Colors: &some_colors
 color_primary: &color_primary "#112233FF"
 color_secondary: &color_secondary "#445566FF"

Element: &element
 color: *color_primary

Overwrite some colors: &overwrite_colors
 <<: *some_colors   // <-- Added this to include 'color_secondary' as well
 color_primary: &color_primary "#000000FF"

Another element: &another_element
 color: *color_primary

输出是：

{
    "Some Colors": {
        "color_primary": "#000000FF",
        "color_secondary": "#445566FF"
    },
    "Element": {
        "color": "#112233FF"
    },
    "Overwrite some colors": {
        "color_primary": "#000000FF",
        "color_secondary": "#445566FF"
    },
    "Another element": {
        "color": "#445566FF" // <-- Now the value is 'color_secondary' instead of 'color_primary'?
    }
}

为什么Another element 的color 会查看color_secondary 的值？

还有什么办法可以解决这个问题吗？

Answer 1

首先，你没有做错任何事。 PyYAML 在这里做错了。这很可能是因为转储具有相同名称的锚点将是 PyYAML 转储程序的错误情况。如果你有一个自引用的 Python 结构：

 a = dict(x=1)
 a['y'] = a

然后 PyYAML（和ruamel.yaml）将为您创建一个唯一的锚名称。如果此名称不是唯一的，则取决于该名称用作别名的位置。因此，怀疑任何重用的锚名称是有意义的，因为这可能指向 YAML 序列化代码中的错误，但这并不违反规范（根据YAML 1.0 规范（第 3.2.2.2 节），重用已经可以了)。

python-yaml Debian 模块的 bug report 自 2009 年以来就存在，但我还没有发现它是否最终出现在上游。

正如您所说，这已在 ruamel.yaml 0.12.3 中解决

---

要回答您的第二个问题，那只是因为“Best Online YAML Converter”不是，并且解析错误。如果合并行上有 YAML 注释，它甚至会抛出错误：

 <<: *some_colors   # <-- Added this to include 'color_secondary' as well

这在 ruamel.yaml (0.12.3) 中按预期解析：

import sys
import ruamel.yaml
import warnings
from ruamel.yaml.error import ReusedAnchorWarning
warnings.simplefilter("ignore", ReusedAnchorWarning)

yaml_str = """\
Some Colors: &some_colors
 color_primary: &color_primary "#112233FF"
 color_secondary: &color_secondary "#445566FF"

Element: &element
 color: *color_primary

Overwrite some colors: &overwrite_colors
 <<: *some_colors   # <-- Added this to include 'color_secondary' as well
 color_primary: &color_primary "#000000FF"

Another element: &another_element
 color: *color_primary
"""


data = ruamel.yaml.safe_load(yaml_str)
ruamel.yaml.round_trip_dump(data, sys.stdout)

给予：

Some Colors:
  color_primary: '#112233FF'
  color_secondary: '#445566FF'
Overwrite some colors:
  color_primary: '#000000FF'
  color_secondary: '#445566FF'
Another element:
  color: '#000000FF'    # <- not #445566FF
Element:
  color: '#112233FF'

（手动添加的评论）

如果您想使用新的 API 和安全加载器，请确保指定 pure=True，否则将使用 ruamel.yaml 的 libyaml 副本（仍然存在此错误），您将获得ComposerError:

yaml = ruamel.yaml.YAML(typ='safe')
data = yaml.load(yaml_str)
yaml.dump(data, sys.stdout)

Answer 2

仅供参考：上面的示例代码丢失pure=True

yaml = ruamel.yaml.YAML(typ='safe', pure=True)
data = yaml.load(yaml_str)
yaml.dump(data, sys.stdout)