Flask中的模版是基于jinja2.所以首先學(xué)習(xí)一下jinja2當(dāng)中的基本概念.

Part 1 Basics of Jinja2

暫時(shí)略

Part 2 demo.py

from flask import Flask, render_template

app = Flask(__name__)

@app.route('/')
def index():
    name = 'Saltriver'
    return render_template('hello.html', name=name)

Part 3

在初始化Flask實(shí)例過(guò)程中:

    def __init__(self, import_name, static_path=None, static_url_path=None,
                 static_folder='static', template_folder='templates',
                 instance_path=None, instance_relative_config=False,
                 root_path=None):
        _PackageBoundObject.__init__(self, import_name,
                                     template_folder=template_folder,
                                     root_path=root_path)

首先會(huì)初始化_PackageBoundObject.從名字上面可以看出，這個(gè)對(duì)象是與某個(gè)包綁定了的.下面來(lái)看下:

    def __init__(self, import_name, template_folder=None, root_path=None):
        #: The name of the package or module.  Do not change this once
        #: it was set by the constructor.
        self.import_name = import_name

        #: location of the templates.  ``None`` if templates should not be
        #: exposed.
        self.template_folder = template_folder

        if root_path is None:
            root_path = get_root_path(self.import_name)

        #: Where is the app root located?
        self.root_path = root_path

        self._static_folder = None
        self._static_url_path = None

_PackageBoundObject中的init函數(shù)還是比較簡(jiǎn)單的.設(shè)置了import_name, root_path. 其中template_folder, _static_folder, _static_url_path為None.
在Flask的init函數(shù)中，設(shè)置了static_folder.

下面看render_template函數(shù):

def render_template(template_name_or_list, **context):
    
    ctx = _app_ctx_stack.top
    ctx.app.update_template_context(context)   # <-----
    return _render(ctx.app.jinja_env.get_or_select_template(template_name_or_list),
                   context, ctx.app)

    def update_template_context(self, context):
       
        # funcs = _default_template_ctx_processor
        funcs = self.template_context_processors[None]
        reqctx = _request_ctx_stack.top
        ...
        orig_ctx = context.copy()
        for func in funcs:
            # func()的效果就是_default_template_ctx_processor().
            # 將g, request, session變量加入到context中.
            context.update(func())
        # 意思是，如果render_template()中的參數(shù)有類(lèi)似于g=x,request=y,session=z
        # 之類(lèi)的值的話(huà)，就優(yōu)先使用參數(shù)中的g.也就是說(shuō)context['g'] 為參數(shù)中的值
        context.update(orig_ctx)

此時(shí)context中就包括以下4個(gè)key-value:
{'session': <NullSession {}>, 'request': <Request 'http://127.0.0.1:5000/' [GET]>, 'name': 'Saltriver', 'g': <flask.g of 'test_template'>}

接下來(lái)是render_template中的_render函數(shù).

    return _render(ctx.app.jinja_env.get_or_select_template(template_name_or_list),
                   context, ctx.app)

def _render(template, context, app):

    before_render_template.send(app, template=template, context=context)
    rv = template.render(context)
    template_rendered.send(app, template=template, context=context)
    return rv

首先看template參數(shù)是如何獲得的:

ctx.app.jinja_env.get_or_select_template(template_name_or_list)

jinja_env是一個(gè)locked_cached_property

    @locked_cached_property
    def jinja_env(self):
        return self.create_jinja_environment()

那么，什么是locked_cached_property?

class locked_cached_property(object):
    
    def __init__(self, func, name=None, doc=None):
        self.__name__ = name or func.__name__
        self.__module__ = func.__module__
        self.__doc__ = doc or func.__doc__
        self.func = func
        self.lock = RLock()

    def __get__(self, obj, type=None):
        if obj is None:
            return self
        with self.lock:
            value = obj.__dict__.get(self.__name__, _missing)
            if value is _missing:
                value = self.func(obj)
                obj.__dict__[self.__name__] = value
            return value

