Package docutils :: Package transforms :: Class Transformer
[show private | hide private]
[frames | no frames]

Class Transformer

TransformSpec --+
                |
               Transformer


Stores transforms (Transform classes) and applies them to document trees. Also keeps track of components by component type name.
Method Summary
  __init__(self, document)
  add_pending(self, pending, priority)
Store a transform with an associated pending node.
  add_transform(self, transform_class, priority)
Store a single transform.
  add_transforms(self, transform_list)
Store multiple transforms, with default priorities.
  apply_transforms(self)
Apply all of the stored transforms, in priority order.
  get_priority_string(self, priority)
Return a string, priority combined with self.serialno.
  populate_from_components(self, components)
Store each component's default transforms, with default priorities.

Class Variable Summary
tuple default_transforms = (<class docutils.transforms.univers...

Method Details

add_pending(self, pending, priority=None)

Store a transform with an associated pending node.

add_transform(self, transform_class, priority=None)

Store a single transform. Use priority to override the default.

add_transforms(self, transform_list)

Store multiple transforms, with default priorities.

apply_transforms(self)

Apply all of the stored transforms, in priority order.

get_priority_string(self, priority)

Return a string, priority combined with self.serialno.

This ensures FIFO order on transforms with identical priority.

populate_from_components(self, components)

Store each component's default transforms, with default priorities. Also, store components by type name in a mapping for later lookup.

Class Variable Details

default_transforms

Type:
tuple
Value:
(<class docutils.transforms.universal.Decorations at 0x82a5c1c>,
 <class docutils.transforms.universal.FinalChecks at 0x82966cc>,
 <class docutils.transforms.universal.Messages at 0x8296be4>)          

Generated by Epydoc 2.0 on Tue Jul 22 05:30:46 2003 http://epydoc.sf.net