python - 在 python 中验证 yaml 文档

Question

XML 的一个好处是能够根据 XSD 验证文档。 YAML 没有此功能，那么如何验证我打开的 YAML 文档是否符合我的应用程序预期的格式？

Answer 1

鉴于 JSON 和 YAML 非常相似，您可以使用 JSON-Schema验证 YAML 的一个相当大的子集。这是一个代码片段(您需要安装 PyYAML 和 jsonschema):

from jsonschema import validate
import yaml

schema = """
type: object
properties:
  testing:
    type: array
    items:
      enum:
        - this
        - is
        - a
        - test
"""

good_instance = """
testing: ['this', 'is', 'a', 'test']
"""

validate(yaml.load(good_instance), yaml.load(schema)) # passes

# Now let's try a bad instance...

bad_instance = """
testing: ['this', 'is', 'a', 'bad', 'test']
"""

validate(yaml.load(bad_instance), yaml.load(schema))

# Fails with:
# ValidationError: 'bad' is not one of ['this', 'is', 'a', 'test']
#
# Failed validating 'enum' in schema['properties']['testing']['items']:
#     {'enum': ['this', 'is', 'a', 'test']}
#
# On instance['testing'][3]:
#     'bad'

其中一个问题是，如果您的架构跨越多个文件并且您使用 "$ref" 来引用其他文件，那么我认为其他文件将需要是 JSON。但可能有办法解决这个问题。在我自己的项目中，我正在使用 JSON 文件指定架构，而实例是 YAML。