templating.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>flask.templating &#8212; proxypool documentation</title>
  7. <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  8. <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../../',
  12. VERSION: '',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../../_static/jquery.js"></script>
  19. <script type="text/javascript" src="../../_static/underscore.js"></script>
  20. <script type="text/javascript" src="../../_static/doctools.js"></script>
  21. <link rel="index" title="Index" href="../../genindex.html" />
  22. <link rel="search" title="Search" href="../../search.html" />
  23. <link rel="top" title="proxypool documentation" href="../../index.html" />
  24. <link rel="up" title="Module code" href="../index.html" />
  25. <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  26. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  27. </head>
  28. <body role="document">
  29. <div class="document">
  30. <div class="documentwrapper">
  31. <div class="bodywrapper">
  32. <div class="body" role="main">
  33. <h1>Source code for flask.templating</h1><div class="highlight"><pre>
  34. <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
  35. <span class="sd">&quot;&quot;&quot;</span>
  36. <span class="sd"> flask.templating</span>
  37. <span class="sd"> ~~~~~~~~~~~~~~~~</span>
  38. <span class="sd"> Implements the bridge to Jinja2.</span>
  39. <span class="sd"> :copyright: (c) 2015 by Armin Ronacher.</span>
  40. <span class="sd"> :license: BSD, see LICENSE for more details.</span>
  41. <span class="sd">&quot;&quot;&quot;</span>
  42. <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> \
  43. <span class="n">TemplateNotFound</span>
  44. <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>
  45. <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>
  46. <span class="k">def</span> <span class="nf">_default_template_ctx_processor</span><span class="p">():</span>
  47. <span class="sd">&quot;&quot;&quot;Default template context processor. Injects `request`,</span>
  48. <span class="sd"> `session` and `g`.</span>
  49. <span class="sd"> &quot;&quot;&quot;</span>
  50. <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>
  51. <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>
  52. <span class="n">rv</span> <span class="o">=</span> <span class="p">{}</span>
  53. <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>
  54. <span class="n">rv</span><span class="p">[</span><span class="s1">&#39;g&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">appctx</span><span class="o">.</span><span class="n">g</span>
  55. <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>
  56. <span class="n">rv</span><span class="p">[</span><span class="s1">&#39;request&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">reqctx</span><span class="o">.</span><span class="n">request</span>
  57. <span class="n">rv</span><span class="p">[</span><span class="s1">&#39;session&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">reqctx</span><span class="o">.</span><span class="n">session</span>
  58. <span class="k">return</span> <span class="n">rv</span>
  59. <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>
  60. <span class="sd">&quot;&quot;&quot;Works like a regular Jinja2 environment but has some additional</span>
  61. <span class="sd"> knowledge of how Flask&#39;s blueprint works so that it can prepend the</span>
  62. <span class="sd"> name of the blueprint to referenced templates if necessary.</span>
  63. <span class="sd"> &quot;&quot;&quot;</span>
  64. <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>
  65. <span class="k">if</span> <span class="s1">&#39;loader&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
  66. <span class="n">options</span><span class="p">[</span><span class="s1">&#39;loader&#39;</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>
  67. <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>
  68. <span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">app</span></div>
  69. <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>
  70. <span class="sd">&quot;&quot;&quot;A loader that looks for templates in the application and all</span>
  71. <span class="sd"> the blueprint folders.</span>
  72. <span class="sd"> &quot;&quot;&quot;</span>
  73. <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>
  74. <span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">app</span>
  75. <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>
  76. <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">&#39;EXPLAIN_TEMPLATE_LOADING&#39;</span><span class="p">]:</span>
  77. <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>
  78. <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>
  79. <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>
  80. <span class="n">attempts</span> <span class="o">=</span> <span class="p">[]</span>
  81. <span class="n">trv</span> <span class="o">=</span> <span class="kc">None</span>
  82. <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>
  83. <span class="k">try</span><span class="p">:</span>
  84. <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>
  85. <span class="k">if</span> <span class="n">trv</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  86. <span class="n">trv</span> <span class="o">=</span> <span class="n">rv</span>
  87. <span class="k">except</span> <span class="n">TemplateNotFound</span><span class="p">:</span>
  88. <span class="n">rv</span> <span class="o">=</span> <span class="kc">None</span>
  89. <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>
  90. <span class="kn">from</span> <span class="nn">.debughelpers</span> <span class="k">import</span> <span class="n">explain_template_loading_attempts</span>
  91. <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>
  92. <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>
  93. <span class="k">return</span> <span class="n">trv</span>
  94. <span class="k">raise</span> <span class="n">TemplateNotFound</span><span class="p">(</span><span class="n">template</span><span class="p">)</span>
  95. <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>
  96. <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>
  97. <span class="k">try</span><span class="p">:</span>
  98. <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>
  99. <span class="k">except</span> <span class="n">TemplateNotFound</span><span class="p">:</span>
  100. <span class="k">continue</span>
  101. <span class="k">raise</span> <span class="n">TemplateNotFound</span><span class="p">(</span><span class="n">template</span><span class="p">)</span>
  102. <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>
  103. <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>
  104. <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>
  105. <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>
  106. <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>
  107. <span class="n">loader</span> <span class="o">=</span> <span class="n">blueprint</span><span class="o">.</span><span class="n">jinja_loader</span>
  108. <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>
  109. <span class="k">yield</span> <span class="n">blueprint</span><span class="p">,</span> <span class="n">loader</span>
  110. <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>
  111. <span class="n">result</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
  112. <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>
  113. <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>
  114. <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>
  115. <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>
  116. <span class="n">loader</span> <span class="o">=</span> <span class="n">blueprint</span><span class="o">.</span><span class="n">jinja_loader</span>
  117. <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>
  118. <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>
  119. <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>
  120. <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>
  121. <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>
  122. <span class="sd">&quot;&quot;&quot;Renders the template and fires the signal&quot;&quot;&quot;</span>
  123. <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>
  124. <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>
  125. <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>
  126. <span class="k">return</span> <span class="n">rv</span>
  127. <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>
  128. <span class="sd">&quot;&quot;&quot;Renders a template from the template folder with the given</span>
  129. <span class="sd"> context.</span>
  130. <span class="sd"> :param template_name_or_list: the name of the template to be</span>
  131. <span class="sd"> rendered, or an iterable with template names</span>
  132. <span class="sd"> the first one existing will be rendered</span>
  133. <span class="sd"> :param context: the variables that should be available in the</span>
  134. <span class="sd"> context of the template.</span>
  135. <span class="sd"> &quot;&quot;&quot;</span>
  136. <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>
  137. <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>
  138. <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>
  139. <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>
  140. <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>
  141. <span class="sd">&quot;&quot;&quot;Renders a template from the given template source string</span>
  142. <span class="sd"> with the given context. Template variables will be autoescaped.</span>
  143. <span class="sd"> :param source: the source code of the template to be</span>
  144. <span class="sd"> rendered</span>
  145. <span class="sd"> :param context: the variables that should be available in the</span>
  146. <span class="sd"> context of the template.</span>
  147. <span class="sd"> &quot;&quot;&quot;</span>
  148. <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>
  149. <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>
  150. <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>
  151. <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>
  152. </pre></div>
  153. </div>
  154. </div>
  155. </div>
  156. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  157. <div class="sphinxsidebarwrapper"><div class="relations">
  158. <h3>Related Topics</h3>
  159. <ul>
  160. <li><a href="../../index.html">Documentation overview</a><ul>
  161. <li><a href="../index.html">Module code</a><ul>
  162. </ul></li>
  163. </ul></li>
  164. </ul>
  165. </div>
  166. <div id="searchbox" style="display: none" role="search">
  167. <h3>Quick search</h3>
  168. <form class="search" action="../../search.html" method="get">
  169. <div><input type="text" name="q" /></div>
  170. <div><input type="submit" value="Go" /></div>
  171. <input type="hidden" name="check_keywords" value="yes" />
  172. <input type="hidden" name="area" value="default" />
  173. </form>
  174. </div>
  175. <script type="text/javascript">$('#searchbox').show(0);</script>
  176. </div>
  177. </div>
  178. <div class="clearer"></div>
  179. </div>
  180. <div class="footer">
  181. &copy;2016, Author.
  182. |
  183. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
  184. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
  185. </div>
  186. </body>
  187. </html>