也就是說(shuō)jinja_env = locked_cached_property(jinja_env)，jinja_env現(xiàn)在是個(gè)描述符.
但我們?cè)L問(wèn)jinja_env屬性的時(shí)候，會(huì)調(diào)用get方法，obj設(shè)置為ctx.app. obj.dict中并沒(méi)有self.name也就是'jinja_env'屬性(type(obj).dict才有這個(gè)屬性).于是value is _missing. 然后執(zhí)行原始函數(shù)，value = ctx.app.create_jinja_environment() 并設(shè)置該屬性到ctx.app中. 換句話(huà)說(shuō)，在第一次創(chuàng)建了jinja environment后，app實(shí)例中就有了這個(gè)屬性，以后就不用每次調(diào)用一次create_jinja_environment. 加鎖是保證多線(xiàn)程安全.下面看create_jinja_environment函數(shù)：

    def create_jinja_environment(self):
        
        ...
        # 創(chuàng)建環(huán)境.
        rv = self.jinja_environment(self, **options)  # <-----代碼段1
        rv.globals.update(
            url_for=url_for,
            get_flashed_messages=get_flashed_messages,
            config=self.config,
            # request, session and g are normally added with the
            # context processor for efficiency reasons but for imported
            # templates we also want the proxies in there.
            request=request,
            session=session,
            g=g
        )
        rv.filters['tojson'] = json.tojson_filter
        return rv

下面看代碼段1， jinja_environment就是Enviroment：

class Environment(BaseEnvironment):
    
    def __init__(self, app, **options):
        if 'loader' not in options:
            # 創(chuàng)建loader.
            options['loader'] = app.create_global_jinja_loader()   # <-----
        BaseEnvironment.__init__(self, **options)   # <----
        self.app = app

loader就是DispatchingJinjaLoader，繼承自BaseLoader:

class DispatchingJinjaLoader(BaseLoader):
    def __init__(self, app):
        self.app = app
    ...

于是，rv=Environment也創(chuàng)建完畢了.最后更新rv.globals中的值，可以看到環(huán)境中的全局變量有url_for, get_flashed_messages, config, request, session, g.這些全局變量可以在模版中直接使用.
rv.filters['tojson']是什么意思呢？
====================================================

ctx.app.jinja_env.get_or_select_template(template_name_or_list)

這段代碼的前段部分ctx.app.jinja_env是用來(lái)創(chuàng)建Environment.
我們可以查看Environment中的屬性.

>>>with app.test_request_context('/'):
...     print env.loader
...     for key in env.globals:
...         print key, env.globals[key], '\n'
>>>...

env.loader為flask.templating.DispatchingJinjaLoader.
我們可以看到env.globals中還有其他有趣的變量: lipsum, dict, cycler, joiner.
Environment創(chuàng)建好之后，我們看看接下來(lái)是怎么加載(loader)模版的.
加載模版就是get_or_select_template()函數(shù).我們查看該函數(shù)的doc:

Does a typecheck and dispatches to select_template() if 
an iterable of template names is given, otherwise to get_template().

對(duì)于‘hello.html’這個(gè)模版,該函數(shù)會(huì)委托給get_template()函數(shù).再看get_template的doc:

Load a template from the loader. If a loader is configuered this
method ask the loader for the template and returns a Template.

換句話(huà)說(shuō)，get_template函數(shù)將會(huì)使用env.loader來(lái)加載模版.
下面我們簡(jiǎn)單的深入到env.get_template函數(shù)中看看:

    def get_template(self, name, parent=None, globals=None):
        ...
        return self._load_template(name, self.make_globals(globals))

其中self.make_globals(globals)就是加入了DEFAULT_NAMESPACE:
DEFAULT_NAMESPACE = {
'range': range_type,
'dict': dict,
'lipsum': generate_lorem_ipsum,
'cycler': Cycler,
'joiner': Joiner
}

下面繼續(xù)看_load_template函數(shù):

    def _load_template(self, name, globals):
        ...
        # 開(kāi)始使用self.loader加載模版.
        template = self.loader.load(self, name, globals)   # <-----
        if self.cache is not None:
            self.cache[cache_key] = template
        return template

