Jinja2 宏中意外换行的解决方案-图灵python

Jinja2 宏内的换行符即使启用，也会导致模板渲染时多余的空行 trim_blocks 和 lstrip_blocks 也无效；正确的做法是在宏定义内使用； {%- -%} 等待空白控制语法，而不是在调用处添加连字符。

jinja2 宏内的换行符即使启用，也会导致模板渲染时多余的空行 `trim_blocks` 和 `lstrip_blocks` 也无效；正确的做法是在宏定义内使用； `{%- -%}` 等待空白控制语法，而不是在调用处添加连字符。

在 Jinja2 中，宏（macro）本质上是一个独立的模板片段，其内部替换和空白不受外部模板配置的影响(如 trim_blocks=True 或 lstrip_blocks=True）影响。这意味着，即使你已经完全使用了空白修剪，宏体中的换行符仍然会输出到渲染结果中的空行——这是问题 Bob、Jason、James 之后多出行的根本原因。

解决方案是在宏定义内显式控制空白 Jinja2 空白控制语法：

{%- ... %}：去除左侧空白(包括前导换行和空白)
%-}：去除右侧空白(包括后续换行)
{%- ... -%}：同时，去除左右两侧的空白

因此，原始宏应该是：

{% macro print_name(data)%}
{{ data }}
{% endmacro %}

改为：

{% macro print_name(data) %}
{{- data -}}
{% endmacro %}

注意：{{- data -}} 中的 - 分别靠近花括号，表示移除 data 渲染前后的所有空白(包括换行)。同时，还建议使用宏开始和结束标签。 - 优化（如 {%- macro ... -%} 和 {%- endmacro -%}），但本例中仅 {{- data -}} 多余的换行已经足够消除了。

模板完整修正后如下：

{% macro print_name(data) %}
{{- data -}}
{% endmacro %}
People {
{% for name in names %}
    Name {
        {{ print_name(name) }}
    }
{% endfor %}
}

✅ 渲染结果将严格符合预期：

People {
    Name {
        Bob
    }
    Name {
        Jason
    }
    Name {
        James
    }
}

⚠️ 注意事项：

避免在调用处添加 -（如 {{ print_name(name) -}}）：这将删除宏输出后的换行，导致后续 } 顶格缩进，破坏结构；
trim_blocks=True 仅作用于 {% ... %} 块的外层换行(如 {% for %} 之后的换行)，不穿透宏作用域；
如果宏包含多行逻辑(如条件判断和嵌套循环)，建议对每个逻辑进行处理 {{ }} 和 {% %} 统一应用标签 - 控制，保持可预测的空白行为；
可临时启用调试 env = Environment(..., autoescape=False, undefined=jinja2.DebugUndefined) 快速定位空白源。

掌握宏内空白控制是一个强大的、可维护的编写 Jinja2 模板(特别是生成 YAML/JSON/Terraform/HCL 关键实践，如格式敏感配置)。