pugixml.pugi.XMLTreeWalker

class pugixml.pugi.XMLTreeWalker

Bases: pybind11_object

Abstract tree walker class.

Important

• Do not use XMLTreeWalker directly.

• In derived classes, override any or all of begin(), end(), and for_each().

See also

XMLNode.traverse()

Methods

__init__(self)	Initialize XMLTreeWalker.
begin(self, node)	Called by XMLNode.traverse() at the start of traversal.
depth(self)	Return the node's depth.
end(self, node)	Called by XMLNode.traverse() at the end of traversal.
for_each(self, node)	Called by XMLNode.traverse() for all nodes in the traversal subtree except the traversal root, in the depth first order.

Member Documentation

__init__(self: pugixml.pugi.XMLTreeWalker) → None

Initialize XMLTreeWalker.

begin(self: pugixml.pugi.XMLTreeWalker, node: pugixml.pugi.XMLNode) → bool

Called by XMLNode.traverse() at the start of traversal.

Parameters:

node – The node of traversal root.

Returns:

True if the traverse should continue, False otherwise.

depth(self: pugixml.pugi.XMLTreeWalker) → int

Return the node’s depth.

Returns:

The depth of current node.

end(self: pugixml.pugi.XMLTreeWalker, node: pugixml.pugi.XMLNode) → bool

Called by XMLNode.traverse() at the end of traversal.

Parameters:

node – The node of traversal root.

Returns:

True if the traverse should continue, False otherwise.

for_each(self: pugixml.pugi.XMLTreeWalker, node: pugixml.pugi.XMLNode) → bool

Called by XMLNode.traverse() for all nodes in the traversal subtree except the traversal root, in the depth first order.

Parameters:

node – The current node in the traversal subtree.

Returns:

True if the traverse should continue, False otherwise.