| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-
- <title>flask.templating — proxypool documentation</title>
-
- <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
- <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
-
- <script type="text/javascript">
- var DOCUMENTATION_OPTIONS = {
- URL_ROOT: '../../',
- VERSION: '',
- COLLAPSE_INDEX: false,
- FILE_SUFFIX: '.html',
- HAS_SOURCE: true
- };
- </script>
- <script type="text/javascript" src="../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../_static/doctools.js"></script>
- <link rel="index" title="Index" href="../../genindex.html" />
- <link rel="search" title="Search" href="../../search.html" />
- <link rel="top" title="proxypool documentation" href="../../index.html" />
- <link rel="up" title="Module code" href="../index.html" />
-
- <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
-
-
- <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head>
- <body role="document">
-
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
- <div class="body" role="main">
-
- <h1>Source code for flask.templating</h1><div class="highlight"><pre>
- <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
- <span class="sd">"""</span>
- <span class="sd"> flask.templating</span>
- <span class="sd"> ~~~~~~~~~~~~~~~~</span>
- <span class="sd"> Implements the bridge to Jinja2.</span>
- <span class="sd"> :copyright: (c) 2015 by Armin Ronacher.</span>
- <span class="sd"> :license: BSD, see LICENSE for more details.</span>
- <span class="sd">"""</span>
- <span class="kn">from</span> <span class="nn">jinja2</span> <span class="k">import</span> <span class="n">BaseLoader</span><span class="p">,</span> <span class="n">Environment</span> <span class="k">as</span> <span class="n">BaseEnvironment</span><span class="p">,</span> \
- <span class="n">TemplateNotFound</span>
- <span class="kn">from</span> <span class="nn">.globals</span> <span class="k">import</span> <span class="n">_request_ctx_stack</span><span class="p">,</span> <span class="n">_app_ctx_stack</span>
- <span class="kn">from</span> <span class="nn">.signals</span> <span class="k">import</span> <span class="n">template_rendered</span><span class="p">,</span> <span class="n">before_render_template</span>
- <span class="k">def</span> <span class="nf">_default_template_ctx_processor</span><span class="p">():</span>
- <span class="sd">"""Default template context processor. Injects `request`,</span>
- <span class="sd"> `session` and `g`.</span>
- <span class="sd"> """</span>
- <span class="n">reqctx</span> <span class="o">=</span> <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">top</span>
- <span class="n">appctx</span> <span class="o">=</span> <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">top</span>
- <span class="n">rv</span> <span class="o">=</span> <span class="p">{}</span>
- <span class="k">if</span> <span class="n">appctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">rv</span><span class="p">[</span><span class="s1">'g'</span><span class="p">]</span> <span class="o">=</span> <span class="n">appctx</span><span class="o">.</span><span class="n">g</span>
- <span class="k">if</span> <span class="n">reqctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">rv</span><span class="p">[</span><span class="s1">'request'</span><span class="p">]</span> <span class="o">=</span> <span class="n">reqctx</span><span class="o">.</span><span class="n">request</span>
- <span class="n">rv</span><span class="p">[</span><span class="s1">'session'</span><span class="p">]</span> <span class="o">=</span> <span class="n">reqctx</span><span class="o">.</span><span class="n">session</span>
- <span class="k">return</span> <span class="n">rv</span>
- <div class="viewcode-block" id="Environment"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Environment">[docs]</a><span class="k">class</span> <span class="nc">Environment</span><span class="p">(</span><span class="n">BaseEnvironment</span><span class="p">):</span>
- <span class="sd">"""Works like a regular Jinja2 environment but has some additional</span>
- <span class="sd"> knowledge of how Flask's blueprint works so that it can prepend the</span>
- <span class="sd"> name of the blueprint to referenced templates if necessary.</span>
- <span class="sd"> """</span>
- <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">):</span>
- <span class="k">if</span> <span class="s1">'loader'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
- <span class="n">options</span><span class="p">[</span><span class="s1">'loader'</span><span class="p">]</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">create_global_jinja_loader</span><span class="p">()</span>
- <span class="n">BaseEnvironment</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">app</span></div>
- <div class="viewcode-block" id="DispatchingJinjaLoader"><a class="viewcode-back" href="../../flask/flask.html#flask.app.DispatchingJinjaLoader">[docs]</a><span class="k">class</span> <span class="nc">DispatchingJinjaLoader</span><span class="p">(</span><span class="n">BaseLoader</span><span class="p">):</span>
- <span class="sd">"""A loader that looks for templates in the application and all</span>
- <span class="sd"> the blueprint folders.</span>
- <span class="sd"> """</span>
- <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">app</span>
- <div class="viewcode-block" id="DispatchingJinjaLoader.get_source"><a class="viewcode-back" href="../../flask/flask.html#flask.app.DispatchingJinjaLoader.get_source">[docs]</a> <span class="k">def</span> <span class="nf">get_source</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environment</span><span class="p">,</span> <span class="n">template</span><span class="p">):</span>
- <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'EXPLAIN_TEMPLATE_LOADING'</span><span class="p">]:</span>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_source_explained</span><span class="p">(</span><span class="n">environment</span><span class="p">,</span> <span class="n">template</span><span class="p">)</span>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_source_fast</span><span class="p">(</span><span class="n">environment</span><span class="p">,</span> <span class="n">template</span><span class="p">)</span></div>
- <span class="k">def</span> <span class="nf">_get_source_explained</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environment</span><span class="p">,</span> <span class="n">template</span><span class="p">):</span>
- <span class="n">attempts</span> <span class="o">=</span> <span class="p">[]</span>
- <span class="n">trv</span> <span class="o">=</span> <span class="kc">None</span>
- <span class="k">for</span> <span class="n">srcobj</span><span class="p">,</span> <span class="n">loader</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_iter_loaders</span><span class="p">(</span><span class="n">template</span><span class="p">):</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="n">rv</span> <span class="o">=</span> <span class="n">loader</span><span class="o">.</span><span class="n">get_source</span><span class="p">(</span><span class="n">environment</span><span class="p">,</span> <span class="n">template</span><span class="p">)</span>
- <span class="k">if</span> <span class="n">trv</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">trv</span> <span class="o">=</span> <span class="n">rv</span>
- <span class="k">except</span> <span class="n">TemplateNotFound</span><span class="p">:</span>
- <span class="n">rv</span> <span class="o">=</span> <span class="kc">None</span>
- <span class="n">attempts</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">loader</span><span class="p">,</span> <span class="n">srcobj</span><span class="p">,</span> <span class="n">rv</span><span class="p">))</span>
- <span class="kn">from</span> <span class="nn">.debughelpers</span> <span class="k">import</span> <span class="n">explain_template_loading_attempts</span>
- <span class="n">explain_template_loading_attempts</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">,</span> <span class="n">template</span><span class="p">,</span> <span class="n">attempts</span><span class="p">)</span>
- <span class="k">if</span> <span class="n">trv</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="k">return</span> <span class="n">trv</span>
- <span class="k">raise</span> <span class="n">TemplateNotFound</span><span class="p">(</span><span class="n">template</span><span class="p">)</span>
- <span class="k">def</span> <span class="nf">_get_source_fast</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environment</span><span class="p">,</span> <span class="n">template</span><span class="p">):</span>
- <span class="k">for</span> <span class="n">srcobj</span><span class="p">,</span> <span class="n">loader</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_iter_loaders</span><span class="p">(</span><span class="n">template</span><span class="p">):</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="k">return</span> <span class="n">loader</span><span class="o">.</span><span class="n">get_source</span><span class="p">(</span><span class="n">environment</span><span class="p">,</span> <span class="n">template</span><span class="p">)</span>
- <span class="k">except</span> <span class="n">TemplateNotFound</span><span class="p">:</span>
- <span class="k">continue</span>
- <span class="k">raise</span> <span class="n">TemplateNotFound</span><span class="p">(</span><span class="n">template</span><span class="p">)</span>
- <span class="k">def</span> <span class="nf">_iter_loaders</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">template</span><span class="p">):</span>
- <span class="n">loader</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">jinja_loader</span>
- <span class="k">if</span> <span class="n">loader</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">,</span> <span class="n">loader</span>
- <span class="k">for</span> <span class="n">blueprint</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">iter_blueprints</span><span class="p">():</span>
- <span class="n">loader</span> <span class="o">=</span> <span class="n">blueprint</span><span class="o">.</span><span class="n">jinja_loader</span>
- <span class="k">if</span> <span class="n">loader</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="k">yield</span> <span class="n">blueprint</span><span class="p">,</span> <span class="n">loader</span>
- <div class="viewcode-block" id="DispatchingJinjaLoader.list_templates"><a class="viewcode-back" href="../../flask/flask.html#flask.app.DispatchingJinjaLoader.list_templates">[docs]</a> <span class="k">def</span> <span class="nf">list_templates</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="n">result</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
- <span class="n">loader</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">jinja_loader</span>
- <span class="k">if</span> <span class="n">loader</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">result</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">loader</span><span class="o">.</span><span class="n">list_templates</span><span class="p">())</span>
- <span class="k">for</span> <span class="n">blueprint</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">iter_blueprints</span><span class="p">():</span>
- <span class="n">loader</span> <span class="o">=</span> <span class="n">blueprint</span><span class="o">.</span><span class="n">jinja_loader</span>
- <span class="k">if</span> <span class="n">loader</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="k">for</span> <span class="n">template</span> <span class="ow">in</span> <span class="n">loader</span><span class="o">.</span><span class="n">list_templates</span><span class="p">():</span>
- <span class="n">result</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">template</span><span class="p">)</span>
- <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">result</span><span class="p">)</span></div></div>
- <span class="k">def</span> <span class="nf">_render</span><span class="p">(</span><span class="n">template</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">app</span><span class="p">):</span>
- <span class="sd">"""Renders the template and fires the signal"""</span>
- <span class="n">before_render_template</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">template</span><span class="o">=</span><span class="n">template</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="n">context</span><span class="p">)</span>
- <span class="n">rv</span> <span class="o">=</span> <span class="n">template</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">context</span><span class="p">)</span>
- <span class="n">template_rendered</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">template</span><span class="o">=</span><span class="n">template</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="n">context</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">rv</span>
- <div class="viewcode-block" id="render_template"><a class="viewcode-back" href="../../flask/flask.html#flask.app.render_template">[docs]</a><span class="k">def</span> <span class="nf">render_template</span><span class="p">(</span><span class="n">template_name_or_list</span><span class="p">,</span> <span class="o">**</span><span class="n">context</span><span class="p">):</span>
- <span class="sd">"""Renders a template from the template folder with the given</span>
- <span class="sd"> context.</span>
- <span class="sd"> :param template_name_or_list: the name of the template to be</span>
- <span class="sd"> rendered, or an iterable with template names</span>
- <span class="sd"> the first one existing will be rendered</span>
- <span class="sd"> :param context: the variables that should be available in the</span>
- <span class="sd"> context of the template.</span>
- <span class="sd"> """</span>
- <span class="n">ctx</span> <span class="o">=</span> <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">top</span>
- <span class="n">ctx</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">update_template_context</span><span class="p">(</span><span class="n">context</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">_render</span><span class="p">(</span><span class="n">ctx</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">jinja_env</span><span class="o">.</span><span class="n">get_or_select_template</span><span class="p">(</span><span class="n">template_name_or_list</span><span class="p">),</span>
- <span class="n">context</span><span class="p">,</span> <span class="n">ctx</span><span class="o">.</span><span class="n">app</span><span class="p">)</span></div>
- <div class="viewcode-block" id="render_template_string"><a class="viewcode-back" href="../../flask/flask.html#flask.app.render_template_string">[docs]</a><span class="k">def</span> <span class="nf">render_template_string</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="o">**</span><span class="n">context</span><span class="p">):</span>
- <span class="sd">"""Renders a template from the given template source string</span>
- <span class="sd"> with the given context. Template variables will be autoescaped.</span>
- <span class="sd"> :param source: the source code of the template to be</span>
- <span class="sd"> rendered</span>
- <span class="sd"> :param context: the variables that should be available in the</span>
- <span class="sd"> context of the template.</span>
- <span class="sd"> """</span>
- <span class="n">ctx</span> <span class="o">=</span> <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">top</span>
- <span class="n">ctx</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">update_template_context</span><span class="p">(</span><span class="n">context</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">_render</span><span class="p">(</span><span class="n">ctx</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">jinja_env</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">source</span><span class="p">),</span>
- <span class="n">context</span><span class="p">,</span> <span class="n">ctx</span><span class="o">.</span><span class="n">app</span><span class="p">)</span></div>
- </pre></div>
- </div>
- </div>
- </div>
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
- <div class="sphinxsidebarwrapper"><div class="relations">
- <h3>Related Topics</h3>
- <ul>
- <li><a href="../../index.html">Documentation overview</a><ul>
- <li><a href="../index.html">Module code</a><ul>
- </ul></li>
- </ul></li>
- </ul>
- </div>
- <div id="searchbox" style="display: none" role="search">
- <h3>Quick search</h3>
- <form class="search" action="../../search.html" method="get">
- <div><input type="text" name="q" /></div>
- <div><input type="submit" value="Go" /></div>
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- </div>
- <script type="text/javascript">$('#searchbox').show(0);</script>
- </div>
- </div>
- <div class="clearer"></div>
- </div>
- <div class="footer">
- ©2016, Author.
-
- |
- Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
- & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
-
- </div>
-
-
- </body>
- </html>
|