| Home | Trees | Index | Help |
|
|---|
| Package epydoc :: Package markup :: Module epytext :: Class Token |
|
Tokens are an intermediate data structure used while
constructing the structuring DOM tree for a formatted docstring. There
are five types of Token:
The text contained in each Token is stored in the
contents 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.
Token has an indentation level associated with it,
stored in the indent variable. This indentation level is
used by the structuring procedure to assemble hierarchical blocks.
| Method Summary | |
|---|---|
Create a new Token. | |
string
|
Return the formal representation of this Token. |
xml.dom.minidom.Element
|
Return a DOM representation of this Token. |
| Instance Variable Summary | |
|---|---|
string |
contents: The normalized text contained in this Token. |
int or None |
indent: The indentation level of this Token (in number of leading
spaces). |
int or None |
level: The heading-level of this Token if it is a heading;
None, otherwise. |
int |
startline: The line on which this Token begins. |
string |
tag: This Token's type. |
| Class Variable Summary | |
|---|---|
string |
BULLET: The tag value for bullet Tokens. |
string |
DTBLOCK: The tag value for doctest Tokens. |
string |
HEADING: The tag value for heading Tokens. |
string |
LBLOCK: The tag value for literal Tokens. |
string |
PARA: The tag value for paragraph Tokens. |
| Method Details |
|---|
__init__(self,
tag,
startline,
contents,
indent,
level=None)
Create a new |
__repr__(self)
|
to_dom(self, doc)
|
| Instance Variable Details |
|---|
contentsThe normalized text contained in thisToken.
|
levelThe heading-level of thisToken if it is a heading;
None, otherwise. Valid heading levels are 0, 1, and 2.
|
startlineThe line on which thisToken begins. This line number is
only used for issuing errors.
|
tagThisToken's type. Possible values are
Token.PARA (paragraph), Token.LBLOCK (literal
block), Token.DTBLOCK (doctest block),
Token.HEADINGC, and Token.BULLETC.
|
| Class Variable Details |
|---|
BULLETThetag value for bullet Tokens. This
tag value is also used for field tag Tokens,
since fields function syntactically the same as list items.
|
DTBLOCKThetag value for doctest Tokens.
|
HEADINGThetag value for heading Tokens.
|
LBLOCKThetag value for literal Tokens.
|
PARAThetag value for paragraph Tokens.
|
| Home | Trees | Index | Help |
|
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:13 2004 | http://epydoc.sf.net |