Voluptuous:在yaml文件中给出错误行

Question

我经常使用voluptuous来验证yaml描述文件。通常，这些错误很难破译，尤其是对于普通用户来说。

我正在寻找一种方法，使错误更加可读。一种方法是识别YAML文件中的哪一行是递增的。

from voluptuous import Schema 
import yaml 
from io import StringIO
Validate = Schema({
'name': str,
'age': int,
})
data = """
name: John
age: oops
"""
data = Validate(yaml.load(StringIO(data)))

在上面的例子中，我得到了这个错误：

MultipleInvalid: expected int for dictionary value @ data['age']

我更喜欢这样的错误：

Error: validation failed on line 2, data.age should be an integer.

有没有一种优雅的方式来实现这一点？

Answer 1

问题是在yaml.load的API边界上，源的所有表示信息都丢失了。Validate得到一个Python dict，但不知道它来自哪里，而且dict不包含此信息。

但是，您可以自己实现这一点。性感的‘Invalid错误携带一个path，它是要遵循的键列表。有了这个路径，您可以再次将YAML解析为节点(携带表示信息(，并发现项目的位置：

import yaml
def line_from(path, yaml_input):
node = yaml.compose(yaml_input)
for item in path:
for entry in node.value:
if entry[0].value == item:
node = entry[1]
break
else: raise ValueError("unknown path element: " + item)
return node.start_mark.line
# demostrating this on more complex input than yours
data = """
spam:
egg:
sausage:
spam
"""
print(line_from(["spam", "egg", "sausage"], data))
# gives 4

有了这个，你就可以进行

try:
data = Validate(yaml.load(StringIO(data)))
except Invalid as e:
line = line_from(e.path, data)
path = "data." + ".".join(e.path)
print(f"Error: validation failed on line {line} ({path}): {e.error_message}")

我会为这个答案走这么远，因为它向你展示了如何发现错误的起源线。您可能需要将其扩展到：

• 处理YAML序列(我的代码假设每个中间节点都是MappingNode，SequenceNode的value列表中将有单个节点，而不是键值元组(
• 处理MultipleInvalid为每个内部错误发出一条消息
• 如果你真的想重写expected int到should be an integer(不知道该怎么做(
• 打印错误后中止

Answer 2

在flyx的帮助下，我找到了ruamel.yaml，它提供了解析后的YAML文件的行和列。因此，一个人可以设法得到想要的错误：

from voluptuous import Schema 
from ruamel.yaml import load, RoundTripLoader
from io import StringIO
Validate = Schema({
'name': {
'firstname': str,
'lastname': str
},
'age': int,
})
data = """
name: 
firstname: John
lastname: 12.0
age: 42
"""
class Validate:
def __init__(self, stream):
self._yaml = load(stream, Loader=RoundTripLoader)
return self.validate()
def validate(self):
try:
self.data = Criteria(self._yaml)
except Invalid as e:
node = self._yaml
for key in e.path:
if (hasattr(node[key], '_yaml_line_col')):
node = node[key]
else:
break
path = '/'.join(e.path)
print(f"Error: validation failed on line {node._yaml_line_col.line}:{node._yaml_line_col.col} (/{path}): {e.error_message}")
else:
return self.data

data = Validate(StringIO(data))

有了这个，我得到了这个错误消息：

Error: validation failed on line 2:4 (/name): extra keys not allowed