docutils.transforms.Transform

class documentation

class Transform(object): (source)

Known subclasses: docutils.transforms.components.Filter, docutils.transforms.frontmatter.DocInfo, docutils.transforms.frontmatter.TitlePromoter, docutils.transforms.misc.CallBack, docutils.transforms.misc.ClassAttribute, docutils.transforms.misc.Transitions, docutils.transforms.parts.Contents, docutils.transforms.parts.SectNum, docutils.transforms.peps.Contents, docutils.transforms.peps.Headers, docutils.transforms.peps.PEPZero, docutils.transforms.peps.TargetNotes, docutils.transforms.references.AnonymousHyperlinks, docutils.transforms.references.DanglingReferences, docutils.transforms.references.ExternalTargets, docutils.transforms.references.Footnotes, docutils.transforms.references.IndirectHyperlinks, docutils.transforms.references.InternalTargets, docutils.transforms.references.PropagateTargets, docutils.transforms.references.Substitutions, docutils.transforms.references.TargetNotes, docutils.transforms.universal.Decorations, docutils.transforms.universal.ExposeInternals, docutils.transforms.universal.FilterMessages, docutils.transforms.universal.Messages, docutils.transforms.universal.SmartQuotes, docutils.transforms.universal.StripClassesAndElements, docutils.transforms.universal.StripComments, docutils.transforms.universal.TestMessages, docutils.transforms.writer_aux.Admonitions, docutils.transforms.writer_aux.Compound

View In Hierarchy

Docutils transform component abstract base class.
Method __init__ Initial setup for in-place document transforms.
Method apply Override to apply the transform to the document tree.
Class Variable default​_priority Numerical priority of this transform, 0 through 999 (override).
Instance Variable document The document tree to transform.
Instance Variable language Language module local to this document.
Instance Variable startnode 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).
def __init__(self, document, startnode=None): (source)
overridden in docutils.transforms.references.TargetNotes, docutils.transforms.universal.SmartQuotes
Initial setup for in-place document transforms.
def apply(self, **kwargs): (source)
overridden in docutils.transforms.components.Filter, docutils.transforms.frontmatter.DocInfo, docutils.transforms.frontmatter.DocTitle, docutils.transforms.frontmatter.SectionSubTitle, docutils.transforms.misc.CallBack, docutils.transforms.misc.ClassAttribute, docutils.transforms.misc.Transitions, docutils.transforms.parts.Contents, docutils.transforms.parts.SectNum, docutils.transforms.peps.Contents, docutils.transforms.peps.Headers, docutils.transforms.peps.PEPZero, docutils.transforms.peps.TargetNotes, docutils.transforms.references.AnonymousHyperlinks, docutils.transforms.references.DanglingReferences, docutils.transforms.references.ExternalTargets, docutils.transforms.references.Footnotes, docutils.transforms.references.IndirectHyperlinks, docutils.transforms.references.InternalTargets, docutils.transforms.references.PropagateTargets, docutils.transforms.references.Substitutions, docutils.transforms.references.TargetNotes, docutils.transforms.universal.Decorations, docutils.transforms.universal.ExposeInternals, docutils.transforms.universal.FilterMessages, docutils.transforms.universal.Messages, docutils.transforms.universal.SmartQuotes, docutils.transforms.universal.StripClassesAndElements, docutils.transforms.universal.StripComments, docutils.transforms.universal.TestMessages, docutils.transforms.writer_aux.Admonitions, docutils.transforms.writer_aux.Compound
Override to apply the transform to the document tree.
default_priority = (source)
overridden in docutils.transforms.components.Filter, docutils.transforms.frontmatter.DocInfo, docutils.transforms.frontmatter.DocTitle, docutils.transforms.frontmatter.SectionSubTitle, docutils.transforms.misc.CallBack, docutils.transforms.misc.ClassAttribute, docutils.transforms.misc.Transitions, docutils.transforms.parts.Contents, docutils.transforms.parts.SectNum, docutils.transforms.peps.Contents, docutils.transforms.peps.Headers, docutils.transforms.peps.PEPZero, docutils.transforms.peps.TargetNotes, docutils.transforms.references.AnonymousHyperlinks, docutils.transforms.references.DanglingReferences, docutils.transforms.references.ExternalTargets, docutils.transforms.references.Footnotes, docutils.transforms.references.IndirectHyperlinks, docutils.transforms.references.InternalTargets, docutils.transforms.references.PropagateTargets, docutils.transforms.references.Substitutions, docutils.transforms.references.TargetNotes, docutils.transforms.universal.Decorations, docutils.transforms.universal.ExposeInternals, docutils.transforms.universal.FilterMessages, docutils.transforms.universal.Messages, docutils.transforms.universal.SmartQuotes, docutils.transforms.universal.StripClassesAndElements, docutils.transforms.universal.StripComments, docutils.transforms.universal.TestMessages, docutils.transforms.writer_aux.Admonitions, docutils.transforms.writer_aux.Compound
Numerical priority of this transform, 0 through 999 (override).
document = (source)
The document tree to transform.
language = (source)
Language module local to this document.
startnode = (source)
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).