Passing all copier variables to macros

[adepretis]

In discussion #896 the use of Jinja template macros is adviced - and works really well btw. for complex templates.

I was just wondering if there's a way to pass all Copier variables, both from the questionnaire and the ContextHook extension, to such a macro.

So instead of

# macro
{% macro default(var1 = '', var2 = '', var2 = '', ..., varN = '') %}

...

# template
{% import "path/to/my/macro" as mymacro %}
<% mymacro.default(var1 = copier_var1, var2 = copier_var2, ..., varN = copier_varN) %>

it could be something like for macros relying a lot on Copier variables:

# macro
{% macro default(...) %}

...

# template
{% import "path/to/my/macro" as mymacro %}
<% mymacro.default(<pass all copier variables somehow>) %>

[adepretis]

I ended up using "models" and the ContextHook extension. If a new Copier variable is required in the macro's content, I just have to add it to the "model" and use it right away. No need to touch multiple files, signatures, and so on.

# macros/macro_x.py
{% macro default(model = {}) %}
  do_something with {% model["key1"] %}
{% endmacro %}

# macros/macro_y.py
{% macro default(model = {}) %}
  do_something with {% model["key1"] %}
{% endmacro %}

# context.py
contextCustom = {
   ...
}

contextModels = {
    # MyMacro X
    "__mymacro_x_model" : {
        "key1" : context["key1"],
        "key2" : context["key2"],
        "key3" : context["key3"],
        "key4" : context["key4"],
    },

    # MyMacro Y
    "__mymacro_x_model" : {
        "key1" : context["key1"],
        "key2" : context["key2"],
        "key5" : context["key8"],
        "key8" : contextCustom["key8"],
    }
}

return contextCustom | contextModels

# myfile.x
{% import "macros/macro_x.j2" as mymacro %}
{% mymacro.default(model = __mymacro_x_model %}

# myfile.y
{% import "macros/macro_y.j2" as mymacro %}
{% mymacro.default(model = __mymacro_y_model %}

[yajo]

Maybe you're looking for include?

[adepretis]

I didn't have include on the radar at all, thanks for pointing that out. There's maybe an issue with setting include-specific variables like

# project/environments/env1/my_foo.jinja
{% mymacro.default(model = __mymacro_x_model, environment = 'env1' %}

# project/environments/env2/my_foo.jinja
{% mymacro.default(model = __mymacro_x_model, environment = 'env2' %}

# project/environments/env3/my_foo.jinja
{% mymacro.default(model = __mymacro_x_model, environment = 'env3' %}

to achieve

{% macro default(model = {}, environment = '') %}
{% if environment == 'env1' %}
...
{% endif %}

# or

some_yaml:
  environment: {% environment %}  
{% endmacro %}

But this should be possible using

# project/environments/env1/my_foo.jinja
{% set environment = "env1" %}
{% include "/path/to/my/foo.jinja" %}

I'll test it ASAP. Thanks for pointing that out.

[adepretis]

Ok, the solution is much easier: {% import "path/to/my/macro.j2" as mymacro with context %}