self.loader也就是DispatchingJinjaLoader,繼承自BaseLoader.
下面為了不陷入Jinja2的細(xì)節(jié)之中而不能自拔.這里我們只是熟悉一下Jinja2.Loader的API.
官方文檔已經(jīng)寫(xiě)得很好了,這里我也只是對(duì)照官方文檔對(duì)重點(diǎn)進(jìn)行了翻譯.
----------Jinja2.Loader API-----------
Loaders負(fù)責(zé)從一個(gè)資源所在地,比如文件系統(tǒng)(file system),加載模版.
Environment會(huì)保存編譯后的modules保存到內(nèi)存中,原理類(lèi)似Python的sys.modules.
不同于sys.modules, Environment中的緩存(cache),會(huì)有大小的限制.所有的loaders
都繼承BaseLoader.如果你想創(chuàng)建你自己的loader, 請(qǐng)繼承BaseLoader然后重寫(xiě)get_source函數(shù).

class jinja2.BaseLoader:
Environment提供了一個(gè)get_template方法， # <-----Env調(diào)用load與loader調(diào)用load的區(qū)別.
這個(gè)方法會(huì)調(diào)用loader的load方法來(lái)獲取Template對(duì)象.
不用overide BaseLoader的load方法.load方法會(huì)調(diào)用get_source方法.
官方文檔給出了一個(gè)class MyLoader(BaseLoader)的示例.
get_source函數(shù)會(huì)返回一個(gè)元組，元組里面都有什么東西呢？
(source, filename, uptodate)
其中source應(yīng)該為unicode string 或者 ASCII bytestring.
filename應(yīng)該為name of file on the filesystem.否則為None.
uptodate是用來(lái)被調(diào)用，以確定template是否發(fā)生變化了.通常是個(gè)
lambda函數(shù).

                BaseLoader
                /  /|\
               /  / | \
         MyLoader/  |  \
                /   |  DictLoader 
        FileSystemLoader 
                    |    
                PackageLoader    

在DispatchingJinjaLoader的get_source中,
如果沒(méi)有設(shè)置'EXPLAIN_TEMPLATE_LOADING'參數(shù)為T(mén)rue.
就啟用_get_source_fast(所謂快速(默認(rèn))獲取?):

    def _get_source_fast(self, environment, template):
        # loader為FileSystemLoader.
        for srcobj, loader in self._iter_loaders(template):  ＃ 代碼段1
            try:
                # 調(diào)用FileSystemLoader的get_source函數(shù).
                # get_source函數(shù)返回一個(gè)元組.
                return loader.get_source(environment, template)  
            except TemplateNotFound:
                continue
        raise TemplateNotFound(template)

在代碼段1中:

    def _iter_loaders(self, template):
        loader = self.app.jinja_loader  
        if loader is not None:
            yield self.app, loader

        # 暫時(shí)忽略，暫時(shí)不涉及到藍(lán)本.
        for blueprint in self.app.iter_blueprints():
            loader = blueprint.jinja_loader
            if loader is not None:
                yield blueprint, loader

_iter_loaders是個(gè)生成器.可以看到與藍(lán)本有關(guān)的loader就在這里獲取.
jinja_loader在_PackageBoundObject中定義,這里就不貼出代碼,
self.app.jinja_loader返回FileSystemLoader.

于是DispatchingJinjaLoader執(zhí)行完畢.
最后_render函數(shù)中,發(fā)送相應(yīng)信號(hào),對(duì)模版進(jìn)行渲染.并返回.

--------- QUESTION ----------
Q1:app.create_jinja_environment()函數(shù)中rv.globals.update()
中有request, session, g. 同時(shí)render_template()函數(shù)中
對(duì)ctx.app.update_template_context(context)也進(jìn)行了request,
session, g的更新.這是為什么呢？

A1: 注釋已經(jīng)說(shuō)了:
# inside the app.create_jinja_environment():
# request, session and g are normally added with the
# context processor for efficiency reasons but for imported
# templates we also want the proxies in there.

Part 4

整個(gè)執(zhí)行框架已經(jīng)有了，我們?cè)倏纯雌渲械囊恍┘?xì)節(jié).