docutils.nodes.GenericNodeVisitor Class Reference

Inheritance diagram for docutils.nodes.GenericNodeVisitor:

Collaboration diagram for docutils.nodes.GenericNodeVisitor:

Public Member Functions
	default_visit (self, node)
	default_departure (self, node)
Public Member Functions inherited from docutils.nodes.NodeVisitor
	__init__ (self, document)
	dispatch_visit (self, node)
	dispatch_departure (self, node)
	unknown_visit (self, node)
	unknown_departure (self, node)

Additional Inherited Members
Public Attributes inherited from docutils.nodes.NodeVisitor
	document
	optional
Static Public Attributes inherited from docutils.nodes.NodeVisitor
tuple	optional = ('meta',)

Detailed Description

Generic "Visitor" abstract superclass, for simple traversals.

Unless overridden, each ``visit_...`` method calls `default_visit()`, and
each ``depart_...`` method (when using `Node.walkabout()`) calls
`default_departure()`. `default_visit()` (and `default_departure()`) must
be overridden in subclasses.

Define fully generic visitors by overriding `default_visit()` (and
`default_departure()`) only. Define semi-generic visitors by overriding
individual ``visit_...()`` (and ``depart_...()``) methods also.

`NodeVisitor.unknown_visit()` (`NodeVisitor.unknown_departure()`) should
be overridden for default behavior.

Member Function Documentation

default_departure()

docutils.nodes.GenericNodeVisitor.default_departure	(		self,
			node
	)

Override for generic, uniform traversals.

Reimplemented in docutils.nodes.TreeCopyVisitor, docutils.writers.docutils_xml.XMLTranslator, and docutils.writers.odf_odt.ODFTranslator.

default_visit()

docutils.nodes.GenericNodeVisitor.default_visit	(		self,
			node
	)

Override for generic, uniform traversals.

Reimplemented in docutils.nodes.TreeCopyVisitor, docutils.writers._html_base.SimpleListChecker, docutils.writers.docutils_xml.XMLTranslator, and docutils.writers.odf_odt.ODFTranslator.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/nodes.py