如何从另一个文件导入自定义jinja2过滤器(并使用Flask)？

Question

我有一个jinja_filters.py文件,里面有几十个自定义过滤器.现在我有多个需要使用这些过滤器的Flask应用程序.(我不确定我的问题是否是Flask特定的.)

完成我想要的一个hacky方法是:

app = Flask(__name__)

import jinja_filters

@app.template_filter('filter_name1')
def filter_name1(arg):
    return jinja_filters.filter_name1(arg)

@app.template_filter('filter_name2')
def filter_name2(arg):
    return jinja_filters.filter_name2(arg)

...

这样做的"正确"方法是什么？

编辑:理想情况下,我不必列出每个过滤器名称.因此,当我向jinja_filters.py添加新过滤器时,我不必更新任何其他代码 - 我的所有应用程序都可以立即使用它.

Answer 1

建议使用Flask蓝图进行此操作.其中一个用例是此功能:

• 通过蓝图提供模板过滤器,静态文件,模板和其他实用程序.蓝图不必实现应用程序或查看功能.

您只需使用装饰器或方法创建一个flask.Blueprint对象并使用它以与flask.Flaskapp对象类似的方式注册过滤器.Blueprint.app_template_filterBlueprint.add_app_template_filter

# filters.py

import jinja2
import flask

blueprint = flask.Blueprint('filters', __name__)

# using the decorator
@jinja2.contextfilter
@blueprint.app_template_filter()
def filter1(context, value):
    return 1

# using the method
@jinja2.contextfilter
def filter2(context, value):
    return 2

blueprint.add_app_template_filter(filter2)

然后你只需要在app对象上注册蓝图:

# app.py

import flask
import filters

app = flask.Flask(__name__)
app.register_blueprint(filters.blueprint)

并且,过滤器已注册.

Answer 2

无论您在哪里设置应用程序对象(也许是app.py),您只需要导入自定义过滤器,然后修改Jinja环境属性.

import jinja_filters

app = Flask(__name__)
app.jinja_env.filters['filter_name1'] = jinja_filters.filter_name1
app.jinja_env.filters['filter_name2'] = jinja_filters.filter_name2

等等.

另一种可能性是使用inspect模块来查找所有方法,jinja_filters如下所示:

from inspect import getmembers, isfunction
import jinja_filters

app = Flask(__name__)

my_filters = {name: function 
                for name, function in getmembers(jinja_filters)
                if isfunction(function)}

app.jinja_env.filters.update(my_filters)

该代码未经测试,但其目的是构建jinja_filters文件中存在的函数名称和函数的字典,然后使用过滤器更新Jinja环境的过滤器字典.