Module Expr Str Assign NameStore Str ImportFrom alias alias alias ClassDef bases NameLoad body Pass decorator_list ClassDef bases body Expr Str Assign NameStore NameLoad Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Assign AttributeStore NameLoad attr NameLoad Expr Str Assign AttributeStore NameLoad attr NameLoad Expr Str Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr AttributeLoad AttributeLoad NameLoad attr attr Expr Str decorator_list FunctionDef arguments args NameParam defaults kwarg body Expr Str Raise Call NameLoad Str decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Assign AttributeStore NameLoad attr ListLoad Expr Str Assign AttributeStore NameLoad attr ListLoad Expr Str Assign AttributeStore NameLoad attr NameLoad Expr Str Assign AttributeStore NameLoad attr ListLoad Expr Str Assign AttributeStore NameLoad attr Num Expr Str Assign AttributeStore NameLoad attr Dict Expr Str Assign AttributeStore NameLoad attr Num Expr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad kwarg body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr TupleLoad NameLoad NameLoad NameLoad NameLoad Assign AttributeStore NameLoad attr Num decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str For NameStore NameLoad body Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr TupleLoad NameLoad NameLoad NameLoad Dict Assign AttributeStore NameLoad attr Num decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Assign NameStore AttributeLoad NameLoad attr If CompareIs NameLoad NameLoad body Assign NameStore AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr TupleLoad NameLoad NameLoad NameLoad Dict Assign AttributeStore NameLoad attr Num decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str AugAssignAdd AttributeStore NameLoad attr Num Return BinOpMod Str TupleLoad NameLoad AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str For NameStore NameLoad body If CompareIs NameLoad NameLoad body Continue Expr Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr Assign SubscriptStore AttributeLoad NameLoad attr Index AttributeLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr Num Assign NameStore ListLoad For NameStore NameLoad body Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign NameStore ListComp TupleLoad AttributeLoad NameLoad attr NameLoad comprehension NameStore NameLoad Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr ListComp SubscriptLoad NameLoad Index Num comprehension NameStore NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr AttributeLoad AttributeLoad NameLoad attr attr While AttributeLoad NameLoad attr body If UnaryOpNot AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr Assign AttributeStore NameLoad attr Num Assign TupleStore NameStore NameStore NameStore NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore Call NameLoad AttributeLoad NameLoad attr keyword NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr TupleLoad NameLoad NameLoad NameLoad NameLoad decorator_list decorator_list
N/A N/A 
This package contains modules for standard tree transforms available
to Docutils components. Tree transforms serve a variety of purposes:

- To tie up certain syntax-specific "loose ends" that remain after the
  initial parsing of the input plaintext. These transforms are used to
  supplement a limited syntax.

- To automate the internal linking of the document tree (hyperlink
  references, footnote references, etc.).

- To extract useful information from the document tree. These
  transforms may be used to construct (for example) indexes and tables
  of contents.

