Jinja: ループ内で変数を割り当てるときの2.9回帰

現在の動作は正しくありませんが、古い動作も間違いなく正しくありません。 {% set %}タグは、外部スコープをオーバーライドすることを意図したものではありません。 場合によっては驚いた。 ここで何をすべきかわからない。

私が正しいと思う振る舞いは、 [-1:0] [-1:1] [-1:2] [-1:3] [-1:4] -1ような出力です。

この特定のケースでは、 groupbyを使用するように書き直すことで解決しました。

これはやや一般的なユースケースだと思います。ループ内の{% set found = true %}ようなものも、後でチェックします。 これが機能しなくなったとき、人々のために物事を壊す可能性が高いです...

私はこれが以前に働いたことにショックを受けました。 これは常に機能しましたか？

どうやらはい：

>>> import jinja2
>>> jinja2.__version__
'2.0'
>>> jinja2.Template('{% for x in range(5) %}[{{ a }}:{% set a = x %}{{ a }}] {% endfor %}{{ a }}').render()
u'[:0] [0:1] [1:2] [2:3] [3:4] '

素晴らしい。 ここでの問題は、これが絶対に健全ではないということです。 どの変数をオーバーライドすることになっていますか？ 間に関数スコープがある場合はどうなりますか。 例：マクロなど。 私は今これをどのようにサポートするのか分かりません。

うーん、 nonlocalが使用されていないと仮定した場合のPythonのスコープに似ているかもしれません）？ つまり、外部スコープで定義されたものをオーバーライドすることは許可しませんが（つまり、間にマクロがある場合）、他のスコープでオーバーライドすることは許可しますか？

どうやらこれがテンプレートアサーションエラーでキャッチダウンされる前に：

>>> Template('{% set x = 0 %}{% for y in [1, 2, 3] recursive %}{{ x }}{% set x = y %}{% endfor %}').render()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
jinja2.exceptions.TemplateAssertionError: It's not possible to set and access variables derived from an outer scope! (affects: x (line 1)

動作は再帰がある場合とない場合で異なるようです（2.8.1では再帰がある場合はUnboundLocalErrorエラーが発生し、再帰がない場合は '012'が発生します）

バインドされていないローカルエラーは、マスターで解決する必要があります。

ここでどのように進めるかわかりません。 どうやらこういうことができたのが嫌いです。

最後の変更で、これを「意図したとおりに機能する」として閉じます。 これからさらにフォールアウトがある場合は、代替案を再度調査できます。

この変更により、v.2.8.1からv2.9.4へのアップグレード時にブログテンプレートが爆破された後、この問題（＃656を参照）が送信されました。

ループの反復間でさまざまなデータが変化しているかどうかを追跡するために使用していました。 元のテンプレートコードを記述したため、修正できました（https://github.com/MinchinWeb/seafoam/commit/8eb760816a06e4f0382816f82586204d1e7734fdおよびhttps://github.com/MinchinWeb/seafoam/commit/89d555dbd6a2f256471d43e4184f09512694e5を参照）そうでなければ私ができたのではないかと疑う。 比較がインラインで行われるようになったため、新しいコードを追跡するのは困難です。 たとえば、私の古いコード（v.2.8.1）：

{%- set last_day = None -%}

