<!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="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>django.template.loader — Django 1.8.19 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.8.19',
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="Django 1.8.19 documentation" href="../../../contents.html" />
<link rel="up" title="django" href="../../django.html" />
<script type="text/javascript" src="../../../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "../../../ref/templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body role="document">
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../../../index.html">Django 1.8.19 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../../../index.html">Home</a> |
<a title="Table of contents" href="../../../contents.html">Table of contents</a> |
<a title="Global index" href="../../../genindex.html">Index</a> |
<a title="Module index" href="../../../py-modindex.html">Modules</a>
</div>
<div class="nav">
<a href="../../index.html" title="Module code" accesskey="U">up</a></div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="_modules-django-template-loader">
<h1>Source code for django.template.loader</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">from</span> <span class="nn">django.utils.deprecation</span> <span class="k">import</span> <span class="n">RemovedInDjango110Warning</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">engines</span>
<span class="kn">from</span> <span class="nn">.backends.django</span> <span class="k">import</span> <span class="n">DjangoTemplates</span>
<span class="kn">from</span> <span class="nn">.base</span> <span class="k">import</span> <span class="n">Origin</span><span class="p">,</span> <span class="n">TemplateDoesNotExist</span>
<span class="kn">from</span> <span class="nn">.engine</span> <span class="k">import</span> <span class="p">(</span>
<span class="n">_context_instance_undefined</span><span class="p">,</span> <span class="n">_dictionary_undefined</span><span class="p">,</span> <span class="n">_dirs_undefined</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">.loaders</span> <span class="k">import</span> <span class="n">base</span>
<span class="k">class</span> <span class="nc">LoaderOrigin</span><span class="p">(</span><span class="n">Origin</span><span class="p">):</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">display_name</span><span class="p">,</span> <span class="n">loader</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">dirs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">LoaderOrigin</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">display_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loader</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">loadname</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dirs</span> <span class="o">=</span> <span class="n">loader</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">dirs</span>
<span class="k">def</span> <span class="nf">reload</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">loader</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">loadname</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dirs</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<div class="viewcode-block" id="get_template"><a class="viewcode-back" href="../../../topics/templates.html#django.template.get_template">[docs]</a><span class="k">def</span> <span class="nf">get_template</span><span class="p">(</span><span class="n">template_name</span><span class="p">,</span> <span class="n">dirs</span><span class="o">=</span><span class="n">_dirs_undefined</span><span class="p">,</span> <span class="n">using</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Loads and returns a template for the given name.</span>
<span class="sd"> Raises TemplateDoesNotExist if no such template exists.</span>
<span class="sd"> """</span>
<span class="n">engines</span> <span class="o">=</span> <span class="n">_engine_list</span><span class="p">(</span><span class="n">using</span><span class="p">)</span>
<span class="k">for</span> <span class="n">engine</span> <span class="ow">in</span> <span class="n">engines</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># This is required for deprecating the dirs argument. Simply</span>
<span class="c1"># return engine.get_template(template_name) in Django 1.10.</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">DjangoTemplates</span><span class="p">):</span>
<span class="k">return</span> <span class="n">engine</span><span class="o">.</span><span class="n">get_template</span><span class="p">(</span><span class="n">template_name</span><span class="p">,</span> <span class="n">dirs</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">dirs</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_dirs_undefined</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"Skipping template backend </span><span class="si">%s</span><span class="s2"> because its get_template "</span>
<span class="s2">"method doesn't support the dirs argument."</span> <span class="o">%</span> <span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
<span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">engine</span><span class="o">.</span><span class="n">get_template</span><span class="p">(</span><span class="n">template_name</span><span class="p">)</span>
<span class="k">except</span> <span class="n">TemplateDoesNotExist</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">raise</span> <span class="n">TemplateDoesNotExist</span><span class="p">(</span><span class="n">template_name</span><span class="p">)</span></div>
<div class="viewcode-block" id="select_template"><a class="viewcode-back" href="../../../topics/templates.html#django.template.select_template">[docs]</a><span class="k">def</span> <span class="nf">select_template</span><span class="p">(</span><span class="n">template_name_list</span><span class="p">,</span> <span class="n">dirs</span><span class="o">=</span><span class="n">_dirs_undefined</span><span class="p">,</span> <span class="n">using</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Loads and returns a template for one of the given names.</span>
<span class="sd"> Tries names in order and returns the first template found.</span>
<span class="sd"> Raises TemplateDoesNotExist if no such template exists.</span>
<span class="sd"> """</span>
<span class="n">engines</span> <span class="o">=</span> <span class="n">_engine_list</span><span class="p">(</span><span class="n">using</span><span class="p">)</span>
<span class="k">for</span> <span class="n">template_name</span> <span class="ow">in</span> <span class="n">template_name_list</span><span class="p">:</span>
<span class="k">for</span> <span class="n">engine</span> <span class="ow">in</span> <span class="n">engines</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># This is required for deprecating the dirs argument. Simply</span>
<span class="c1"># use engine.get_template(template_name) in Django 1.10.</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">DjangoTemplates</span><span class="p">):</span>
<span class="k">return</span> <span class="n">engine</span><span class="o">.</span><span class="n">get_template</span><span class="p">(</span><span class="n">template_name</span><span class="p">,</span> <span class="n">dirs</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">dirs</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_dirs_undefined</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"Skipping template backend </span><span class="si">%s</span><span class="s2"> because its get_template "</span>
<span class="s2">"method doesn't support the dirs argument."</span> <span class="o">%</span> <span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
<span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">engine</span><span class="o">.</span><span class="n">get_template</span><span class="p">(</span><span class="n">template_name</span><span class="p">)</span>
<span class="k">except</span> <span class="n">TemplateDoesNotExist</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">if</span> <span class="n">template_name_list</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">TemplateDoesNotExist</span><span class="p">(</span><span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">template_name_list</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">TemplateDoesNotExist</span><span class="p">(</span><span class="s2">"No template names provided"</span><span class="p">)</span></div>
<div class="viewcode-block" id="render_to_string"><a class="viewcode-back" href="../../../topics/templates.html#django.template.render_to_string">[docs]</a><span class="k">def</span> <span class="nf">render_to_string</span><span class="p">(</span><span class="n">template_name</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">context_instance</span><span class="o">=</span><span class="n">_context_instance_undefined</span><span class="p">,</span>
<span class="n">dirs</span><span class="o">=</span><span class="n">_dirs_undefined</span><span class="p">,</span>
<span class="n">dictionary</span><span class="o">=</span><span class="n">_dictionary_undefined</span><span class="p">,</span>
<span class="n">request</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">using</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Loads a template and renders it with a context. Returns a string.</span>
<span class="sd"> template_name may be a string or a list of strings.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="p">(</span><span class="n">context_instance</span> <span class="ow">is</span> <span class="n">_context_instance_undefined</span>
<span class="ow">and</span> <span class="n">dirs</span> <span class="ow">is</span> <span class="n">_dirs_undefined</span>
<span class="ow">and</span> <span class="n">dictionary</span> <span class="ow">is</span> <span class="n">_dictionary_undefined</span><span class="p">):</span>
<span class="c1"># No deprecated arguments were passed - use the new code path</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">template_name</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">template</span> <span class="o">=</span> <span class="n">select_template</span><span class="p">(</span><span class="n">template_name</span><span class="p">,</span> <span class="n">using</span><span class="o">=</span><span class="n">using</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">template</span> <span class="o">=</span> <span class="n">get_template</span><span class="p">(</span><span class="n">template_name</span><span class="p">,</span> <span class="n">using</span><span class="o">=</span><span class="n">using</span><span class="p">)</span>
<span class="k">return</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">request</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Some deprecated arguments were passed - use the legacy code path</span>
<span class="k">for</span> <span class="n">engine</span> <span class="ow">in</span> <span class="n">_engine_list</span><span class="p">(</span><span class="n">using</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># This is required for deprecating properly arguments specific</span>
<span class="c1"># to Django templates. Remove Engine.render_to_string() at the</span>
<span class="c1"># same time as this code path in Django 1.10.</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">DjangoTemplates</span><span class="p">):</span>
<span class="k">if</span> <span class="n">request</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"render_to_string doesn't support the request argument "</span>
<span class="s2">"when some deprecated arguments are passed."</span><span class="p">)</span>
<span class="c1"># Hack -- use the internal Engine instance of DjangoTemplates.</span>
<span class="k">return</span> <span class="n">engine</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">render_to_string</span><span class="p">(</span>
<span class="n">template_name</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">context_instance</span><span class="p">,</span> <span class="n">dirs</span><span class="p">,</span> <span class="n">dictionary</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">context_instance</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_context_instance_undefined</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"Skipping template backend </span><span class="si">%s</span><span class="s2"> because its render_to_string "</span>
<span class="s2">"method doesn't support the context_instance argument."</span> <span class="o">%</span>
<span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">dirs</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_dirs_undefined</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"Skipping template backend </span><span class="si">%s</span><span class="s2"> because its render_to_string "</span>
<span class="s2">"method doesn't support the dirs argument."</span> <span class="o">%</span> <span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
<span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">dictionary</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_dictionary_undefined</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"Skipping template backend </span><span class="si">%s</span><span class="s2"> because its render_to_string "</span>
<span class="s2">"method doesn't support the dictionary argument."</span> <span class="o">%</span>
<span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="k">except</span> <span class="n">TemplateDoesNotExist</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">template_name</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">template_name</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">template_name</span> <span class="o">=</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">template_name</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">TemplateDoesNotExist</span><span class="p">(</span><span class="n">template_name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">TemplateDoesNotExist</span><span class="p">(</span><span class="s2">"No template names provided"</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_engine_list</span><span class="p">(</span><span class="n">using</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">return</span> <span class="n">engines</span><span class="o">.</span><span class="n">all</span><span class="p">()</span> <span class="k">if</span> <span class="n">using</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="p">[</span><span class="n">engines</span><span class="p">[</span><span class="n">using</span><span class="p">]]</span>
<span class="k">class</span> <span class="nc">BaseLoader</span><span class="p">(</span><span class="n">base</span><span class="o">.</span><span class="n">Loader</span><span class="p">):</span>
<span class="n">_accepts_engine_in_init</span> <span class="o">=</span> <span class="kc">False</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"django.template.loader.BaseLoader was superseded by "</span>
<span class="s2">"django.template.loaders.base.Loader."</span><span class="p">,</span>
<span class="n">RemovedInDjango110Warning</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BaseLoader</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Browse</h3>
<ul>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../../../index.html">Django 1.8.19 documentation</a>
<ul><li><a href="../../index.html">Module code</a>
<ul><li><a href="../../django.html">django</a>
<ul><li>django.template.loader</li></ul>
</li></ul></li></ul>
</li>
</ul>
<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>
<h3>Last update:</h3>
<p class="topless">Mar 10, 2018</p>
</div>
</div>
<div id="ft">
<div class="nav">
<a href="../../index.html" title="Module code" accesskey="U">up</a></div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
65530c6176058f9b54858c3b4f6385e6
>
files
>
135
