docutils.nodes.Text Class Reference

Inheritance diagram for docutils.nodes.Text:

Collaboration diagram for docutils.nodes.Text:

Public Member Functions
	__new__ (cls, data, rawsource=None)
	shortrepr (self, maxlen=18)
	__repr__ (self)
	astext (self)
	copy (self)
	deepcopy (self)
	pformat (self, indent=' ', level=0)
	rstrip (self, chars=None)
	lstrip (self, chars=None)
Public Member Functions inherited from docutils.nodes.Node
	document (self)
	document (self, value)
	__bool__ (self)
	asdom (self, dom=None)
	setup_child (self, child)
	walk (self, visitor)
	walkabout (self, visitor)
	traverse (self, condition=None, include_self=True, descend=True, siblings=False, ascend=False)
	findall (self, condition=None, include_self=True, descend=True, siblings=False, ascend=False)
	next_node (self, condition=None, include_self=False, descend=True, siblings=False, ascend=False)

Public Attributes
	tagname
Public Attributes inherited from docutils.nodes.Node
	children

Static Public Attributes
str	tagname = '#text'
tuple	children = ()
Static Public Attributes inherited from docutils.nodes.Node
	parent = None
	source = None
	line = None

Protected Member Functions
	_dom_node (self, domroot)
Protected Member Functions inherited from docutils.nodes.Node
	_fast_findall (self, cls)
	_superfast_findall (self)

Additional Inherited Members
Static Protected Attributes inherited from docutils.nodes.Node
	_document = None

Detailed Description

Instances are terminal nodes (leaves) containing text only; no child
nodes or attributes.  Initialize by passing a string to the constructor.

Access the raw (null-escaped) text with ``str(<instance>)``
and unescaped text with ``<instance>.astext()``.

Member Function Documentation

__new__()

docutils.nodes.Text.__new__	(		cls,
			data,
			rawsource = None
	)

Assert that `data` is not an array of bytes
and warn if the deprecated `rawsource` argument is used.

astext()

docutils.nodes.Text.astext

(

self

)

Return a string representation of this Node.

Reimplemented from docutils.nodes.Node.

copy()

docutils.nodes.Text.copy

(

self

)

Return a copy of self.

Reimplemented from docutils.nodes.Node.

deepcopy()

docutils.nodes.Text.deepcopy

(

self

)

Return a deep copy of self (also copying children).

Reimplemented from docutils.nodes.Node.

pformat()

docutils.nodes.Text.pformat	(		self,
			indent = '    ',
			level = 0
	)

Return an indented pseudo-XML representation, for test purposes.

Override in subclasses.

Reimplemented from docutils.nodes.Node.

---

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

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