Jinja2 inline comments

Question

How can I put comments inside Jinja2 argument list declaration ?

Everything I have tried gives an error: jinja2.exceptions.TemplateSyntaxError: unexpected char u'#'

{{ Switch('var',
    [('1', 'foo'),    #  comment 1
     ('2', 'bar'),    ## comment 2
     ('3', 'rum'),    {# comment 3 #}
     ]) }}


{% macro Switch(var, caselist) %}
    {% for case, action in caselist%}
        CMP  {{var}} {{case}} 
        JNE  {{LABEL}}
        {{action}}
        JMP  {{LABELF}}
{{LABEL}}:  NOP
    {%- endfor %}
{{LABELF}}: NOP
{%- endmacro -%}

In my case Jinja2 is used as macro preprocessor for assembler.

While you're generating assembly, your question doesn't actually seem to be related to that. You could be generating HTML or C++ and it wouldn't change your question. — Ross Ridge, Nov 04 '19 at 17:25
Useful link: https://jinja.palletsprojects.com/en/2.11.x/templates/ — Gabriel Staples, Mar 04 '20 at 02:45

Martijn Pieters · Answer 1 · 2017-11-22T07:55:21.423

176

Jinja2 has no support for comments within a {{ ... }} statement. You can only use comments outside of such statements, and then only with {# .. #} or ## comment.

{# .. #} is only meant for disabling part of a template or adding comments outside of other Jinja2 syntax. You can't nest these.
# statement is the equivalent of {% statement %}, if line statements are enabled and so configured.
## comment only works if line statements are enabled, at which point it regarded as a comment.

Generally, outside of Jinja statements, use comments in the target language instead; e.g.  when generating XML, etc.

edited Nov 22 '17 at 07:55

answered Nov 26 '12 at 09:53

Martijn Pieters

963,270
265
3,804
3,187

2

external comments looks not such pretty in my case :( – kimstik Nov 26 '12 at 09:56
5

"`{# .. #}` is only meant for disabling part of a template" – does not match the current documentation, where it is also used as `{# a comment #}`. – timss Mar 07 '16 at 10:24
4

@timss: That sentence should be read *in the context of this question*, where the OP used `{# comment 3 #}` within a block. Yes, `{# ... #}` are used for commenting, including commenting out (disabling) part of a template. – Martijn Pieters Mar 07 '16 at 11:02

Dan Netoff · Answer 2 · 2020-12-15T14:24:39.873

11

Now Jinja2 has a comment statement:

{% comment %}

    <html code/>
    {% some other statements %}
    {{ some.values }}

{% endcomment %}

edited Dec 15 '20 at 14:24

answered Dec 14 '20 at 12:50

Dan Netoff

97
1
5

May I use it within a {{ ... }} statement ? – kimstik Dec 15 '20 at 09:54
@kimstik, sorry I dont uderstand your question. But I am edit my answer, plz see it – Dan Netoff Dec 15 '20 at 14:26
I love your approach. Stay curious and motivated. Explore a little deeper – kimstik Dec 16 '20 at 10:08
4

For some reason, I still don't have {% comment %}, but then I have used: {% if False %} instead, and I guess it is the same idea. – Oren Jan 14 '21 at 12:54
1

jinja2.exceptions.TemplateSyntaxError: Encountered unknown tag 'comment'. – Ahmed Jun 23 '21 at 21:24
With ansible, I get AnsibleError: template error ... unknown tag comment. – old-monk Mar 22 '22 at 16:59

score 7 · Answer 3 · edited Dec 20 '20 at 23:06

7

I was trying to add comments to Martijn Pieters.

{% .. %} = {# .. #}

{{ .. }} = {# .. #} (same as above)

edited Dec 20 '20 at 23:06

vallentin

21,302
6
52
73

answered Feb 26 '20 at 16:39

Paul Thach

91
1
1

Jinja2 inline comments

3 Answers3

Linked