| Home | Trees | Indices | Help |
|
|---|
|
|
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.
|
|||
|
|||
string
|
|
||
| Element |
|
||
|
|||
string
|
PARA = The tag value for paragraph Tokens.
|
||
string
|
LBLOCK = The tag value for literal Tokens.
|
||
string
|
DTBLOCK = The tag value for doctest Tokens.
|
||
string
|
HEADING = The tag value for heading Tokens.
|
||
string
|
BULLET = The tag value for bullet Tokens.
|
||
|
|||
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.
|
||
|
|||
Token.
|
|
|
|
|||
BULLETThetag value for bullet Tokens. This
tag value is also used for field tag Tokens,
since fields function syntactically the same as list items.
|
|
|||
indentThe indentation level of thisToken (in number of leading
spaces). A value of None indicates an unknown indentation;
this is used for list items and fields that begin with one-line
paragraphs.
|
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.
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0beta1 on Tue Feb 27 06:05:02 2007 | http://epydoc.sourceforge.net |