Add a resetcycle template tag

[Simon Litchfield <simon@…>]

Under the following example, I would expect the cycle tag's internal counter to be reset after leaving the inner loop. That way it'd be 'nesting safe' :-) Thoughts, anyone?

{% for group in grouped %}
  {% for item in group.list %}
   ... {% cycle row1,row2,row3 %} ...
  {% endfor %}
{% endfor %}

[Simon Litchfield <simon@…>]

New safe_cycle tag which respects for loop nesting

[Malcolm Tredinnick]

The current behaviour of the cycle tag is very useful, so we don't want to change that. The scope of a cycle tag is everywhere after it is defined for just this reason. Adding another cycle tag isn't a neat solution, either.

The solution here is to add a "resetcycle" tag. Given no arguments, it reset the most recent looped cycle tag. Given an argument, it resets the cycle tag with that name.

[Ville Säävuori]

First stab at resetcycle tag

[Ville Säävuori]

I made a patch based on Malcolms last comment. This works for me but I'm not quite sure if it is fully valid solution. If someone could take a look and comment this, it would be appreciated.

[imbaczek@…]

I've just ran into this very problem, this needs a solution before 1.0 IMHO.

[anibal]

Yes, I think this will be useful too. Any news?

[Antti Kaihola]

Replying to Uninen:

I made a patch based on Malcolms last comment. This works for me but I'm not quite sure if it is fully valid solution. If someone could take a look and comment this, it would be appreciated.

I see a couple of problems (looking at the code, didn't actually test it):

• reserves the {{ resetcycle }} context variable; any templates which happen to use it will be broken
• can't reset multiple simultaneous cycles (will forget previous reset)
• no tests
• no documentation

I'll try to think about this a bit.

[Antti Kaihola]

Patch: add the {% resetcycle %} tag, with tests and documentation

[Antti Kaihola]

The above patch adds a {% resetcycle %} tag which does not pollute the context. It should be able to reset the last unnamed and multiple named {% cycle %} tags.

The patch also lives in a ​GitHub branch.

[Chris Beaven]

This needs to be brought up to speed with the thread-safe changes to template tags (cycle uses the RenderContext now).

[jamesp]

Updated patch to current trunk; added TemplateSyntaxError tests

[jamesp]

Updated the patch to the current trunk but I am wondering if {% resetcycle %} shouldn't reset the most recent cycle if a name isn't provided.
This would be consistent with {% endblock %} and may lead to confusion if not implemented similarly.

[wim@…]

James, what do you think of changing the name to endcycle, like endblock and endcomment ?

[b.schube@…]

Updated patch to current trunk

[b.schube@…]

small correction

[Florian Apolloner]

Changed the cycle tag to always reset the "last" cycle instead of the "last unnamed".

[Tim Graham]

​PR

[Tim Graham]

Left some comments for improvement on the PR.

[Sergei Maertens]

Remarks processed, up for re-review

[Tim Graham <timograham@…>]

In 32c02f2a:

Fixed #5908 -- Added {% resetcycle %} template tag.

Thanks to Simon Litchfield for the report, Uninen for the initial
patch, akaihola, jamesp, b.schube, and Florian Appoloner for
subsequent patches, tests, and documentation.