python-cement-doc 2.10.0-1 / usr / share / doc / python-cement-doc / html / api / ext / ext_genshi.html

This file is indexed.

/usr/share/doc/python-cement-doc/html/api/ext/ext_genshi.html is in python-cement-doc 2.10.0-1.

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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>cement.ext.ext_genshi &mdash; Cement 2.10.0 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="Cement 2.10.0 documentation" href="../../index.html"/>
        <link rel="up" title="API Reference" href="../index.html"/>
        <link rel="next" title="cement.ext.ext_handlebars" href="ext_handlebars.html"/>
        <link rel="prev" title="cement.ext.ext_dummy" href="ext_dummy.html"/> 

  
  <script src="../../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="../../index.html" class="icon icon-home"> Cement
          

          
          </a>

          
            
            
              <div class="version">
                2.10
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../changes.html">ChangeLog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributors.html">Contributors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../upgrading.html">Upgrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../whats_new.html">What&#8217;s New</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../projects_built_on_cement.html">Projects Built on Cement™</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Frequenty Asked Questions</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html#cement-core-modules">Cement Core Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#cement-utility-modules">Cement Utility Modules</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../index.html#cement-extension-modules">Cement Extension Modules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="ext_alarm.html"><code class="docutils literal"><span class="pre">cement.ext.ext_alarm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_argcomplete.html"><code class="docutils literal"><span class="pre">cement.ext.ext_argcomplete</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_argparse.html"><code class="docutils literal"><span class="pre">cement.ext.ext_argparse</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_colorlog.html"><code class="docutils literal"><span class="pre">cement.ext.ext_colorlog</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_configobj.html"><code class="docutils literal"><span class="pre">cement.ext.ext_configobj</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_configparser.html"><code class="docutils literal"><span class="pre">cement.ext.ext_configparser</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_daemon.html"><code class="docutils literal"><span class="pre">cement.ext.ext_daemon</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_dummy.html"><code class="docutils literal"><span class="pre">cement.ext.ext_dummy</span></code></a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">cement.ext.ext_genshi</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l4"><a class="reference internal" href="#configuration">Configuration</a></li>
<li class="toctree-l4"><a class="reference internal" href="#usage">Usage</a></li>
<li class="toctree-l4"><a class="reference internal" href="#genshi-syntax-basics">Genshi Syntax Basics</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ext_handlebars.html"><code class="docutils literal"><span class="pre">cement.ext.ext_handlebars</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_jinja2.html"><code class="docutils literal"><span class="pre">cement.ext.ext_jinja2</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_json.html"><code class="docutils literal"><span class="pre">cement.ext.ext_json</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_json_configobj.html"><code class="docutils literal"><span class="pre">cement.ext.ext_json_configobj</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_logging.html"><code class="docutils literal"><span class="pre">cement.ext.ext_logging</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_memcached.html"><code class="docutils literal"><span class="pre">cement.ext.ext_memcached</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_mustache.html"><code class="docutils literal"><span class="pre">cement.ext.ext_mustache</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_plugin.html"><code class="docutils literal"><span class="pre">cement.ext.ext_plugin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_redis.html"><code class="docutils literal"><span class="pre">cement.ext.ext_redis</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_reload_config.html"><code class="docutils literal"><span class="pre">cement.ext.ext_reload_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_smtp.html"><code class="docutils literal"><span class="pre">cement.ext.ext_smtp</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_tabulate.html"><code class="docutils literal"><span class="pre">cement.ext.ext_tabulate</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_yaml.html"><code class="docutils literal"><span class="pre">cement.ext.ext_yaml</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_yaml_configobj.html"><code class="docutils literal"><span class="pre">cement.ext.ext_yaml_configobj</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="ext_watchdog.html"><code class="docutils literal"><span class="pre">cement.ext.ext_watchdog</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer Documentation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../examples/index.html">Examples</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../../index.html">Cement</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          

 



<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../../index.html">Docs</a> &raquo;</li>
      
          <li><a href="../index.html">API Reference</a> &raquo;</li>
      
    <li><code class="docutils literal"><span class="pre">cement.ext.ext_genshi</span></code></li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../../_sources/api/ext/ext_genshi.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="cement-ext-ext-genshi">
