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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.markup.epytext.Token</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.markup-module.html">Package markup</a> ::
<a href="epydoc.markup.epytext-module.html">Module epytext</a> ::
Class Token
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.markup.epytext.Token-class.html">show private</a> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.markup.epytext.Token-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Token</h2>
<hr/>
<code>Token</code>s are an intermediate data structure used while
constructing the structuring DOM tree for a formatted docstring. There
are five types of <code>Token</code>:
<ul>
<li>
Paragraphs
</li>
<li>
Literal blocks
</li>
<li>
Doctest blocks
</li>
<li>
Headings
</li>
<li>
Bullets
</li>
</ul>
<p>The text contained in each <code>Token</code> is stored in the
<code>contents</code> variable. The string in this variable has been
normalized. For paragraphs, this means that it has been converted into a
single line of text, with newline/indentation replaced by single spaces.
For literal blocks and doctest blocks, this means that the appropriate
amount of leading whitespace has been removed from each line.</p>
Each <code>Token</code> has an indentation level associated with it,
stored in the <code>indent</code> variable. This indentation level is
used by the structuring procedure to assemble hierarchical blocks.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.Token-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tag</span>,
<span class=summary-sig-arg>startline</span>,
<span class=summary-sig-arg>contents</span>,
<span class=summary-sig-arg>indent</span>,
<span class=summary-sig-arg>level</span>)</span></code>
<br />
Create a new <code>Token</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.Token-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the formal representation of this <code>Token</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>xml.dom.minidom.Element</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext.Token-class.html#to_dom" class="summary-sig-name"><code>to_dom</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>doc</span>)</span></code>
<br />
Return a DOM representation of this <code>Token</code>.</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>string</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#contents"><code>contents</code></a></b>: The normalized text contained in this <code>Token</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code> or <code>None</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#indent"><code>indent</code></a></b>: The indentation level of this <code>Token</code> (in number of leading
spaces).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code> or <code>None</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#level"><code>level</code></a></b>: The heading-level of this <code>Token</code> if it is a heading;
<code>None</code>, otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#startline"><code>startline</code></a></b>: The line on which this <code>Token</code> begins.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>string</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#tag"><code>tag</code></a></b>: This <code>Token</code>'s type.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>string</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#BULLET"><code>BULLET</code></a></b>: The <code>tag</code> value for bullet <code>Token</code>s.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>string</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#DTBLOCK"><code>DTBLOCK</code></a></b>: The <code>tag</code> value for doctest <code>Token</code>s.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>string</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#HEADING"><code>HEADING</code></a></b>: The <code>tag</code> value for heading <code>Token</code>s.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>string</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#LBLOCK"><code>LBLOCK</code></a></b>: The <code>tag</code> value for literal <code>Token</code>s.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>string</code></font></td>
<td><b><a href="epydoc.markup.epytext.Token-class.html#PARA"><code>PARA</code></a></b>: The <code>tag</code> value for paragraph <code>Token</code>s.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>tag</span>,
<span class=sig-arg>startline</span>,
<span class=sig-arg>contents</span>,
<span class=sig-arg>indent</span>,
<span class=sig-arg>level</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Create a new <code>Token</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>tag</b></code> -
The type of the new <code>Token</code>.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>startline</b></code> -
The line on which the new <code>Token</code> begins.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>contents</b></code> -
The normalized contents of the new <code>Token</code>.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>indent</b></code> -
The indentation of the new <code>Token</code> (in number of
leading spaces). A value of <code>None</code> indicates an
unknown indentation.
<br /><i>
(type=<code>int</code> or <code>None</code>)</i>
<dd><code><b>level</b></code> -
The heading-level of this <code>Token</code> if it is a
heading; <code>None</code>, otherwise.
<br /><i>
(type=<code>int</code> or <code>None</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="__repr__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span>
<br /><i>(Representation operator)</i>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
the formal representation of this <code>Token</code>.
<code>Token</code>s have formal representaitons of the form:
<pre class="literalblock">
<Token: para at line 12>
</pre>
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="to_dom"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_dom</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>doc</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a DOM representation of this <code>Token</code>.
<br /><i>
(type=<code>xml.dom.minidom.Element</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="contents"></a>
<h3>contents</h3>
The normalized text contained in this <code>Token</code>.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>string</code>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="indent"></a>
<h3>indent</h3>
The indentation level of this <code>Token</code> (in number of leading
spaces). A value of <code>None</code> indicates an unknown indentation;
this is used for list items and fields that begin with one-line
paragraphs.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code> or <code>None</code>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="level"></a>
<h3>level</h3>
The heading-level of this <code>Token</code> if it is a heading;
<code>None</code>, otherwise. Valid heading levels are 0, 1, and 2.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code> or <code>None</code>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="startline"></a>
<h3>startline</h3>
The line on which this <code>Token</code> begins. This line number is
only used for issuing errors.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="tag"></a>
<h3>tag</h3>
This <code>Token</code>'s type. Possible values are
<code>Token.PARA</code> (paragraph), <code>Token.LBLOCK</code> (literal
block), <code>Token.DTBLOCK</code> (doctest block),
<code>Token.HEADINGC</code>, and <code>Token.BULLETC</code>.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>string</code>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="BULLET"></a>
<h3>BULLET</h3>
The <code>tag</code> value for bullet <code>Token</code>s. This
<code>tag</code> value is also used for field tag <code>Token</code>s,
since fields function syntactically the same as list items.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>string</code>
</dd>
<span title="'bullet'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>bullet<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="DTBLOCK"></a>
<h3>DTBLOCK</h3>
The <code>tag</code> value for doctest <code>Token</code>s.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>string</code>
</dd>
<span title="'doctestblock'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>doctestblock<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="HEADING"></a>
<h3>HEADING</h3>
The <code>tag</code> value for heading <code>Token</code>s.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>string</code>
</dd>
<span title="'heading'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>heading<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="LBLOCK"></a>
<h3>LBLOCK</h3>
The <code>tag</code> value for literal <code>Token</code>s.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>string</code>
</dd>
<span title="'literalblock'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>literalblock<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="PARA"></a>
<h3>PARA</h3>
The <code>tag</code> value for paragraph <code>Token</code>s.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>string</code>
</dd>
<span title="'para'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>para<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:13 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
