python-kid 0.9.6-3 / usr / share / doc / python-kid / html / class-kid.BaseTemplate.html

This file is indexed.

/usr/share/doc/python-kid/html/class-kid.BaseTemplate.html is in python-kid 0.9.6-3.

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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<HTML>
  
  <HEAD><META CONTENT="text/html; charset=utf-8" HTTP-EQUIV="Content-Type">
    <TITLE>kid.BaseTemplate -- Base class for compiled Templates.</TITLE>
    <LINK HREF="layout.css" TYPE="text/css" REL="stylesheet">
    <LINK HREF="http://planet.kid-templating.org/rss20.xml" TYPE="application/rss+xml" REL="alternate" TITLE="RSS 2.0">

  </HEAD>
  <BODY>
    <DIV ID="page">
      <H1 CLASS="doc-title"><A HREF="http://www.kid-templating.org/">kid-templating.org</A></H1>
      <DIV ID="navcontainer">
        <UL ID="navlist">
          <LI CLASS="pagenav">
            <UL>
              <LI CLASS="page_item">
                <A HREF="index.html" CLASS="" TITLE="Project Home / Index">Kid</A>
              </LI>
              <LI CLASS="page_item">
                <A HREF="module-index.html" CLASS="" TITLE="kid package and module reference">Modules</A>
              </LI>
              
              <LI>
                <A HREF="http://www.kid-templating.org/trac/" TITLE="Wiki / Subversion / Roadmap / Bug Tracker">Trac</A>
              </LI>
              <LI>
                <A HREF="http://planet.kid-templating.org/">Blog</A>
              </LI>
              <LI>
                <A HREF="http://lists.sourceforge.net/lists/listinfo/kid-template-discuss" CLASS="" TITLE="Mailing List">Discuss</A>
              </LI>
              <LI CLASS="page_item">
                <A HREF="http://www.kid-templating.org/about">
                  about kid-templating.org
                </A>
              </LI>
            </UL>
          </LI>
        </UL>
      </DIV>
      
      <HR>
      
      <DIV ID="content">
  
  <H1 CLASS="pudge-member-page-heading">
    <TT>BaseTemplate</TT>
  </H1>
  <H4 CLASS="pudge-member-page-subheading">
    Base class for compiled Templates.
  </H4>
  <P CLASS="pudge-member-parent-link">
    <SMALL>
    The BaseTemplate class is accessible via the
    <A HREF="module-kid.html">
      <TT>kid</TT>
    </A> module.
    </SMALL>
  </P>
  <DIV ID="pudge-section-nav">
  <UL>
    <LI>
      <A HREF="#attributes" CLASS="pudge-section-link">
        Attributes (1)
      </A>
      
    </LI><LI>
      <A HREF="#methods" CLASS="pudge-section-link">
        Methods (12)
      </A>
      
    </LI>
    
    <LI>
      <A HREF="kid/__init__.py.html?f=169&amp;l=367#169" CLASS="pudge-section-link">
        Source
      </A>
    </LI>
  </UL>
  </DIV>
  <DIV STYLE="clear: left"></DIV>
  <DIV CLASS="rst pudge-module-doc">
    <P>All kid template modules expose a class named <TT CLASS="docutils literal"><SPAN CLASS="pre">Template</SPAN></TT> that
extends from this class making the methods defined here available on
all Template subclasses.</P>
<P>This class should not be instantiated directly.</P>

  </DIV>
  
  <HR>
  
  
    <A NAME="attributes"></A>
    <H2>Attributes</H2>
    <DIV CLASS="pudge-member name">
    <A NAME="serializer"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">a</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#serializer" CLASS="pudge-obj-link">serializer</A></TT></H4>
    <DIV CLASS="pudge-section rst">
      
      <PRE>&lt;kid.serialization.XMLSerializer object at 0xb77cad8c></PRE>
    </DIV>
  </DIV>
    
  
    <A NAME="methods"></A>
    <H2>Methods</H2>
    <DIV CLASS="pudge-member routine ">
    <A NAME="__init__"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#__init__" CLASS="pudge-obj-link">__init__</A>(self)</TT>
      <A HREF="kid/__init__.py.html?f=184&amp;l=194#184" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    <P CLASS="pudge-member-blurb">
      Initialize a template with instance attributes specified by
