Викличте функцію python від jinja2

Я використовую jinja2, і я хочу викликати функцію python як помічник, використовуючи аналогічний синтаксис, як якщо б я викликав макрос. jinja2, схоже, має намір запобігти мені робити виклик функції, і наполягає на тому, що я повторюю себе, копіюючи функцію в шаблон як макрос.

Чи є простий спосіб це зробити? І чи є можливість імпортувати цілий набір функцій python та мати їх доступними від jinja2, не проходячи цілу кількість ригамаролів (наприклад, написання розширення)?

Для тих, хто використовує колбу, помістіть це у своє __init__.py:

def clever_function():
    return u'HELLO'

app.jinja_env.globals.update(clever_function=clever_function)

і у вашому шаблоні називайте його {{ clever_function() }}

Примітка. Це специфічна колба!

Я знаю, що ця публікація досить стара, але існують кращі методи цього робити в нових версіях Flask за допомогою контекстних процесорів.

Змінні можна легко створити:

@app.context_processor
def example():
    return dict(myexample='This is an example')

Вищезазначене можна використовувати в шаблоні Jinja2 з колбою так:

{{ myexample }}

(Які виходи This is an example)

А також повноцінні функції:

@app.context_processor
def utility_processor():
    def format_price(amount, currency=u'€'):
        return u'{0:.2f}{1}'.format(amount, currency)
    return dict(format_price=format_price)

Вищезазначене при використанні так:

{{ format_price(0.33) }}

(Яка виводить ціну вводу із символом валюти)

Крім того, ви можете використовувати фільтри джинджа , запечені в колбу. Наприклад, використовуючи декоратори:

@app.template_filter('reverse')
def reverse_filter(s):
    return s[::-1]

Або без декораторів та реєстрації функції вручну:

def reverse_filter(s):
    return s[::-1]
app.jinja_env.filters['reverse'] = reverse_filter

Фільтри, застосовані за допомогою двох вищеописаних методів, можна використовувати так:

{% for x in mylist | reverse %}
{% endfor %}

Я думаю, що jinja навмисно ускладнює запуск «довільного» пітона в шаблоні. Він намагається нав'язати думку, що менше логіки в шаблонах - це добра справа.

Ви можете маніпулювати глобальним простором імен в Environmentекземплярі, щоб додати посилання на свої функції. Це потрібно зробити перед завантаженням будь-яких шаблонів. Наприклад:

from jinja2 import Environment, FileSystemLoader

def clever_function(a, b):
    return u''.join([b, a])

env = Environment(loader=FileSystemLoader('/path/to/templates'))
env.globals['clever_function'] = clever_function

from jinja2 import Template

def custom_function(a):
    return a.replace('o', 'ay')

template = Template('Hey, my name is {{ custom_function(first_name) }} {{ func2(last_name) }}')
template.globals['custom_function'] = custom_function

Ви також можете надати функцію в полях відповідно до відповіді Матроскіна

fields = {'first_name': 'Jo', 'last_name': 'Ko', 'func2': custom_function}
print template.render(**fields)

Виведе:

Hey, my name is Jay Kay

Працює з Jinja2 версії 2.7.3

А якщо ви хочете, щоб декоратор полегшив визначення функцій, template.globalsознайомтеся з відповіддю Бруно Броноського

Мені подобається відповідь @ AJP . Я використовував його дослівно, поки не закінчив багато функцій. Потім я перейшов на функцію декоратора функції Python .

from jinja2 import Template

template = '''
Hi, my name is {{ custom_function1(first_name) }}
My name is {{ custom_function2(first_name) }}
My name is {{ custom_function3(first_name) }}
'''
jinga_html_template = Template(template)

def template_function(func):
    jinga_html_template.globals[func.__name__] = func
    return func

@template_function
def custom_function1(a):
    return a.replace('o', 'ay')

@template_function
def custom_function2(a):
    return a.replace('o', 'ill')

@template_function
def custom_function3(a):
    return 'Slim Shady'

fields = {'first_name': 'Jo'}
print(jinga_html_template.render(**fields))

Гарні функції мають __name__!

Ніколи не бачив такого простого способу в офіційних документах або при переповненні стека, але я був вражений, коли виявив це:

# jinja2.__version__ == 2.8
from jinja2 import Template

def calcName(n, i):
    return ' '.join([n] * i)

template = Template("Hello {{ calcName('Gandalf', 2) }}")

template.render(calcName=calcName)
# or
template.render({'calcName': calcName})

Використовуйте лямбда, щоб підключити шаблон до основного коду

return render_template("clever_template", clever_function=lambda x: clever_function x)

Тоді ви можете без проблем викликати функцію в шаблоні

{{clever_function(value)}}

Щоб викликати функцію python від Jinja2, ви можете використовувати спеціальні фільтри, які працюють аналогічно глобальним: http://jinja.pocoo.org/docs/dev/api/#writing-filters

Це досить просто і корисно. У файлі myTemplate.txt я написав:

{{ data|pythonFct }}

І в сценарії python:

import jinja2

def pythonFct(data):
    return "This is my data: {0}".format(data)

input="my custom filter works!"

loader = jinja2.FileSystemLoader(path or './')
env = jinja2.Environment(loader=loader)
env.filters['pythonFct'] = pythonFct
result = env.get_template("myTemplate.txt").render(data=input)
print(result)

чи є можливість імпортувати цілий набір функцій python і мати їх доступними від jinja2?

Так, крім інших відповідей вище, це працює для мене.

Створіть клас та заповніть його відповідними методами, наприклад

class Test_jinja_object:

    def __init__(self):
        self.myvar = 'sample_var'

    def clever_function (self):
        return 'hello' 

Потім створіть екземпляр свого класу у своїй функції перегляду та передайте результуючий об’єкт у ваш шаблон як параметр для функції render_template.

my_obj = Test_jinja_object()

Тепер у вашому шаблоні ви можете називати методи класу в jinja так

{{ my_obj.clever_function () }}

Щоб імпортувати всі вбудовані функції, ви можете використовувати:

app.jinja_env.globals.update(__builtins__)

Додати .__dict__після, __builtins__якщо це не працює.

На основі відповіді John32323 .

Якщо ви робите це з Django, ви можете просто передати функцію контексту:

context = {
    'title':'My title',
    'str': str,
}
...
return render(request, 'index.html', context)

Тепер ви зможете використовувати strфункцію в шаблоні jinja2

Є набагато простіше рішення.

@app.route('/x')
def x():
    return render_template('test.html', foo=y)

def y(text):
    return text

Потім у test.html :

{{ y('hi') }}