使用python用JSON模板验证JSON文件

Question

我正在以一种特定的格式创建一个JSON文件，所以我想在进一步处理之前验证它是否是这种格式。

{
  "dev":{
    "username": "",
    "script": "",
    "params": ""
  },
  "qat":{
    "username": "",
    "script": "",
    "params": ""
  },
}

这和预期的一样工作，但是只是想检查一下是否有更好更简单的方法来解决这个问题

代码：

def test_param_file():
    with open('../utils/param_template.json') as json_data:
        template = json.load(json_data)

    with open('/file.json') as json_data:
        param_file = json.load(json_data)

    assert _get_all_keys(param_file) == _get_all_keys(template)


def _get_all_keys(param):
    global prefix
    global keys
    keys = []

    def func(param):
        for key, value in param.iteritems():
            if type(value) == dict:
                global prefix
                prefix = key
                func(value)

            global keys
            keys.append("%s.%s" % (prefix, key))
    func(param)

    return list(set(keys))

Answer 1

既然您正在寻找一种更简单/更好的方法，我建议您使用Marshmallow来进行这种验证。这里有一个非常粗略的例子：

from marshmallow import Schema, fields

class EnviornmentSchema(Schema):
    username = fields.Str(required=True)
    scripts = fields.Str(required=True)
    params = fields.Str(required=True)

errors = EnviornmentSchema().validate(file_contents_dict)

基本上，它将您的“模板”系统替换为模式类。您也可以使用嵌套，因为您有多个环境dict。当您需要进行更高级的验证时，Marshmallow会变得非常有用。