{% for article in dates %}
    {# ... #}
    <div class="archives-date">
        {%- if last_day != article.date.day %}
            {{ article.date | strftime('%a %-d') }}
        {% else -%}
            &mdash;
        {%- endif -%}
    </div>
    {%- set last_day = article.date.day %}
{% endfor %}

インライン比較を使用した新しいコード（v2.9.4）：

{% for article in dates %}
    {# ... #}
    <div class="archives-date">
        {%- if ((article.date.day == dates[loop.index0 - 1].date.day) and
                (article.date.month == dates[loop.index0 - 1].date.month) and 
                (article.date.year == dates[loop.index0 - 1].date.year)) %}
                    &mdash;
        {% else -%}
                    {{ article.date | strftime('%a %-d') }}
        {%- endif -%}
    </div>
{% endfor %}

ですから、「機能」（または必要に応じて「ハック」）が使用されており、すでに見逃されていると言いたかっただけです。

スコープの問題が複雑すぎて現時点で適切に理解できない場合は、変更ログに（少なくとも）何かを追加して、気付かない人を少なくすることができますか？

私はこれがそれほど広く乱用されていることに気づいていませんでした：-/迷惑なことに、これを信頼できる方法で機能させる方法は本当にありません。 ただし、ここで一般的なユースケースを分離して、より優れたAPIを導入できるかどうか疑問に思います。

特に、次のようなものを追加したい場合があります（ loop.changed_from_last ）：

{% for article in dates %}
    <div class="archives-date">
        {%- if loop.changed_from_last(article.date.day) %}
            {{ article.date | strftime('%a %-d') }}
        {% else -%}
            &mdash;
        {%- endif -%}
    </div>
{% endfor %}

changed_from_lastは良さそうです-少なくとも機能的には、名前自体は少し厄介なIMOです。 たぶんchangedだけで十分クリアでしょうか？

最初の要素は、それが何であれ、常に「変更された」と見なされると思いますか？ その振る舞いが誰かにとって問題がある場合、とにかく彼らはいつでもnot loop.firstチェックを追加することができます。

たぶん、 previous_contextは、ユーザーがそれをどうするかを決定しようとするのではなく、前のコンテキスト全体を保持しているだけかもしれません。

ちょうどpreviousまたはprev ？ 「コンテキスト」は、このコンテキストではかなり混乱しているように聞こえます（しゃれは意図されていません）

.....そして今、私はすでに誰かがnext求めていることを想像することができます：/

または、スコープ外に書き込むための明示的なステートメント： set_outerなど。

私はこれを考えていました：

class LoopContextBase(object):

    def __init__(self, recurse=None, depth0=0):
        ...
        self._last_iteration = missing

    def changed(self, *value):
        if self._last_iteration != value:
            self._last_iteration = value
            return True
        return False

@davidismスコープシステム全体を壊さずにset_outerを実行することはできません。 これは主に全体を台無しにするでしょう。

ええ、そうなると思いました。 「現在の値が以前の値よりもchangedメソッドも好きです。

追加のデータポイントとして、生成されたHTMLに特別なクラスを挿入する必要がある場合に、それは私の足に落ちましたが、特定のプロパティが設定されていない反復リストの最初の要素に対してのみです。 反復データを変更できません。 loop.first （好きなだけ）、最後の要素の何かと比較して、ここで必要なことを確実に実行することはできません。これにより、完全に機能する邪悪な構造を実験することになりました。 （そして、それが実際にバグを悪用しているのかどうかは私にはわかりませんでした）。

さらに、サードパーティのプラグインを介して拡張機能を提供していますが、作成者がテンプレートをどのように構成するかを監視する方法がないため、Jinja2.9以降に更新した後にエンドユーザーが突然破損します。 作成者にテンプレートを更新させる方法が見つかるまで、（バージョン管理スキームで約束されているように）下位互換性を維持するために、プログラムに最新の2.8バージョンを固定しました。

誰かがなぜjinja2スコープがPythonとまったく同じように機能しないのかを明確にしていただけませんか？ つまり、jinja2テンプレートはpythonモジュールに対応し、マクロは関数に対応し（そして独自のスコープを持ちます）、forループは独自のスコープを持ちません。 @mitsuhikoによると、jinja 2.8以下にはスコープのバグがたくさんありましたが、スコープがどのように機能するかを理解する方が直感的でした。

Pythonプログラマーにとって、最初の投稿（Jinja 2.8）からの動作は明らかです。 同じことがhttps://github.com/pallets/jinja/issues/660にも当てはまり

あるいは、推測する必要がないように、jinjaでのスコープがどのように機能するかを説明するドキュメントが必要です。

また、私のコメントを否定的に受け取らないでください、私はjinjaにとても感謝しています。

@roganovこれに関するいくつかのメモ：

誰かがなぜjinja2スコープがPythonのように正確に機能しないのかを明確にしてください

私の意見では、Pythonのスコープは非常に悪いので、特にテンプレートでは、重要な情報を誤って簡単に上書きしてしまう可能性があるためです。

@mitsuhikoによると、jinja 2.8以下にはスコープのバグがたくさんありましたが、スコープがどのように機能するかを理解する方が直感的でした。

これはバグによる例外であり、一部の限られた状況でのみ機能し、純粋に偶然であることに注意してください。 Jinjaには常に同じスコープルールが文書化されており、この動作は文書化されていません。 変数は常に外部スコープに伝播しないと言われていました。 ループの終了後、変数が設定されなかったため、これは簡単にわかります。

あるいは、推測する必要がないように、jinjaでのスコープがどのように機能するかを説明するドキュメントが必要です。

私はこれのためにすでに数日前にドキュメントを改善しました

変数を明示的にループに渡す方法があった場合はどうなりますか？ おそらく次のような構文（テキストフィルターから借用）：

{%- set last_day = None -%}

{% for article in dates | pass_variable ( last_day ) %}
    {# ... #}
    <div class="archives-date">
        {%- if last_day != article.date.day -%}
            {{ article.date | strftime('%a %-d') }}
        {%- else %}
            &mdash;
        {% endif -%}
    </div>
    {%- set last_day = article.date.day %}
{% endfor %}

または、現在マクロに適用されているscopedと同様のことを行う方法はありますか？

別のユースケースは、ループ間にある種のカウンターを維持することです。 たとえば、合計でいくつの行がありますか？ いくつかの基準を満たす行はいくつありますか？ 選択した行のいくつかのプロパティの合計（合計行を印刷するため）？

フィルタはiterableですでに可能であるため、ここではフィルタ構文は使用できません。

悪く見えないこのための可能な構文は次のとおりです。

{% for article in dates with last_day %}

特に、 withは、たとえば{% with %}として使用された場合、Jinjaですでにスコープ設定を行っているためです。 OTOH、ここでは逆になります。ブロックを使用すると新しいスコープが開き、外部スコープの変数にアクセスできるようにならないためです。

それがJinjaに必要な機能かどうかはわかりません。

それでもスコープルールが破壊されるため、構文によってこれが変更されることはありません。 現在のコンパイルシステムまたはID追跡システムではそれを行うことはできません。 その単純なケースで機能する場合でも、 recursive forループがあるとどうなりますか。 誰かがforループでマクロを定義した場合はどうなりますか。 呼び出しブロックがforループに表示された場合はどうなりますか。

ストレージ名前空間として機能し、で変更できるグローバルオブジェクトを導入する方が理にかなっていると思います。 例えば：

{% set foo = namespace() %}
{% set foo.iterated = false %}
{% for item in seq %}
  {% set foo.iterated = true %}
{% endfor %}

ただし、これにはsetタグを根本的に変更する必要があります。

@mitsuhikoとそのようなパターンは、 doタグですでに使用されています： http ： //stackoverflow.com/a/4880398/400617

FWIW、 doたソリューションは非常にひどいです。 nonlocalが必要なときにPython2で使用する回避策と同じように...

私は完全に同意します、ただそれがそこにあることを指摘します。 そして、Alexが指摘したように、これらの問題の多くは、フィルターを使用するか、Pythonにロジックの一部を配置することで書き直すことができます。

別の（醜い）ハックは、リスト、追加、およびポップを使用することです： http ：

こんにちは、私はこのコードを約2年間使用していますが、現在は壊れており、新しいドキュメントとこのディスカッションから、私がここでやろうとしていることを行う他の方法はないと思います。 そうでない場合は私を訂正してください。

{% set list = "" %}
{% for name in names %}
{% if name.last is defined %}
{% set list = list + name.last + " " %}
{% if loop.last %}
{{ list.split(' ')|unique }}
{% endfor %}

@ pujan14

{{ names|map(attribute="last")|select|unique }}

uniqueは組み込みのフィルターではないため、すでにuniqueフィルターを追加しているので、すべてを実行する別のフィルターをいつでも追加できます。

やあ、
これが原因で「醜い」例がたくさんあることは理解していますが、jinjaテンプレートのforループの変数をエレガントで正しい方法でインクリメントする方法を教えてください。 私のコードも壊れているからです。

なぜあなたはそれをする必要があるのですか？ また、コードを含めてください。

{% for state in states.sensor -%}
{% if loop.first %}
{% set devnum = 0 %}
{% endif -%}
{%- if state.state == "online" %}
{% set devnum = devnum + 1 %}
{%- endif -%}
{% if loop.last %}
{{ devnum }}
{% endif -%}
{%- endfor -%}

jinjaテンプレートのforループの変数をエレガント/正しい方法でインクリメントする方法を教えてください。

あなたはこれをする（またはできる）はずがありませんでした。 だから答えはそうしないでください。 ただし、テンプレートの作成者がそうする必要があるように見える理由に関心があります。

Jinjaはすでにループを列挙しています。 {{ loop.index0 }}

@davidism条件を満たすものだけが必要

devnum, sensorタプルを必要な方法で正確に生成するフィルターを作成します。 または、Pythonで計算して、テンプレートに渡します。 または、以下の例を使用してください。 これは私が見た他のすべての例に当てはまります。

@Molodaxあなたはこれを行うことができます：

{{ states.sensor|selectattr('state', 'equalto', 'online')|sum }}

|countという意味ではありませんか？

はい、ごめんなさい。

@mitsuhiko 、ご支援ありがとうございます、残念ながら動作しません。
おそらく、jinja2（フィルター）は、（ホームアシスタント）を使用するプロジェクトでいくつかの制限付きで実装されています。 しかし、それは以前に私が提供したコードで機能しました。 残念。

こんにちは皆さん。 2.8で動作するコードの例を求めているので、ここに私のものがあります。

{% set count = 0 %}
{% if 'anchors' in group_names %}
nameserver 127.0.0.1
{% set count = count+1 %}
{% endif %}
{% for resolver in resolvers %}
{% if count < 3 %}
{% if resolver|ipv6 and ansible_default_ipv6.address is defined %}
nameserver {{ resolver }}
{% set count = count+1 %}
{% elif resolver|ipv4 and ansible_default_ipv4.address is defined %}
nameserver {{ resolver }}
{% set count = count+1 %}
{% endif %}
{% endif %}
{% endfor %}

2つの別々のループで参照できるグローバルな「カウント」変数なしでこれを行う方法がわかりません。 これが2.8と2.9の両方で機能することを可能にする提案はありますか？

@davidismあなたの解決策は素晴らしいですが、私はこれを達成しようとしています。
次のように2つのリストを作成します

{% set list1 = name|default()|map(attribute="last")|select|list %}
{% set list2 = name|default()|map(attribute="age")|select|list %}

次に、それらをlist3にマージします。これは、次のようになり、最後にlist3にunique（ansible filter）を適用します。
last1-age1
last2-age2
last3-age3
last4-age4
last5-age5
last6-age6

私が収集したものから、マップは複数の属性で機能しません＃554
私はansible経由でjinja2を使用しているので、事前にpythonで何かを追加することは私にとって良い考えではありません。

@ pujan14 @aabdnn @Molodaxこのパターンは、Ansibleの公式ドキュメントからのものですか、それとも他の場所で思いついたものですか、それとも見つけたものですか？ いずれにせよ、Ansibleは製品の使用方法を理解しており、より適切なソリューションを考え出すことができるため、これをAnsibleに報告する方が簡単な場合があります。

@davidism上記で提示したテンプレートは、Ansibleのドキュメントからのものではありません。 AnsibleはJinja2を具体的に文書化していません。 Jinja2のドキュメントを読んでこのテンプレートを自分で作成したところ、機能したので、本番環境に移行しました。 Jinja2が変数をグローバルにしたと思いました。

公式に文書化されていない場合は、元々のようにこれを閉じる傾向があります。 Ansibleがこの点であなたをもっと助けることができるかもしれないことを繰り返します。

@davidism新しいいじってみました。
これが例です。

{% for name in names %}
{% if loop.first %}
{% set list = "" %}
{% endif %}
{% if name.first is defined and name.last is defined and not name.disabled %}
{% set list = list + name.first|string + "-" + name.last|string %}
{% if loop.last %}
{% for item in list.split(' ')|unique %}
{{ item }}
{% endfor %}
{% else %}
{% set list = list + " " %}{% endif %}
{% endif %}
{% endfor %}

これはこれを行うための最良の方法ではないかもしれませんが、ここでは私の理解から、スコープ規則に違反していません。

2.8以降でこの問題が発生しました

テストケースは次のとおりです。

import unittest
from jinja2 import Template

TEMPLATE1 = """{% set a = 1 %}{% for i in items %}{{a}},{% set a = a + 1 %}{% endfor %}"""

class TestTemplate(unittest.TestCase):

  def test_increment(self):
    items = xrange(1,10)
    expected='%s,' % ','.join([str(i) for i in items])
    t = Template(TEMPLATE1)
    result = t.render(items=items)
    self.assertEqual(expected,result)

unittest.main()

代わりにloop.index使用してください。

loopオブジェクトの属性を介して前のループ値へのアクセスを提供することが、これに対する唯一の良い解決策だと思います。 プロジェクトでこのスニペットを発見しましたが、最後のオブジェクトが現在のオブジェクトと異なるかどうかを確認するだけでは解決できず、キーを取得するための単なるアイテム/属性アクセスではないため、groupbyも機能しません。 ：

{% set previous_date = none %}
{% for item in entries -%}
    {% set date = item.start_dt.astimezone(tz_object).date() %}
    {% if previous_date and previous_date != date -%}
        ...
    {% endif %}
    {% set previous_date = date %}
{%- endfor %}

ええ、それはアイデアのように聞こえます。

set(key, value) get(key)メソッドとset(key, value)どうですか？ そうすれば、人々はループ全体で好きなものを保存できます。

同じ考えを持っていましたが、これが必要となる醜いケースを見つけることができませんでした。 そして、私はすでに誰かがsetdefault 、 popおよび他のdictのような方法を求めているのを見ることができました。

@ davidism @ ThiefMaster私はストレージオブジェクトを利用できるようにすることを考えていました。 このような：

{% set ns = namespace() %}
{% set ns.value = 42 %}
...{% set ns.value = 23 %}

明らかに、現時点ではsetは属性を設定できませんが、これは簡単に拡張できます。 名前空間自体への再割り当ては発生しないため、これは非常に安全に実装できます。

私には問題ないようです。これは、Py 2のnonlocalと同じソリューションです。または、ループ外では使用できませんが、 loop.ns自動的に設定します。

私が名前空間で嫌いなのは、 {% set obj.attr = 42 %}をやりたくなることです。 objはnamespace()はないものです-私が思うにうまくいかないことです。

そうでなければ、 previtem / nextitem / changed()は、新しいオブジェクトを定義する必要のある「ノイズ」なしで「単純な」ケースをうまくカバーすると思いますが、それは興味深いアイデアのように見えます。テンプレート内。

@ThiefMasterそれは動作しません。 これが機能していることを確認する方法は、属性の割り当てが環境でコールバックを通過し、名前空間オブジェクトへの変更のみを許可することです。

わかりました。少なくとも、テンプレートに渡されたオブジェクトに予期しない副作用が発生するリスクはありません。

人々がするかもしれないことにはまだ少し警戒しています...

{% macro do_stuff(ns) %}
    {% set ns.foo %}bar{% endset %}
    {% set ns.bar %}foobar{% endset %}
{% endmacro %}

{% set ns = namespace() %}
{{ do_stuff(ns) }}

実際、 {% namespace ns %}ような新しいブロックは、呼び出し可能なものよりも定義する方が良いと思います- namespaceという名前の変数は、テンプレートに渡される可能性が非常に低いようには聞こえませんが、おそらく、そのテンプレートで名前空間機能を使用できないようにするだけです（Pythonの組み込みをシャドウイングするのと同じように）、少し汚い感じがします...

この問題の回避策はありますか、それとも2.9.6のprevitem / nextitemを待つ必要がありますか？
私のsaltstackテンプレートのいくつかが壊れています。

上記のさまざまな程度で示されているように、あなたはあなたがしていることをする必要さえないかもしれません。 それ以外の場合は、はい、2.9を使用する場合は待つ必要があります。 以前はサポートされていませんでしたが、たまたま機能していました。

以前の動作に戻すことはありません。 単純なケースでは機能しましたが、正しくなく、サポートされていると文書化されていませんでした。 これは重大な変更であると理解していますが、機能リリース（2番目の番号の変更）で発生しました。これは、私たちが常にこれらの変更を管理してきた方法です。 古い動作に依存し続ける必要がある場合は、修正がリリースされるまでバージョンを固定します。

言わなければならないことはすべて言われているので、これをロックします。 現在検討中の修正については、＃676および＃684を参照してください。