如何验证Jinja2模板渲染所需的所有变量是否已填充？

问题背景 #

渲染大型Jinja2模板时，即便模板中定义的变量未被传入，Jinja2也会直接忽略占位符继续渲染，导致输出内容缺失。常规方法只能提取顶层变量，无法识别深层嵌套的对象属性，需要一套能完整校验输入数据是否包含模板所需所有变量的方案。

示例场景 #

基础示例：

from jinja2 import Template
template_to_render = 'this is a text with a var: {{ var }}'
rendered_template = Template(template_to_render).render({'not_existing_var': 'some_value'})
print(rendered_template)

输出：

this is a text with a var:

此处var未传入，Jinja2直接移除了变量占位符。

复杂嵌套示例：

template_to_render = '''
this is a text with a var: {{ var }}
{% for some_nested_test_value in data.nested_test_value %}
{{ some_nested_test_value }}
{% endfor %}
'''
template_vars = {'var': 'some_value', 'data': {'this_is_invalid': ['a', 'b']}}

此处data.nested_test_value未在输入数据中定义，但Jinja2不会报错，仅跳过循环内容。

解决方案：通过AST遍历提取变量路径并校验 #

利用Jinja2的抽象语法树（AST），可以遍历模板中所有变量引用（包括嵌套属性），再递归检查输入数据是否包含这些路径。

完整代码实现 #

from jinja2 import Environment
from jinja2.nodes import Name, Getattr

def extract_variable_paths(node, current_path=None):
    """递归遍历AST节点，提取所有变量的完整路径"""
    paths = set()
    if current_path is None:
        current_path = []
    
    # 处理顶层变量节点（如{{ var }}中的var）
    if isinstance(node, Name):
        paths.add('.'.join(current_path + [node.name]))
    # 处理嵌套属性节点（如data.nested_test_value中的nested_test_value）
    elif isinstance(node, Getattr):
        parent_paths = extract_variable_paths(node.node, current_path)
        for parent_path in parent_paths:
            full_path = f"{parent_path}.{node.attr}"
            paths.add(full_path)
    # 处理包含子节点的复合节点（循环、条件判断等）
    elif hasattr(node, 'nodes'):
        for sub_node in node.nodes:
            paths.update(extract_variable_paths(sub_node, current_path))
    # 处理其他含变量的节点类型
    elif hasattr(node, 'node'):
        paths.update(extract_variable_paths(node.node, current_path))
    elif hasattr(node, 'target'):
        paths.update(extract_variable_paths(node.target, current_path))
    elif hasattr(node, 'iter'):
        paths.update(extract_variable_paths(node.iter, current_path))
    
    return paths

def check_variable_exists(data, path):
    """检查数据字典中是否存在指定路径的变量"""
    parts = path.split('.')
    current = data
    for part in parts:
        if isinstance(current, dict) and part in current:
            current = current[part]
        else:
            return False
    return True

def validate_template_vars(template_source, data):
    """验证输入数据是否包含模板所需的所有变量"""
    env = Environment()
    ast = env.parse(template_source)
    var_paths = extract_variable_paths(ast)
    
    missing_vars = []
    for path in var_paths:
        if not check_variable_exists(data, path):
            missing_vars.append(path)
    
    return missing_vars

# 测试复杂示例
if __name__ == "__main__":
    template_to_render = '''
this is a text with a var: {{ var }}
{% for some_nested_test_value in data.nested_test_value %}
{{ some_nested_test_value }}
{% endfor %}
'''
    template_vars = {'var': 'some_value', 'data': {'this_is_invalid': ['a', 'b']}}
    
    missing = validate_template_vars(template_to_render, template_vars)
    if missing:
        print(f"缺失以下变量：{', '.join(missing)}")
    else:
        print("所有变量均已填充")

代码说明 #

• extract_variable_paths：递归遍历AST，识别变量名和属性访问节点，拼接成如data.nested_test_value的完整路径字符串。
• check_variable_exists：根据路径字符串，逐层检查数据字典中是否存在对应的键。
• validate_template_vars：整合上述两个函数，返回所有缺失的变量路径。

运行测试代码会输出：缺失以下变量：data.nested_test_value，符合预期。

内容的提问来源于stack exchange，提问作者Hesoyam