■ はじめに

Jinja2がベースになっている dbt を使っていて
空白行が異常にできて見づらい。
また、それが原因かは不明だが、メモリエラーも発生しており
いずれにせよ、余分な空行はない方がいいので、調べてみたら、
Jinja2 には、Whitespace Control 機能ってのがあるらしいので、
メモっておく

【１】Jinja2 の Whitespace Control機能
【２】指定の仕方
【３】Whitespace Control使用有無での動作比較
　１）何も設定していない場合
　２）Whitespace Controlを使った場合
【４】「-」の使用位置での動作比較
　１）何も設定していない場合
　２）開始要素の％前に「-」を付与した場合
　３）開始要素の％後に「-」を付与した場合
　４）終了要素の％前に「-」を付与した場合
　５）終了要素の％後に「-」を付与した場合

【１】Jinja2 の Whitespace Control機能

* 無用な改行・空白を削除してくれる機能

https://jinja.palletsprojects.com/en/stable/templates/#whitespace-control

【２】指定の仕方

* テンプレートのコードの%の直前又は直後にハイフン「-」を追加

例

{% if users -%}

【３】Whitespace Control使用有無での動作比較

from jinja2 import Environment, FileSystemLoader

env = Environment(loader=FileSystemLoader('./', encoding='utf8')) 
template = env.get_template('./templates/hello.j2')

users = [
  {'name': 'Mike'},
  {'name': 'Smith'},
  {'name': 'Kevin'},
]

output_html = template.render(title='Hello world', users=users)
print(output_html)

１）何も設定していない場合

* 以下の出力例の通り、if文 や for文の部分が空白行ができる

./templates/hello.j2 (Whitespace Controlなし)

<html>
<title>{{ title }}</title>
<body>
{% if users %}
<ul>
{% for user in users %}
  <li>{{ user.name }}</li>
{% endfor %}
</ul>
{% endif %}
</body>
</html>

出力結果

<html>
<title>Hello world</title>
<body>

<ul>

  <li>Mike</li>

  <li>Smith</li>

  <li>Kevin</li>

</ul>

</body>
</html>

２）Whitespace Controlを使った場合

./templates/hello.tmpl (Whitespace Controlなし)

<html>
<title>{{ title }}</title>
<body>
{% if users -%}
<ul>
{% for user in users -%}
  <li>{{ user.name }}</li>
{% endfor -%}
</ul>
{% endif -%}
</body>
</html>

出力結果

<html>
<title>Hello world</title>
<body>
<ul>
<li>Mike</li>
<li>Smith</li>
<li>Kevin</li>
</ul>
</body>
</html>

【４】「-」の使用位置での動作比較

１）何も設定していない場合

./templates/hello.tmpl

<div id="1">
{% if something %}
  <div id="2">Hello world</div>
{% endif %}
</div>

出力結果

<div id="1">

  <div id="2">Hello world</div>

</div>

２）開始要素の％前に「-」を付与した場合

./templates/hello.tmpl

<div id="1">
{%- if something %}
  <div id="2">Hello world</div>
{% endif %}
</div>

出力結果（＜div id="1"＞の後の改行が削除）

<div id="1">
  <div id="2">Hello world</div>

</div>

３）開始要素の％後に「-」を付与した場合

./templates/hello.tmpl

<div id="1">
{% if something -%}
  <div id="2">Hello world</div>
{% endif %}
</div>

出力結果（＜div id="2"＞の前の空白が削除）

<div id="1">
<div id="2">Hello world</div>

</div>

４）終了要素の％前に「-」を付与した場合

./templates/hello.tmpl

<div id="1">
{% if something %}
  <div id="2">Hello world</div>
{%- endif %}
</div>

出力結果（＜div id="2"＞の閉じタグの後の改行が削除）

<div id="1">

  <div id="2">Hello world</div>
</div>

５）終了要素の％後に「-」を付与した場合

./templates/hello.tmpl

<div id="1">
{% if something %}
  <div id="2">Hello world</div>
{% endif -%}
</div>

出力結果（＜div id="1"＞の閉じタグの前の改行が削除）

<div id="1">

  <div id="2">Hello world</div>
</div>

参考文献

https://www.greptips.com/posts/1282/
https://qiita.com/taumu/items/d62f4b57e67430afe12e
https://lightgauge.net/language/python/8804/

ランキング参加中

プログラミング

プログラムの超個人的なメモ

Memo for Programming.

【Python】Jinja2 ～ Whitespace Control ～

■ はじめに

目次

【１】Jinja2 の Whitespace Control機能

【２】指定の仕方

【３】Whitespace Control使用有無での動作比較

１）何も設定していない場合

２）Whitespace Controlを使った場合

【４】「-」の使用位置での動作比較

１）何も設定していない場合

２）開始要素の％前に「-」を付与した場合

３）開始要素の％後に「-」を付与した場合

４）終了要素の％前に「-」を付与した場合

５）終了要素の％後に「-」を付与した場合

参考文献

関連記事