Home       Trees       Index       Help   

epydoc 3.0alpha2

Package epydoc :: Package markup :: Module epytext :: Class Token
[hide private]
[frames] | no frames]

Class Token
source code

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.

Instance Methods [hide private]
  __init__(self, tag, startline, contents, indent, level=None)
Create a new Token.
string __repr__(self)
xml.dom.minidom.Element to_dom(self, doc)

Class Variables [hide private]
PARA The tag value for paragraph Tokens.
LBLOCK The tag value for literal Tokens.
DTBLOCK The tag value for doctest Tokens.
HEADING The tag value for heading Tokens.
BULLET The tag value for bullet Tokens.

Instance Variables [hide private]
contents The normalized text contained in this Token.
indent The indentation level of this Token (in number of leading spaces).
level The heading-level of this Token if it is a heading; None, otherwise.
startline The line on which this Token begins.
tag This Token's type.

Method Details [hide private]

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

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

__repr__(self)
(Representation operator)

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

to_dom(self, doc)

source code 
call graph 
Returns: xml.dom.minidom.Element
a DOM representation of this Token.

Class Variable Details [hide private]

PARA

The tag value for paragraph Tokens.
Type:
string
Value:
'para'

LBLOCK

The tag value for literal Tokens.
Type:
string
Value:
'literalblock'

DTBLOCK

The tag value for doctest Tokens.
Type:
string
Value:
'doctestblock'

HEADING

The tag value for heading Tokens.
Type:
string
Value:
'heading'

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
Value:
'bullet'

Instance Variable Details [hide private]

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 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

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:36:52 2006 http://epydoc.sf.net