keyword arguments.
    </P>
    <P>Keyword arguments are available to the template using self.var
notation.</P>

  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="write"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#write" CLASS="pudge-obj-link">write</A>(self, file, encoding=None, fragment=0, output=None)</TT>
      <A HREF="kid/__init__.py.html?f=195&amp;l=214#195" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    <P CLASS="pudge-member-blurb">
      Execute template and write output to file.
    </P>
    <DL CLASS="docutils">
<DT><A HREF="file:file" CLASS="reference">file:file</A></DT>
<DD>A filename or a file like object (must support write()).</DD>
<DT>encoding:string</DT>
<DD>The output encoding. Default: utf-8.</DD>
<DT>fragment:bool</DT>
<DD>Controls whether prologue information (such as &lt;?xml?>
declaration and DOCTYPE should be written). Set to 1
when generating fragments meant to be inserted into
existing XML documents.</DD>
<DT>output:string,`Serializer`</DT>
<DD>A string specifying an output method ('xml', 'html',
'xhtml') or a Serializer object.</DD>
</DL>

  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="serialize"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#serialize" CLASS="pudge-obj-link">serialize</A>(self, encoding=None, fragment=0, output=None)</TT>
      <A HREF="kid/__init__.py.html?f=215&amp;l=237#215" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    <P CLASS="pudge-member-blurb">
      Execute a template and return a single string.
    </P>
    <DL CLASS="docutils">
