myst_parser.parsers.parse_html.Element Class Reference

Inheritance diagram for myst_parser.parsers.parse_html.Element:

Collaboration diagram for myst_parser.parsers.parse_html.Element:

Public Member Functions
None	__init__ (self, str name="", dict|None attr=None)
Element|None	parent (self)
list[Element]	children (self)
	reset_children (self, list[Element] children, bool deepcopy=False)
Element	__getitem__ (self, int index)
	__setitem__ (self, int index, Element item)
	__delitem__ (self, int index)
int	__len__ (self)
Iterator[Element]	__iter__ (self)
	insert (self, int index, Element item)
Element	deepcopy (self)
str	__repr__ (self)
str	render (self, dict[str, Callable[[Element, dict], str]]|None tag_overrides=None, **kwargs)
str	__str__ (self)
bool	__eq__ (self, Any item)
Iterator[Element]	walk (self, bool include_self=False)
Element	strip (self, bool inplace=False, bool recurse=False)
Iterator[Element]	find (self, str|type[Element] identifier, dict|None attrs=None, Iterable[str]|None classes=None, bool include_self=False, bool recurse=True)

Public Attributes
	name

Protected Attributes
	_children

Detailed Description

An Element of the xml/html document.

All xml/html entities inherit from this class.

Constructor & Destructor Documentation

__init__()

None myst_parser.parsers.parse_html.Element.__init__	(		self,
		str	name = "",
		dict | None	attr = None
	)

Initialise the element.

Reimplemented in myst_parser.parsers.parse_html.TerminalElement.

Member Function Documentation

children()

list[Element] myst_parser.parsers.parse_html.Element.children

(

self

)

Return copy of children.

deepcopy()

Element myst_parser.parsers.parse_html.Element.deepcopy

(

self

)

Recursively copy and remove parent.

Reimplemented in myst_parser.parsers.parse_html.TerminalElement.

find()

Iterator[Element] myst_parser.parsers.parse_html.Element.find	(		self,
		str | type[Element]	identifier,
		dict | None	attrs = None,
		Iterable[str] | None	classes = None,
		bool	include_self = False,
		bool	recurse = True
	)

Find all elements that match name and specific attributes.

parent()

Element | None myst_parser.parsers.parse_html.Element.parent

(

self

)

Return parent.

render()

str myst_parser.parsers.parse_html.Element.render	(		self,
		dict[str, Callable[[Element, dict], str]] | None	tag_overrides = None,
		**	kwargs
	)

Returns a HTML string representation of the element.

:param tag_overrides: Provide a dictionary of render function
    for specific tag names, to override the normal render format

Reimplemented in myst_parser.parsers.parse_html.Root, myst_parser.parsers.parse_html.VoidTag, myst_parser.parsers.parse_html.Data, myst_parser.parsers.parse_html.Declaration, myst_parser.parsers.parse_html.Comment, myst_parser.parsers.parse_html.Pi, myst_parser.parsers.parse_html.Char, myst_parser.parsers.parse_html.Entity, myst_parser.parsers.parse_html.Tag, and myst_parser.parsers.parse_html.XTag.

strip()

Element myst_parser.parsers.parse_html.Element.strip	(		self,
		bool	inplace = False,
		bool	recurse = False
	)

Return copy with all `Data` tokens
that only contain whitespace / newlines removed.

walk()

Iterator[Element] myst_parser.parsers.parse_html.Element.walk	(		self,
		bool	include_self = False
	)

Walk through the xml/html AST.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/myst_parser/parsers/parse_html.py