◾️はじめに

Jinja2の繰り返し(ループ)についてメモ。

【１】for文

サンプル

{% for name in name_vals: %}
  <p>Hello, {{ name + " from USA" }}!!!</p>
{% endfor %}

【２】ループの制御文

* if文と組み合わせて使える

１）break文

{% for item in items %}
  {% if item == 'TheEnd' %}
    {% break %} {# ! 注目 ! #}
  {% endif %}
  <li>{{ item }}</li>
{% endfor %}

２）continue文

{% for item in items %}
  {% if item == 'TheSkip' %}
    {% continue %} {# ! 注目 ! #}
  {% endif %}
  <li>{{ item }}</li>
{% endfor %}

【３】loop

* ループを制御するために用意されている loop が便利。

https://techblog.recochoku.jp/3422

１）主なメソッド

* 以下の公式ドキュメントに全てのメソッドが載っている

https://jinja.palletsprojects.com/en/3.0.x/templates/#for

Express	Explanations
loop.index	ループのインデックスを返す
loop.first	最初のループの場合 True, それ以外は False
loop.last	最後のループの場合 True, それ以外は False
loop.length	ループの回数を返す

２）サンプル

{# ループの最後は「,」は要らないので、それを制御する #}
CREATE TABLE demo_table
{% for column in columns %}
{{ column  }} TEXT{% "," if not loop.last else "" %} {# ! 注目 ! #}
{% endfor %}

【４】使用上の注意：変数をループする場合の注意点

* 変数が文字列もしくは１要素のタプルの場合、文字列として扱い
　1文字づつループされてしまう
 => タプルじゃなく、リストならOK

１）NG例

* 今回の例は、以下のようにするのだが、「出力結果(NG) 」をみて分かる通り
　1文字づつループされてしまう(「table_names=['table1']」ならOK)

 + 1要素であれば、SELECT文のみ
 + 複数要素であれば、SELECT文＋UNION ALLで繋ぐ

demo.py

from jinja2 import Environment, FileSystemLoader

env = Environment(loader=FileSystemLoader('./', encoding='utf8')) 
template = env.get_template('./templates/sql.j2')
result = template.render(
  #table_names = 'table1' # NG
  #table_names = ['table1'] # OK
  table_names = ('table1') # NG
  #table_names = ['table1', 'table2', 'table3'] # OK
  #table_names = ('table1', 'table2', 'table3') # OK
)
print(result)

./templates/sql.j2

{%- for table in table_names %}
  SELECT COUNT(*) FROM {{ table }}
  {%- if not loop.last %}
    UNION ALL
  {%- endif %}
{%- endfor %}

出力結果(NG)

  SELECT COUNT(*) FROM t
    UNION ALL
  SELECT COUNT(*) FROM a
    UNION ALL
  SELECT COUNT(*) FROM b
    UNION ALL
  SELECT COUNT(*) FROM l
    UNION ALL
  SELECT COUNT(*) FROM e
    UNION ALL
  SELECT COUNT(*) FROM 1

２）OK例

* 変数の型チェックして対応する

./templates/sql.j2

{%- if table_names is iterable and table_names is not string and table_names is not mapping %}
  {%- for table in table_names %}
    SELECT COUNT(*) FROM {{ table }}
    {%- if not loop.last %}
      UNION ALL
    {%- endif %}
  {%- endfor %}
{%- else %}
  SELECT COUNT(*) FROM {{ tabel_names }}
{%- endif %}