<DT>encoding</DT>
<DD>The output encoding. Default: utf-8.</DD>
<DT>fragment</DT>
<DD>Controls whether prologue information (such as &lt;?xml?>
declaration and DOCTYPE should be written). Set to 1
when generating fragments meant to be inserted into
existing XML documents.</DD>
<DT>output</DT>
<DD>A string specifying an output method ('xml', 'html',
'xhtml') or a Serializer object.</DD>
</DL>
<P>This is a convienence method, roughly equivalent to:</P>
<PRE CLASS="literal-block">
''.join([x for x in obj.generate(encoding, fragment, output)]
</PRE>

  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="generate"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#generate" CLASS="pudge-obj-link">generate</A>(self, encoding=None, fragment=0, output=None)</TT>
      <A HREF="kid/__init__.py.html?f=238&amp;l=259#238" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    <P CLASS="pudge-member-blurb">
      Execute template and generate serialized output incrementally.
    </P>
    <P>This method returns an iterator that yields an encoded string
for each iteration. The iteration ends when the template is done
executing.</P>
<DL CLASS="docutils">
<DT>encoding</DT>
<DD>The output encoding. Default: utf-8.</DD>
<DT>fragment</DT>
<DD>Controls whether prologue information (such as &lt;?xml?>
declaration and DOCTYPE should be written). Set to 1
when generating fragments meant to be inserted into
existing XML documents.</DD>
<DT>output</DT>
<DD>A string specifying an output method ('xml', 'html',
'xhtml') or a Serializer object.</DD>
</DL>

  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="__iter__"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#__iter__" CLASS="pudge-obj-link">__iter__</A>(self)</TT>
      <A HREF="kid/__init__.py.html?f=260&amp;l=262#260" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    
    
  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="__unicode__"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#__unicode__" CLASS="pudge-obj-link">__unicode__</A>(self)</TT>
      <A HREF="kid/__init__.py.html?f=266&amp;l=268#266" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    
    
  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="initialize"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#initialize" CLASS="pudge-obj-link">initialize</A>(self)</TT>
      <A HREF="kid/__init__.py.html?f=269&amp;l=271#269" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    
    
  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="pull"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#pull" CLASS="pudge-obj-link">pull</A>(self)</TT>
      <A HREF="kid/__init__.py.html?f=272&amp;l=278#272" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    <P CLASS="pudge-member-blurb">
      Returns an iterator over the items in this template.
    </P>
    
  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="content"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#content" CLASS="pudge-obj-link">content</A>(self)</TT>
      <A HREF="kid/__init__.py.html?f=286&amp;l=296#286" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    
    
  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="transform"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#transform" CLASS="pudge-obj-link">transform</A>(self, stream=None, filters=[])</TT>
      <A HREF="kid/__init__.py.html?f=297&amp;l=329#297" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    <P CLASS="pudge-member-blurb">
      Execute the template and apply any match transformations.
    </P>
    <P>If stream is specified, it must be one of the following:</P>
<DL CLASS="docutils">
<DT>Element</DT>
<DD>An ElementTree Element.</DD>
<DT>ElementStream</DT>
<DD>An 
    
    <A HREF="class-kid.pull.ElementStream.html" CLASS="obj-link class" TITLE="kid.pull.ElementStream - Provides a pull/streaming interface to ElementTree.">
      <TT>pull.ElementStream</TT></A>
    
   instance or other iterator that yields
stream events.</DD>
<DT>string</DT>
<DD>A file or URL unless the string starts with
'&lt;' in which case it is considered an XML document
and processed as if it had been an Element.</DD>
</DL>
<P>By default, the 
    
    <A HREF="class-kid.BaseTemplate.html#pull" CLASS="obj-link routine" TITLE="kid.BaseTemplate.pull - Returns an iterator over the items in this template.">
      <TT>pull</TT></A>
    
   method is called to obtain the stream.</P>

  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="defined"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#defined" CLASS="pudge-obj-link">defined</A>(self, name)</TT>
      <A HREF="kid/__init__.py.html?f=362&amp;l=364#362" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    
    
  
    </DIV>
  </DIV><DIV CLASS="pudge-member routine ">
    <A NAME="value_of"></A>
    <H4 CLASS="pudge-member-name"><SPAN CLASS="prefix">f</SPAN>
      <TT><A HREF="class-kid.BaseTemplate.html#value_of" CLASS="pudge-obj-link">value_of</A>(self, name, default=None)</TT>
      <A HREF="kid/__init__.py.html?f=365&amp;l=367#365" TITLE="View Source">...</A>
    </H4>
    <DIV CLASS="pudge-section rst">
      
    
    
  
    </DIV>
  </DIV>
    
  
  
  <P>
    <SMALL>
    
    
    See 
    <A HREF="kid/__init__.py.html?f=169&amp;l=367#169" TITLE="kid/__init__.py:169">the source</A>
    for more information.
    </SMALL>
  </P>

</DIV>
      
      <DIV ID="footer">
        
        
        <P STYLE="float: left;">
          
          This documentation is licensed under the 
          <A HREF="doc-license.html" TITLE="Documentation License">GNU Free Documentation License</A>
          <BR>
          
          built with 
          <A HREF="http://lesscode.org/projects/pudge/">pudge/0.1.1</A><BR>
		      original design by 
          <A HREF="http://blog.ratterobert.com/">ratter / robert</A><BR>
	      </P>
        <DIV>
        <BR>
        <A NAME="search">
          <FORM ACTION="http://lesscode.org/blog/index.php" METHOD="get" ID="searchform">
            <DIV>
              <INPUT TYPE="text" NAME="s" VALUE="" ID="s">
              <INPUT TYPE="submit" ID="searchsubmit" VALUE="Search">
            </DIV>
          </FORM>
        </A>
        <BR>
        </DIV>
      </DIV>
    </DIV>
  </BODY>

</HTML>

APT Browse - Built by Thomas Orozco.