/usr/share/doc/python-pecan-doc/html/pecan_templating.html is in python-pecan-doc 1.2.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | <!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">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>pecan.templating – Pecan Templating — Pecan 1.2.1 documentation</title>
<link rel="stylesheet" href="_static/nature.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.2.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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="next" title="pecan.testing – Pecan Testing" href="pecan_testing.html" />
<link rel="prev" title="pecan.secure – Pecan Secure Controllers" href="pecan_secure.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pecan_testing.html" title="pecan.testing – Pecan Testing"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pecan_secure.html" title="pecan.secure – Pecan Secure Controllers"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Pecan 1.2.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="pecan-templating-pecan-templating">
<span id="pecan-templating"></span><h1><a class="reference internal" href="#module-pecan.templating" title="pecan.templating"><code class="xref py py-mod docutils literal"><span class="pre">pecan.templating</span></code></a> – Pecan Templating<a class="headerlink" href="#pecan-templating-pecan-templating" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference internal" href="#module-pecan.templating" title="pecan.templating"><code class="xref py py-mod docutils literal"><span class="pre">pecan.templating</span></code></a> module includes support for a variety of
templating engines, plus the ability to create your own template
engines.</p>
<span class="target" id="module-pecan.templating"></span><dl class="class">
<dt id="pecan.templating.ExtraNamespace">
<em class="property">class </em><code class="descclassname">pecan.templating.</code><code class="descname">ExtraNamespace</code><span class="sig-paren">(</span><em>extras={}</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.ExtraNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Extra variables for the template namespace to pass to the renderer as named
parameters.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>extras</strong> – dictionary of extra parameters. Defaults to an empty dict.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pecan.templating.ExtraNamespace.make_ns">
<code class="descname">make_ns</code><span class="sig-paren">(</span><em>ns</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.ExtraNamespace.make_ns" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the <cite>lazily</cite> created template namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pecan.templating.ExtraNamespace.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>d</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.ExtraNamespace.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the extra variable dictionary for the namespace.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pecan.templating.GenshiRenderer">
<em class="property">class </em><code class="descclassname">pecan.templating.</code><code class="descname">GenshiRenderer</code><span class="sig-paren">(</span><em>path</em>, <em>extra_vars</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.GenshiRenderer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Defines the builtin <code class="docutils literal"><span class="pre">Genshi</span></code> renderer.</p>
<dl class="method">
<dt id="pecan.templating.GenshiRenderer.render">
<code class="descname">render</code><span class="sig-paren">(</span><em>template_path</em>, <em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.GenshiRenderer.render" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements <code class="docutils literal"><span class="pre">Genshi</span></code> rendering.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pecan.templating.JinjaRenderer">
<em class="property">class </em><code class="descclassname">pecan.templating.</code><code class="descname">JinjaRenderer</code><span class="sig-paren">(</span><em>path</em>, <em>extra_vars</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.JinjaRenderer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Defines the builtin <code class="docutils literal"><span class="pre">Jinja</span></code> renderer.</p>
<dl class="method">
<dt id="pecan.templating.JinjaRenderer.render">
<code class="descname">render</code><span class="sig-paren">(</span><em>template_path</em>, <em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.JinjaRenderer.render" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements <code class="docutils literal"><span class="pre">Jinja</span></code> rendering.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pecan.templating.JsonRenderer">
<em class="property">class </em><code class="descclassname">pecan.templating.</code><code class="descname">JsonRenderer</code><span class="sig-paren">(</span><em>path</em>, <em>extra_vars</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.JsonRenderer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Defines the builtin <code class="docutils literal"><span class="pre">JSON</span></code> renderer.</p>
<dl class="method">
<dt id="pecan.templating.JsonRenderer.render">
<code class="descname">render</code><span class="sig-paren">(</span><em>template_path</em>, <em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.JsonRenderer.render" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements <code class="docutils literal"><span class="pre">JSON</span></code> rendering.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pecan.templating.KajikiRenderer">
<em class="property">class </em><code class="descclassname">pecan.templating.</code><code class="descname">KajikiRenderer</code><span class="sig-paren">(</span><em>path</em>, <em>extra_vars</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.KajikiRenderer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Defines the builtin <code class="docutils literal"><span class="pre">Kajiki</span></code> renderer.</p>
<dl class="method">
<dt id="pecan.templating.KajikiRenderer.render">
<code class="descname">render</code><span class="sig-paren">(</span><em>template_path</em>, <em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.KajikiRenderer.render" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements <code class="docutils literal"><span class="pre">Kajiki</span></code> rendering.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pecan.templating.MakoRenderer">
<em class="property">class </em><code class="descclassname">pecan.templating.</code><code class="descname">MakoRenderer</code><span class="sig-paren">(</span><em>path</em>, <em>extra_vars</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.MakoRenderer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Defines the builtin <code class="docutils literal"><span class="pre">Mako</span></code> renderer.</p>
<dl class="method">
<dt id="pecan.templating.MakoRenderer.render">
<code class="descname">render</code><span class="sig-paren">(</span><em>template_path</em>, <em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.MakoRenderer.render" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements <code class="docutils literal"><span class="pre">Mako</span></code> rendering.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pecan.templating.RendererFactory">
<em class="property">class </em><code class="descclassname">pecan.templating.</code><code class="descname">RendererFactory</code><span class="sig-paren">(</span><em>custom_renderers={}</em>, <em>extra_vars={}</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.RendererFactory" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Manufactures known Renderer objects.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>custom_renderers</strong> – custom-defined renderers to manufacture</li>
<li><strong>extra_vars</strong> – extra vars for the template namespace</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pecan.templating.RendererFactory.add_renderers">
<code class="descname">add_renderers</code><span class="sig-paren">(</span><em>custom_dict</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.RendererFactory.add_renderers" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a custom renderer.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>custom_dict</strong> – a dictionary of custom renderers to add</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pecan.templating.RendererFactory.available">
<code class="descname">available</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.RendererFactory.available" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if queried renderer class is available.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – renderer name</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pecan.templating.RendererFactory.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>name</em>, <em>template_path</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.RendererFactory.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the renderer object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – name of the requested renderer</li>
<li><strong>template_path</strong> – path to the template</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pecan.templating.format_genshi_error">
<code class="descclassname">pecan.templating.</code><code class="descname">format_genshi_error</code><span class="sig-paren">(</span><em>exc_value</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.format_genshi_error" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements <code class="docutils literal"><span class="pre">Genshi</span></code> renderer error formatting.</p>
</dd></dl>
<dl class="function">
<dt id="pecan.templating.format_jinja_error">
<code class="descclassname">pecan.templating.</code><code class="descname">format_jinja_error</code><span class="sig-paren">(</span><em>exc_value</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.format_jinja_error" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements <code class="docutils literal"><span class="pre">Jinja</span></code> renderer error formatting.</p>
</dd></dl>
<dl class="function">
<dt id="pecan.templating.format_line_context">
<code class="descclassname">pecan.templating.</code><code class="descname">format_line_context</code><span class="sig-paren">(</span><em>filename</em>, <em>lineno</em>, <em>context=10</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.format_line_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Formats the the line context for error rendering.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>filename</strong> – the location of the file, within which the error occurred</li>
<li><strong>lineno</strong> – the offending line number</li>
<li><strong>context</strong> – number of lines of code to display before and after the
offending line.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pecan.templating.format_mako_error">
<code class="descclassname">pecan.templating.</code><code class="descname">format_mako_error</code><span class="sig-paren">(</span><em>exc_value</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.templating.format_mako_error" title="Permalink to this definition">¶</a></dt>
<dd><p>Implements <code class="docutils literal"><span class="pre">Mako</span></code> renderer error formatting.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="pecan_secure.html"
title="previous chapter"><code class="docutils literal"><span class="pre">pecan.secure</span></code> – Pecan Secure Controllers</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pecan_testing.html"
title="next chapter"><code class="docutils literal"><span class="pre">pecan.testing</span></code> – Pecan Testing</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pecan_templating.rst.txt"
rel="nofollow">Show Source</a></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="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pecan_testing.html" title="pecan.testing – Pecan Testing"
>next</a> |</li>
<li class="right" >
<a href="pecan_secure.html" title="pecan.secure – Pecan Secure Controllers"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Pecan 1.2.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2018, Jonathan LaCour.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
|