Package       Module       Class       Trees       Index       Help   
epydoc
[show private | hide private]

epydoc.epytext
Class epydoc.epytext.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.

Each 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
  __init__(self, tag, startline, contents, indent, level)
Create a new Token.
string __repr__(self)
Return the formal representation of this Token.
xml.dom.minidom.Element to_dom(self)
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

Constructor

__init__(self, tag, startline, contents, indent, level=None)

Create a new Token.
Parameters:
tag - The type of the new Token.
           (type=string)
startline - The line on which the new Token begins.
           (type=int)
contents - The normalized contents of the new Token.
           (type=string)
indent - The indentation of the new Token (in number of leading spaces). A value of None indicates an unknown indentation.
           (type=int or None)
level - The heading-level of this Token if it is a heading; None, otherwise.
           (type=int or None)

Representation operator

__repr__(self)

Returns:
the formal representation of this Token. Tokens have formal representaitons of the form: 
   <Token: para at line 12>

           (type=string)

to_dom

to_dom(self)

Returns:
a DOM representation of this Token.
           (type=xml.dom.minidom.Element)

Instance Variable Details

contents

The normalized text contained in this Token.
Type: string

indent

The indentation level of this Token (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.
Type: int or None

level

The heading-level of this Token if it is a heading; None, otherwise. Valid heading levels are 0, 1, and 2.
Type: int or None

startline

The line on which this Token begins. This line number is only used for issuing warnings and errors.
Type: int

tag

This Token's type. Possible values are Token.PARA (paragraph), Token.LBLOCK (literal block), Token.DTBLOCK (doctest block), Token.HEADINGC, and Token.BULLETC.
Type: string

Class Variable Details

BULLET

The tag value for bullet Tokens. This tag value is also used for field tag Tokens, since fields function syntactically the same as list items.
Type: string

DTBLOCK

The tag value for doctest Tokens.
Type: string

HEADING

The tag value for heading Tokens.
Type: string

LBLOCK

The tag value for literal Tokens.
Type: string

PARA

The tag value for paragraph Tokens.
Type: string

   Package       Module       Class       Trees       Index       Help   
epydoc
Generated by Epydoc on Sun Oct 6 03:32:12 2002 http://epydoc.sf.net