通过 PyYAML 创建带有别名的 yaml 文件

Question

我需要创建一个如下格式的yaml文件：

imager: &imager
  type: "detector"
  half_angle: 75 degrees
  max_distance: 23000 meters
ownship: &ownship
  origin: [11,11,5]
  type: "uav"

vehicles:
  - <<: *ownship
  name: "uav1"
  origin: [35.69257148103399 degrees, -117.689417544709 degrees, 5500]
  sensors:
    - <<: *imager
      name: "imager1"

我将所有特定数据都存储在 Python 类中，所以我想我会使用 PyYAML 让事情变得简单。然而，当我去阅读文档时，我没有看到如何使用 PyYAML 处理别名。这个功能是否存在，还是我应该继续制作自己的 yaml 编写器？

Answer 1

首先，您指定的文件不是正确的 YAML。它不会读入，因为这里：

- <<: *ownship
name: "uav1"

您将顺序元素和映射元素并置，这是不允许的。如果您从第一行中删除 -，您将获得正确的 YAML 文件：

imager: &imager
  type: "detector"
  half_angle: 75 degrees
  max_distance: 23000 meters
ownship: &ownship
  origin: [11,11,5]
  type: "uav"

vehicles:
  - <<: *ownship
  name: "uav1"
  origin: [35.69257148103399 degrees, -117.689417544709 degrees, 5500]
  sensors:
    - <<: *imager
      name: "imager1"

您无法使用 PyYAML 生成。

PyYAML 确实支持用于读写的锚点和引用。它确实支持merge key operator<< 进行阅读。但不支持合并操作符的写法。

这需要比较不同的字典，确定是否有任何字典是另一个字典的完整子集（一个字典的所有键和值都在另一个字典中），然后在子集上制作一个锚点，并在编写其他字典（而不是在子集中写键）。 PyYAML 中没有这样的代码可以这样做，因为它比在 PyYAML 支持的共享复杂对象（dict、list 等）上使用锚点和引用要复杂得多。

我的ruamel.yaml 具有 PyYAML 功能的超集，从 0.10 版本开始支持此类数据的往返。它在第一次往返时做了一些“标准化”：

imager: &imager
  type: detector
  half_angle: 75 degrees
  max_distance: 23000 meters
ownship: &ownship
  origin: [11, 11, 5]
  type: uav
vehicles:
  <<: *ownship
  name: uav1
  origin: [35.69257148103399 degrees, -117.689417544709 degrees, 5500]
  sensors:
  - <<: *imager
    name: imager1

很容易读入该 YAML 并操作生成的数据结构，然后将其写出。键的分配在您引用的字典上完成，如果在引用的字典中不可用，则从第一个合并的字典中透明地检索值。

从头开始创建这样一个结构然后转储它更加困难，因为没有支持例程通过比较字典之间的键/值来创建合并（目前）。

Answer 2

如果你的 python 数据结构包含对同一个对象的多个引用，看起来 PyYAML 做的事情是正确的。例如，考虑一下：

>>> a = {'name': 'bob', 'office': '100'}
>>> b = {'president': a, 'vice-president': a}
>>> b
{'president': {'name': 'bob', 'office': '100'}, 'vice-president': {'name': 'bob', 'office': '100'}}
>>> import yaml
>>> print yaml.dump(b)
president: &id001 {name: bob, office: '100'}
vice-president: *id001

PyYAML 已识别出 'president' 和 'vice-president' 键的值是对同一对象的引用，并创建了一个别名并适当地使用它。