docutils.nodes.TextElement

class documentation

class TextElement(Element):

View In Hierarchy

An element which directly contains text.

Its children are all Text or Inline subclass nodes. You can check whether an element's context is inline simply by checking whether its immediate parent is a TextElement instance (including subclasses). This is handy for nodes like image that can appear both inline and as standalone body elements.

If passing children to __init__(), make sure to set text to '' or some other suitable value.

Method	`__init__`	Undocumented
Class Variable	`child_text_separator`	Separator for child nodes, used by `astext()` method.

Inherited from Element:

Class Method	`is_not_known_attribute`	Returns True if and only if the given attribute is NOT recognized by this class.
Class Method	`is_not_list_attribute`	Returns True if and only if the given attribute is NOT one of the basic list attributes defined for all Elements.
Method	`__add__`	Undocumented
Method	`__contains__`	Undocumented
Method	`__delitem__`	Undocumented
Method	`__getitem__`	Undocumented
Method	`__iadd__`	Append a node or a list of nodes to `self.children`.
Method	`__len__`	Undocumented
Method	`__radd__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__setitem__`	Undocumented
Method	`__unicode__`	Undocumented
Method	`append`	Undocumented
Method	`append_attr_list`	For each element in values, if it does not exist in self[attr], append it.
Method	`astext`	Return a string representation of this Node.
Method	`attlist`	Undocumented
Method	`clear`	Undocumented
Method	`coerce_append_attr_list`	First, convert both self[attr] and value to a non-string sequence type; if either is not already a sequence, convert it to a list of one element. Then call append_attr_list.
Method	`copy`	Return a copy of self.
Method	`copy_attr_coerce`	No summary
Method	`copy_attr_concatenate`	No summary
Method	`copy_attr_consistent`	If replace is True or self[attr] is None, replace self[attr] with value. Otherwise, do nothing.
Method	`copy_attr_convert`	If attr is an attribute of self, set self[attr] to [self[attr], value], otherwise set self[attr] to value.
Method	`deepcopy`	Return a deep copy of self (also copying children).
Method	`delattr`	Undocumented
Method	`emptytag`	Undocumented
Method	`endtag`	Undocumented
Method	`extend`	Undocumented
Method	`first_child_matching_class`	Return the index of the first child whose class exactly matches.
Method	`first_child_not_matching_class`	Return the index of the first child whose class does not match.
Method	`get`	Undocumented
Method	`get_language_code`	Return node's language tag.
Method	`hasattr`	Undocumented
Method	`index`	Undocumented
Method	`insert`	Undocumented
Method	`is_not_default`	Undocumented
Method	`non_default_attributes`	Undocumented
Method	`note_referenced_by`	Note that this Element has been referenced by its name `name` or id `id`.
Method	`pformat`	Return an indented pseudo-XML representation, for test purposes.
Method	`pop`	Undocumented
Method	`remove`	Undocumented
Method	`replace`	Replace one child `Node` with another child or children.
Method	`replace_attr`	If self[attr] does not exist or force is True or omitted, set self[attr] to value, otherwise do nothing.
Method	`replace_self`	Replace `self` node with `new`, where `new` is a node or a list of nodes.
Method	`set_class`	Add a new class to the "classes" attribute.
Method	`setdefault`	Undocumented
Method	`shortrepr`	Undocumented
Method	`starttag`	Undocumented
Method	`update_all_atts`	Updates all attributes from node or dictionary `dict_`.
Method	`update_all_atts_coercion`	Updates all attributes from node or dictionary `dict_`.
Method	`update_all_atts_concatenating`	Updates all attributes from node or dictionary `dict_`.
Method	`update_all_atts_consistantly`	Updates all attributes from node or dictionary `dict_`.
Method	`update_all_atts_convert`	Updates all attributes from node or dictionary `dict_`.
Method	`update_basic_atts`	Update basic attributes ('ids', 'names', 'classes', 'dupnames', but not 'source') from node or dictionary `dict_`.
Class Variable	`basic_attributes`	Tuple of attributes which are defined for every Element-derived class instance and can be safely transferred to a different node.
Class Variable	`known_attributes`	Tuple of attributes that are known to the Element base class.
Class Variable	`list_attributes`	Tuple of attributes that are automatically initialized to empty lists for all nodes.
Class Variable	`local_attributes`	Tuple of class-specific attributes that should not be copied with the standard attributes when replacing a node.
Instance Variable	`attributes`	Dictionary of attribute {name: value}.
Instance Variable	`children`	List of child nodes (elements and/or `Text`).
Instance Variable	`rawsource`	The raw text from which this element was constructed.
Instance Variable	`referenced`	Undocumented
Instance Variable	`tagname`	The element generic identifier. If None, it is set as an instance attribute to the name of the class.
Method	`_dom_node`	Undocumented

Inherited from Node (via Element):

Method	`__bool__`	Node instances are always true, even if they're empty. A node is more than a simple container. Its boolean "truth" does not depend on having one or more subnodes in the doctree.
Method	`__str__`	Undocumented
Method	`asdom`	Return a DOM fragment representation of this Node.
Method	`document.setter`	Undocumented
Method	`findall`	Return an iterator yielding nodes following `self`:
Method	`next_node`	Return the first node in the iterator returned by findall(), or None if the iterable is empty.
Method	`previous_sibling`	Return preceding sibling node or `None`.
Method	`setup_child`	Undocumented
Method	`traverse`	Return list of nodes following `self`.
Method	`walk`	No summary
Method	`walkabout`	Perform a tree traversal similarly to `Node.walk()` (which see), except also call the `dispatch_departure()` method before exiting each node.
Class Variable	`line`	The line number (1-based) of the beginning of this Node in `source`.
Class Variable	`parent`	Back-reference to the Node immediately containing this Node.
Class Variable	`source`	Path or description of the input source which generated this Node.
Property	`document`	Return the `document` node at the root of the tree containing this Node.
Method	`_fast_findall`	Return iterator that only supports instance checks.
Method	`_superfast_findall`	Return iterator that doesn't check for a condition.
Instance Variable	`_document`	Undocumented

def __init__(self, rawsource='', text='', *children, **attributes):

overrides docutils.nodes.Element.__init__

overridden in docutils.nodes.FixedTextElement

Undocumented

child_text_separator: str =

overrides docutils.nodes.Element.child_text_separator

Separator for child nodes, used by astext() method.