docutils.transforms.misc.CallBack

class documentation

class CallBack(Transform): (source)

Inserts a callback into a document. The callback is called when the transform is applied, which is determined by its priority. For use with `nodes.pending` elements. Requires a ``details['callback']`` entry, a bound method or function which takes one parameter: the pending node. Other data can be stored in the ``details`` attribute or in the object hosting the callback method.

Method	`apply`	Override to apply the transform to the document tree.
Class Variable	`default_priority`	Numerical priority of this transform, 0 through 999 (override).

Inherited from Transform:

Method	`__init__`	Initial setup for in-place document transforms.
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 apply(self): (source)

overrides docutils.transforms.Transform.apply

Override to apply the transform to the document tree.

default_priority: int = (source)

overrides docutils.transforms.Transform.default_priority

Numerical priority of this transform, 0 through 999 (override).