Question

我们有在YAML中存储设置的项目（设置文件由ansible脚本生成）。现在我们使用pyyaml来解析YAML格式和marshmallow来验证设置。我很高兴在YAML中存储设置，但我不认为marshmellow是我需要的工具（模式很难阅读，我不需要序列化设置，想要像xsd这样的东西）。那么在项目中验证设置的最佳实践是什么，也许有语言无关的方式？（我们使用的是python 2.7）

YAML设置：

successive:
  worker:
    cds_process_number: 0 # positive integer or zero
    spider_interval: 10 # positive integer
    run_worker_sh: /home/lmakeev/CDS/releases/master/scripts/run_worker.sh # OS path
    allow:
      - "*" # regular expression
    deny:
      - "^[A-Z]{3}_.+$" # regular expression

Answer 1

架构描述是一种自己的语言，有自己的语法和特性，你必须学习。如果您的要求发生变化，您必须维护其“YAML”的“程序”。

如果您已经在使用YAML并熟悉Python，则可以使用YAML的标记工具在分析时检查对象。

假设您有一个文件input.yaml：

successive:
  worker:
    cds_process_number: !nonneg 0
    spider_interval: !pos 10
    run_worker_sh: !path /home/lmakeev/CDS/releases/master/scripts/run_worker.sh
    allow:
      - !regex "*"
    deny:
      - !regex "^[A-Z]{3}_.+$"

（删除了注释和插入标签的示例文件），您可以创建并注册四个使用以下程序检查值的类¹：

import sys
import os
import re
import ruamel.yaml
import pathlib

class NonNeg:
    yaml_tag = u"!nonneg"

    @classmethod
    def from_yaml(cls, constructor, node):
        val = int(node.value)   # this creates/returns an int
        assert val >= 0
        return val

class Pos(int):
    yaml_tag = u"!pos"

    @classmethod
    def from_yaml(cls, constructor, node):
        val = cls(node.value)  # this creates/return a Pos()
        assert val > 0
        return val

class Path:
    yaml_tag = u"!path"

    @classmethod
    def from_yaml(cls, constructor, node):
        val = pathlib.Path(node.value)
        assert os.path.exists(val)
        return val


class Regex:
    yaml_tag = u"!regex"
    def __init__(self, val, comp):
        # store original string and compile() of that string
        self._val = val
        self._compiled = comp

    @classmethod
    def from_yaml(cls, constructor, node):
        val = str(node.value)
        try:
            comp = re.compile(val)
        except Exception as e:
            comp = None
            print("Incorrect regex", node.start_mark)
            print("  ", node.tag, node.value)
        return cls(val, comp)


yaml = ruamel.yaml.YAML(typ="safe")
yaml.register_class(NonNeg)
yaml.register_class(Pos)
yaml.register_class(Path)
yaml.register_class(Regex)

data = yaml.load(pathlib.Path('input.yaml'))

单个from_yaml类方法中的实际检查应该根据您的需要进行调整（我必须删除Path的断言，因为我没有该文件）。

如果你运行上面的内容，你会注意到它打印：

Incorrect regex   in "input.yaml", line 7, column 9
   !regex *

因为"*"不是有效的正则表达式。你的意思是：".*"？

¹_{这是使用ruamel.yaml完成的，这是一个YAML 1.2解析器，我是作者。您可以使用PyYAML获得相同的结果，例如通过子类化ObjectDict（默认情况下这是不安全的，所以请确保在代码中更正）}

解析和验证YAML配置文件的最佳方法

1 个答案: