macros in distinct templates?

[jford00]

Is it possible to have macros defined in 1 config template available to other config templates?
They work if defined in the same config template, but I'm not finding a way to have them defined in different templates.

[gmazoyer]

Can you give an example so I can try to reproduce on my end, and see if this fixable?

[jford00]

Yep.

Here's configuration "test_1" which defines a macro.
______________________________ test_1 ______________________________
{% macro test_macro(key_string,comm_name='') -%}
##################### test_macro #####################
key_string: {{key_string}}
comm_name: {{comm_name}}
{% endmacro %}

---

Here's configuration "test_2" which includes "test_1" & calls the macro.
______________________________ test_2 ______________________________
{% include_configuration "test_1" %}
{{ test_macro ( 'k1', 'c1' ) }}

---

Rendering using "test_2" yields:
______________________________ macro reference error ______________________________
Traceback (most recent call last):
File "/opt/peering-manager/peering_manager/jinja2/init.py", line 32, in render_jinja2
return jinja2_template.render(**context)
~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^
File "/opt/peering-manager/venv/lib/python3.13/site-packages/jinja2/environment.py", line 1295, in render
self.environment.handle_exception()
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^
File "/opt/peering-manager/venv/lib/python3.13/site-packages/jinja2/environment.py", line 942, in handle_exception
raise rewrite_traceback_stack(source=source)
File "", line 2, in top-level template code
File "/opt/peering-manager/venv/lib/python3.13/site-packages/jinja2/sandbox.py", line 399, in call
if not __self.is_safe_callable(__obj):
~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^
File "/opt/peering-manager/venv/lib/python3.13/site-packages/jinja2/sandbox.py", line 265, in is_safe_callable
getattr(obj, "unsafe_callable", False) or getattr(obj, "alters_data", False)
~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
jinja2.exceptions.UndefinedError: 'test_macro' is undefined

---

If I put the macro definition in the same configuration as the reference, it works fine:
______________________________ test_3 ______________________________
{% macro test_macro(key_string,comm_name='') -%}
##################### test_macro #####################
key_string: {{key_string}}
comm_name: {{comm_name}}
{% endmacro %}
{{ test_macro ( 'k1', 'c1' ) }}

---

[gmazoyer]

Thanks. I did some troubleshooting and it seems to be due to the way the include_* Jinja2 filters works right now. This is fixable though but it requires to add new instructions such as import_* and from_* import …. I think we can schedule this to be included in 1.11.

[jford00]

That'd be cool. I'll watch for it.
Thanks.