Reusable macros

[ahall]

in jinja2 you can do something like this:

{% from "helpers/macros.html" import my_reusable_macro, my_reusable_macro2 %}

{{ my_reusable_macro() }}

Would it make sense to implement so macros can be imported and reused instead of them having to be in the same template file as they're used in?

[flosch]

Sounds like an idea, thanks for your suggestion. I will think about it.

[digitalcrab]

{% from "helpers/macros.html" import my_reusable_macro as new_name1, my_reusable_macro2 as new_name2 %}

or

{% from "helpers/macros.html" import my_reusable_macro = new_name1, my_reusable_macro2 = new_name2 %}

Please add as or = statement

[digitalcrab]

Or even load all macros from specified file (without any names)

[ahall]

Yeah I find this takes macros to a whole new level. In current state its not much use for me, but once they can be reused across from multiple templates it'll become very useful for me.

[flosch]

Yes, it'll make its way into pongo2 somehow. Will have some time at the end of next week to think about it deeper.

[ahall]

One difference from jinja2 I noticed is that in jinja2 you can use keyword args when calling macros (pongo2 lets you define the macros with keyword args). Would that be hard to implement?

[flosch]

It would require some fundamental changes in the variable resolver of pongo2 and would lead to a more complex (and time consuming) resolving process. Not sure whether it's worth it.

[ahall]

As usual, brilliant explanation, thanks for this.

[digitalcrab]

So this feature will not be implemented?

[flosch]

I have plans to implement macro imports in pongo2, my last answer was w.r.t. the last question.

[flosch]

I implement the following syntax for macro imports:

{% import "my-other-template.html" my_macro, my_second_macro as renamed_macro %}

Will be available soon. You can't override macros (specifically the macro name) by providing another key through the Context (will lead to an error when calling one of the Execute*-functions).

[ahall]

Sounds good, can't wait to test it.

[flosch]

Please test it. See the commit message on how to use it and what changed.

Let me know if it works for you.

[ahall]

Brilliant, only found one issue when calling another macros from the macro.

I got a macro file _form.html:

{% import "macros/form.html" render_input, render_input_csrf, render_submit_reset %}

{% macro render_user_form(action, form, selRoles, userId = 0) export %}
    <form method="POST" action="{{ action }}" class="form-horizontal" role="form">
        <fieldset>
            {{ render_input_csrf() }}

            {% if userId != 0 %}
            <input name="id" type="hidden" value="{{ userId }}" />
            {% endif %}

            {{ render_input("fullname", form.Fullname, "Full name", "icon-circle", "text", true) }}
            {{ render_input("username", form.Username, "Username", "icon-circle", "text", true) }}
            {{ render_input("email", form.Email, "Email", "icon-envelope", "text", true) }}
            {{ render_input("password", "", "Password", "icon-lock", "password")|safe }}
            {{ render_input("password_confirm", "", "Password Again", "icon-retweet", "password") }}

            {{ render_submit_reset() }}

            <select name="role_ids" multiple="">
                {% for selRole in selRoles %}
                <option value="{{ selRole.Value }}"{% if selRole.Selected %} selected="selected"{% endif %}>{{ selRole.Label }}</option>
                {% endfor %}
            </select>
        </fieldset>
    </form>
{% endmacro %}

I've tried moving the import statement into the macro itself and that blows things up.

[flosch]

Which error message do you get and what does the calling chain looks like (which macro calls which macro from which file)?

[flosch]

Try moving the import statement into the macro (nothing else gets evaluated except for the macro-block when importing a macro).

[ahall]

macros/form.html

{% macro render_submit_reset() export %}
    <div class="clearfix form-actions">
        <div class="col-md-offset-3 col-md-9">
            <button class="btn btn-info" type="submit">
                <i class="icon-ok bigger-110"></i>
                Submit
            </button>

            <button style="margin-left:0.5em;" class="btn" type="reset">
                <i class="icon-undo bigger-110"></i>
                Reset
            </button>
        </div>
    </div>
{% endmacro %}

{% macro render_input(name, value, placeholder, icon, type, required=false, loginInput=false) export %}
    {% set hasError = State.HasFieldError(name) %}

    <div class="form-group{% if hasError %} has-error{% endif %}">
        <div{% if not loginInput %} class="col-sm-6"{% endif %}>
            <label class="block clearfix">
                <span class="block input-icon input-icon-right">
                    <input name="{{ name }}" type="{{ type }}" class="form-control" placeholder="{{ placeholder }}" value="{{ value }}"{% if required %} required="required"{% endif %} />
                    <i class="{{ icon }}"></i>

                    {% if hasError %}
                    <span class="help-block error">{{ State.FieldErrorStr(name) }}</span>
                    {% endif %}
                </span>
            </label>
        </div>
    </div>
{% endmacro %}

{% macro render_input_csrf() export %}
    <input name="_csrf" type="hidden" value="{{ State.CsrfToken() }}" />
{% endmacro %}

user/_form.html

{% macro render_user_form(action, form, selRoles, userId = 0) export %}
    {% import "macros/form.html" render_input, render_input_csrf, render_submit_reset %}

    <form method="POST" action="{{ action }}" class="form-horizontal" role="form">
        <fieldset>
            {{ render_input_csrf() }}

            {% if userId != 0 %}
            <input name="id" type="hidden" value="{{ userId }}" />
            {% endif %}

            {{ render_input("fullname", form.Fullname, "Full name", "icon-circle", "text", true) }}
            {{ render_input("username", form.Username, "Username", "icon-circle", "text", true) }}
            {{ render_input("email", form.Email, "Email", "icon-envelope", "text", true) }}
            {{ render_input("password", "", "Password", "icon-lock", "password")|safe }}
            {{ render_input("password_confirm", "", "Password Again", "icon-retweet", "password") }}

            {{ render_submit_reset() }}

            <select name="role_ids" multiple="">
                {% for selRole in selRoles %}
                <option value="{{ selRole.Value }}"{% if selRole.Selected %} selected="selected"{% endif %}>{{ selRole.Label }}</option>
                {% endfor %}
            </select>
        </fieldset>
    </form>
{% endmacro %}

This gives bunch of errors such as:

[Execution Error in /tmp/templates/macros/form.html | Line 1 Col 4 ()] Macro 'render_submit_reset' called with too many arguments (6 instead of 0). [Execution Error in /tmp/templates/macros/form.html | Line 1 Col 4 ()] Macro 'render_submit_reset' called with too many arguments (6 instead of 0). [Execution Error in /tmp/templates/macros/form.html | Line 1 Col 4 ()] Macro 'render_submit_reset' called with too many arguments (6 instead of 0). [Execution Error in /tmp/templates/macros/form.html | Line 1 Col 4 ()] Macro 'render_submit_reset' called with too many arguments (5 instead of 0). [Execution Error in /tmp/templates/macros/form.html | Line 1 Col 4 ()] Macro 'render_submit_reset' called with too many arguments (5 instead of 0).
 Submit

It seems like the import statement inside the macro is executing the macros.

[ahall]

No, that's what my example here is doing, and gives bunch of errors.

[flosch]

Can you please show me the error when you're not importing the macros inside the macro as well (like in your first post)? Thanks!

[ahall]

In that case there are no errors, pongo2 doesn't find the macros (render_input, render_input_csrf and submit_csrf) and doesn't execute them. Only thing my macro then yields is the form, fieldset and the select box.

[flosch]

Okay, thanks for your feedback. I have to investigate that and will create a new issue for it.

[ahall]

Thanks, let me know if you need anything from me :)

[flosch]

@fromYukki Same here: Would be cool if you could give me a short feedback whether this works for you as expected.