web-dev-qa-db-ja.com

Jinja 2テンプレートのすべての変数のリストを取得する方法

テンプレート内のすべての変数とブロックのリストを取得しようとしています。変数を見つけるために独自のパーサーを作成したくありません。以下のスニペットを使ってみました。

from jinja2 import Environment, PackageLoader
env = Environment(loader=PackageLoader('gummi', 'templates'))
template = env.get_template('chat.html')

template.blocksは、キーがブロックであるdictですが、どのようにしてブロック内のすべての変数を取得できますか？

jinja2
31
Kracekumar

誰も質問に答えておらず、答えを見つけたので

from jinja2 import Environment, PackageLoader, meta
env = Environment(loader=PackageLoader('gummi', 'templates'))
template_source = env.loader.get_source(env,   'page_content.html')[0]
parsed_content = env.parse(template_source)
meta.find_undeclared_variables(parsed_content)

これは実行時に実行されないため、宣言されていない変数のリストを生成し、すべての変数のリストを生成します。

注：これにより、includeおよびextendsを使用してインクルードされるhtmlファイルが生成されます。

49
Kracekumar

私も同じニーズを持っていて、 jinja2schema というツールを作成しました。 Jinja2テンプレートから型を推論するためのヒューリスティックアルゴリズムを提供し、ネストされたものを含むすべてのテンプレート変数のリストを取得するためにも使用できます。

これを行う短い例を次に示します。

>>> import jinja2
>>> import jinja2schema
>>>
>>> template = '''
... {{ x }}
... {% for y in ys %}
...     {{ y.nested_field_1 }}
...     {{ y.nested_field_2 }}
... {% endfor %}
... '''
>>> variables = jinja2schema.infer(template)
>>>
>>> variables
{'x': <scalar>,
 'ys': [{'nested_field_1': <scalar>, 'nested_field_2': <scalar>}]}
>>>
>>> variables.keys()
['x', 'ys']
>>> variables['ys'].item.keys()
['nested_field_2', 'nested_field_1']
9
aromanovich

私のペリカンのテーマでは、テンプレートファイル内のすべてのジンジャ変数を分析するためのツールを作成しました。

コードを共有する

このスクリプトは、テンプレートファイルに存在するすべての変数からサンプル構成を生成し、公式のpelicanconf.pyから変数を取得します

テンプレートファイルからすべての変数を抽出する関数

def get_variables(filename):
    env = Environment(loader=FileSystemLoader('templates'))
    template_source = env.loader.get_source(env, filename)[0]
    parsed_content = env.parse(template_source)

完全なスクリプト

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# use:
# generate_pelicanconf-sample.py my_official_blog/pelicanconf.py

import sys
import imp
import os

from jinja2 import Environment, FileSystemLoader, meta


# Search all template files
def list_html_templates():
    dirList = os.listdir('templates')

    return dirList


# get all variable in template file
def get_variables(filename):
    env = Environment(loader=FileSystemLoader('templates'))
    template_source = env.loader.get_source(env, filename)[0]
    parsed_content = env.parse(template_source)

    return meta.find_undeclared_variables(parsed_content)


# Check if the pelicanconf.py is in param
if len(sys.argv) != 2:
    print("Please indicate the pelicanconf.py file")
    sys.exit()

# Get all vars from templates files
all_vars = set()
files = list_html_templates()
for fname in files:
    variables = get_variables(fname)
    for var in variables:
        if var.isupper():
            all_vars.add(var)

m = imp.load_source('pelicanconf', sys.argv[1])

# Show pelicanconf.py vars content
for var in all_vars:
    varname = 'm.%s' % var
    if var in m.__dict__:
        print ("%s = %s" % (var, repr(m.__dict__[var])))


    return meta.find_undeclared_variables(parsed_content)

このプログラムのサンプル結果

LINKS = ((u'Home', u'/'), (u'archives', u'/archives.html'), (u'tags', u'/tags.html'), (u'A propos', u'http://bruno.adele.im'))
SITESUBTITLE = u'Une famille compl\xe8tement 633<'
DEFAULT_LANG = u'fr'
SITEURL = u'http://blog.jesuislibre.org'
AUTHOR = u'Bruno Adel\xe9'
SITENAME = u'Famille de geeks'
SOCIAL = ((u'adele', u'http://adele.im'), (u'feed', u'http://feeds.feedburner.com/FamilleDeGeek'), (u'Twitter', u'http://Twitter.com/jesuislibre.org'), (u'google+', u'https://plus.google.com/100723270029692582967'), (u'blog', u'http://blog.jesuislibre.org'), (u'facebook', u'http://www.facebook.com/bruno.adele'), (u'flickr', u'http://www.flickr.com/photos/b_adele'), (u'linkedin', u'http://fr.linkedin.com/in/brunoadele'))
FEED_DOMAIN = u'http://blog.jesuislibre.org'
FEED_ALL_ATOM = u'feed.atom'
DISQUS_SITENAME = u'blogdejesuislibreorg'
DEFAULT_PAGINATION = 10
GITHUB_BLOG_SITE = u'https://github.com/badele/blog.jesuislibre.org'

このスクリプトの詳細については、 https://github.com/badele/pelican-theme-jesuislibre を参照してください

5
Bruno Adelé

詳細は Jinja2 Meta APIドキュメント を参照してください

3
Sarath

解決策： https://Gist.github.com/sxslex/822bd2405885294747b86aac187f1aa8

def template(html, **params):
    import jinja2
    env = jinja2.Environment(loader=FileSystemLoader(''))

    def tojson(s):                                       
        import json
        return json.dumps(s)
    env.filters['tojson'] = tojson
    template = env.from_string(html)
    return template.render(context=params, **params)

print(template('{{ context|tojson }}', name='slex', value=39 ))
1
SleX