Each transform is an optional step that a Docutils component may
choose to perform on the parsed document.
 N/A __docformat__ reStructuredText docutils languages ApplicationError TransformSpec TransformError N/A ApplicationError N/A N/A N/A Transform N/A N/A N/A 
    Docutils transform component abstract base class.
     N/A default_priority None N/A Numerical priority of this transform, 0 through 999 (override). __init__ N/A N/A self document startnode N/A None N/A N/A 
        Initial setup for in-place document transforms.
         N/A N/A self document document N/A The document tree to transform. N/A N/A self startnode startnode N/A Node from which to begin the transform.  For many transforms which
        apply to the document as a whole, `startnode` is not set (i.e. its
        value is `None`). N/A N/A self language N/A N/A languages get_language N/A N/A document settings language_code N/A Language module local to this document. N/A apply N/A N/A self N/A kwargs N/A N/A Override to apply the transform to the document tree. N/A N/A NotImplementedError subclass must override this method N/A N/A Transformer N/A TransformSpec N/A N/A 
    Stores transforms (`Transform` classes) and applies them to document
    trees.  Also keeps track of components by component type name.
     __init__ N/A N/A self document N/A N/A N/A N/A self transforms N/A N/A List of transforms to apply.  Each item is a 3-tuple:
        ``(priority string, transform class, pending node or None)``. N/A N/A self unknown_reference_resolvers N/A N/A List of hook functions which assist in resolving references N/A N/A self document document N/A The `nodes.document` object this Transformer is attached to. N/A N/A self applied N/A N/A Transforms already applied, in order. N/A N/A self sorted 0 N/A Boolean: is `self.tranforms` sorted? N/A N/A self components N/A N/A Mapping of component type name to component object.  Set by
        `self.populate_from_components()`. N/A N/A self serialno 0 N/A Internal serial number to keep track of the add order of
        transforms. N/A add_transform N/A N/A self transform_class priority N/A None kwargs N/A N/A 
        Store a single transform.  Use `priority` to override the default.
        `kwargs` is a dictionary whose contents are passed as keyword
        arguments to the `apply` method of the transform.  This can be used to
        pass application-specific data to the transform instance.
         N/A N/A priority None N/A N/A priority N/A transform_class default_priority N/A priority_string N/A N/A self get_priority_string priority N/A N/A N/A N/A self transforms append N/A priority_string transform_class None kwargs N/A N/A self sorted 0 N/A add_transforms N/A N/A self transform_list N/A N/A N/A Store multiple transforms, with default priorities. N/A transform_class transform_list N/A N/A priority_string N/A N/A self get_priority_string N/A transform_class default_priority N/A N/A N/A N/A self transforms append N/A priority_string transform_class None N/A N/A N/A self sorted 0 N/A add_pending N/A N/A self pending priority N/A None N/A N/A Store a transform with an associated `pending` node. N/A transform_class N/A pending transform N/A N/A priority None N/A N/A priority N/A transform_class default_priority N/A priority_string N/A N/A self get_priority_string priority N/A N/A N/A N/A self transforms append N/A priority_string transform_class pending N/A N/A N/A self sorted 0 N/A get_priority_string N/A N/A self priority N/A N/A N/A 
        Return a string, `priority` combined with `self.serialno`.

        This ensures FIFO order on transforms with identical priority.
         N/A N/A self serialno 1 N/A N/A %03d-%03d N/A priority N/A self serialno N/A populate_from_components N/A N/A self components N/A N/A N/A 
        Store each component's default transforms, with default priorities.
        Also, store components by type name in a mapping for later lookup.
         N/A component components N/A N/A N/A component None N/A N/A N/A N/A N/A self add_transforms N/A N/A component get_transforms N/A N/A N/A self components N/A N/A component component_type component N/A N/A self sorted 0 N/A unknown_reference_resolvers N/A N/A i components N/A N/A N/A N/A unknown_reference_resolvers extend N/A i unknown_reference_resolvers N/A decorated_list N/A N/A N/A f priority f N/A f unknown_reference_resolvers N/A N/A N/A decorated_list sort N/A N/A N/A N/A self unknown_reference_resolvers extend N/A N/A f N/A 1 N/A f decorated_list N/A apply_transforms N/A N/A self N/A N/A N/A Apply all of the stored transforms, in priority order. N/A N/A N/A N/A N/A self document reporter attach_observer N/A N/A self document note_transform_message N/A N/A self transforms N/A N/A N/A N/A self sorted N/A N/A N/A N/A N/A self transforms sort N/A N/A N/A N/A self transforms reverse N/A N/A self sorted 1 N/A N/A priority transform_class pending kwargs N/A N/A N/A self transforms pop N/A transform N/A transform_class N/A self document startnode pending N/A N/A N/A transform apply kwargs N/A N/A N/A N/A self applied append N/A priority transform_class pending kwargs N/A N/A