<span id="id1"></span><h1><a class="reference internal" href="#module-cement.ext.ext_genshi" title="cement.ext.ext_genshi"><code class="xref py py-mod docutils literal"><span class="pre">cement.ext.ext_genshi</span></code></a><a class="headerlink" href="#cement-ext-ext-genshi" title="Permalink to this headline"></a></h1>
<span class="target" id="module-cement.ext.ext_genshi"></span><p>The Genshi Extension module provides output templating based on the
<a class="reference external" href="http://genshi.edgewall.org/wiki/Documentation/text-templates.html">Genshi Text Templating Language</a>.</p>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
<blockquote>
<div><ul class="simple">
<li>Genshi (<code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">genshi</span></code>)</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h2>
<p>To <strong>prepend</strong> a directory to the <code class="docutils literal"><span class="pre">template_dirs</span></code> list defined by the
application/developer, an end-user can add the configuration option
<code class="docutils literal"><span class="pre">template_dir</span></code> to their application configuration file under the main
config section:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>[myapp]
template_dir = /path/to/my/templates
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cement.core.foundation</span> <span class="kn">import</span> <span class="n">CementApp</span>

<span class="k">class</span> <span class="nc">MyApp</span><span class="p">(</span><span class="n">CementApp</span><span class="p">):</span>
    <span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
        <span class="n">label</span> <span class="o">=</span> <span class="s1">&#39;myapp&#39;</span>
        <span class="n">extensions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;genshi&#39;</span><span class="p">]</span>
        <span class="n">output_handler</span> <span class="o">=</span> <span class="s1">&#39;genshi&#39;</span>
        <span class="n">template_module</span> <span class="o">=</span> <span class="s1">&#39;myapp.templates&#39;</span>
        <span class="n">template_dirs</span> <span class="o">=</span> <span class="p">[</span>
            <span class="s1">&#39;~/.myapp/templates&#39;</span><span class="p">,</span>
            <span class="s1">&#39;/usr/lib/myapp/templates&#39;</span><span class="p">,</span>
            <span class="p">]</span>

<span class="k">with</span> <span class="n">MyApp</span><span class="p">()</span> <span class="k">as</span> <span class="n">app</span><span class="p">:</span>
    <span class="n">app</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>

    <span class="c1"># create some data</span>
    <span class="n">data</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">foo</span><span class="o">=</span><span class="s1">&#39;bar&#39;</span><span class="p">)</span>

    <span class="c1"># render the data to STDOUT (default) via a template</span>
    <span class="n">app</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="s1">&#39;my_template.genshi&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p>Note that the above <code class="docutils literal"><span class="pre">template_module</span></code> and <code class="docutils literal"><span class="pre">template_dirs</span></code> are the
auto-defined defaults but are added here for clarity.  From here, you
would then put a Genshi template file in
<code class="docutils literal"><span class="pre">myapp/templates/my_template.genshi</span></code> or
<code class="docutils literal"><span class="pre">/usr/lib/myapp/templates/my_template.genshi</span></code>.</p>
<dl class="class">
<dt id="cement.ext.ext_genshi.GenshiOutputHandler">
<em class="property">class </em><code class="descclassname">cement.ext.ext_genshi.</code><code class="descname">GenshiOutputHandler</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#cement.ext.ext_genshi.GenshiOutputHandler" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="../core/output.html#cement.core.output.TemplateOutputHandler" title="cement.core.output.TemplateOutputHandler"><code class="xref py py-class docutils literal"><span class="pre">cement.core.output.TemplateOutputHandler</span></code></a></p>
<p>This class implements the <a class="reference internal" href="../core/output.html#cement-core-output"><span class="std std-ref">IOutput</span></a>
interface.  It provides text output from template and uses the
<a class="reference external" href="http://genshi.edgewall.org/wiki/Documentation/text-templates.html">Genshi Text Templating Language</a>.
Please see the developer documentation on
<a class="reference internal" href="../../dev/output.html#dev-output-handling"><span class="std std-ref">Output Handling</span></a>.</p>
<dl class="class">
<dt id="cement.ext.ext_genshi.GenshiOutputHandler.Meta">
<em class="property">class </em><code class="descname">Meta</code><a class="headerlink" href="#cement.ext.ext_genshi.GenshiOutputHandler.Meta" 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>Handler meta-data.</p>
<dl class="attribute">
<dt id="cement.ext.ext_genshi.GenshiOutputHandler.Meta.interface">
<code class="descname">interface</code><a class="headerlink" href="#cement.ext.ext_genshi.GenshiOutputHandler.Meta.interface" title="Permalink to this definition"></a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">IOutput</span></code></p>
</dd></dl>

</dd></dl>

<dl class="method">
<dt id="cement.ext.ext_genshi.GenshiOutputHandler.render">
<code class="descclassname">GenshiOutputHandler.</code><code class="descname">render</code><span class="sig-paren">(</span><em>data_dict</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#cement.ext.ext_genshi.GenshiOutputHandler.render" title="Permalink to this definition"></a></dt>
<dd><p>Take a data dictionary and render it using the given template file.</p>
<p>Required Arguments:</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 simple">
<li><strong>data_dict</strong> &#8211; The data dictionary to render.</li>
<li><strong>template</strong> &#8211; The path to the template, after the
<code class="docutils literal"><span class="pre">template_module</span></code> or <code class="docutils literal"><span class="pre">template_dirs</span></code> prefix as defined in the
application.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">str (the rendered template text)</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="genshi-syntax-basics">
<h2>Genshi Syntax Basics<a class="headerlink" href="#genshi-syntax-basics" title="Permalink to this headline"></a></h2>
<p><strong>Printing Variables</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>Hello ${user_name}
</pre></div>
</div>
<p>Where <code class="docutils literal"><span class="pre">user_name</span></code> is a variable returned from the controller.  Will display:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>Hello Johnny
</pre></div>
</div>
<p><strong>Conditional Statements</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>{% if foo %}\\
Label: ${example.label}
{% end %}\\
</pre></div>
</div>
<p>Will only output <code class="docutils literal"><span class="pre">Label:</span> <span class="pre">&lt;label&gt;</span></code> if <code class="docutils literal"><span class="pre">foo</span> <span class="pre">==</span> <span class="pre">True</span></code>.</p>
<p><strong>For Loops</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>{% for item in items %}\\
  - ${item}
{% end %}\\
</pre></div>
</div>
<p>Where <code class="docutils literal"><span class="pre">items</span></code> is a list returned from the controller.  Will display:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>- list item 1
- list item 2
- list item 3
</pre></div>
</div>
<p><strong>Functions</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>{% def greeting(name) %}\\
Hello, ${name}!
{% end %}\\

${greeting(&#39;World&#39;)}\\
${greeting(&#39;Edward&#39;)}
</pre></div>
</div>
<p>Will output:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>Hello, World!
Hello, Edward!
</pre></div>
</div>
<p><strong>Formatted Columns</strong></p>
<div class="highlight-text"><div class="highlight"><pre><span></span>{# --------------------- 78 character baseline --------------------------- #}\\

label               ver       description
==================  ========  ================================================
{% for plugin in plugins %}\\
${&quot;%-18s&quot; % plugin[&#39;label&#39;]}  ${&quot;%-8s&quot; % plugin[&#39;version&#39;]}  ${&quot;%-48s&quot; % plugin[&#39;description&#39;]}
{% end %}
</pre></div>
</div>
<p>Output looks like:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>$ helloworld list-plugins

label               ver       description
==================  ========  ================================================
example1            1.0.34    Example plugin v1.x for helloworld
example2            2.1       Example plugin v2.x for helloworld
</pre></div>
</div>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="ext_handlebars.html" class="btn btn-neutral float-right" title="cement.ext.ext_handlebars" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="ext_dummy.html" class="btn btn-neutral" title="cement.ext.ext_dummy" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2009-2016, Data Folk Labs, LLC.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../../',
            VERSION:'2.10.0',
            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>

  

  
  
    <script type="text/javascript" src="../../_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>

APT Browse - Built by Thomas Orozco.