Element

Elements are returned from querying methods.

properties

name

Gets the name of the Element.

html = HTML("<span>Dormouse</span>")
span_element = html.root_element

assert span_element.name == "span"

id

Get the id

html = HTML('<span id="dormouse">Dormouse</span>')
span_element = html.root_element

assert span_element.id == "dormouse"

Set the id

html = HTML("<span>Dormouse</span>")
span_element = html.root_element

span_element.id = "dormouse"
assert span_element.id == "dormouse"

attributes

Get attributes

html = HTML('<button class="mt-2 pb-2" disabled>Wake up</button>')
button_element = html.root_element

assert button_element.attributes == {"class": "mt-2 pb-2", "disabled": True}

Set attributes

html = HTML("<button>Go back to sleep</button>")
button_element = html.root_element
button_element.attributes = {"class": "mt-2 pb-2", "disabled": True}

assert str(button_element) == '<button class="mt-2 pb-2" disabled>Go back to sleep</button>'

classes

Gets a list of classes for the element.

html = HTML('<button class="mt-2 pb-2">Wake Up</button>')
button_element = html.root_element

assert button_element.classes == ["mt-2", "pb-2"]

text

Get text context

html = HTML("<button>Wake Up</button>")
button_element = html.root_element

assert button_element.text == "Wake Up"

Set text content

html = HTML("<button>Wake Up</button>")
button_element = html.root_element

button_element.text = "Go back to sleep"

assert str(button_element) == "<button>Go back to sleep</button>"

children

Gets an iterator of the children for the element.

html = HTML("""
<ul>
    <li>1</li>
    <li>2</li>
    <li>3</li>
</ul>
""")
ul_element = html.root_element

assert len(list(ul_element.children)) == 3

parent

Gets the parent for the element.

html = HTML("""
<ul>
    <li id="li-1">1</li>
</ul>
""")
li_element = next(html.query("#li-1"))

assert li_element.parent.name == "ul"

methods

insert

Inserts an element into an element.

html = HTML("<ul></ul>")
ul_element = next(html.query("ul"))

li_element = Element.create("li", "item")
ul_element.insert(li_element)

assert str(ul_element) == "<ul><li>item</li></ul>"

html = HTML("<ul><li>item</li></ul>")
ul_element = next(html.query("ul"))

li_element = Element.create("li", "another item")
ul_element.insert(li_element, -1)

assert str(ul_element) == "<ul><li>item</li><li>another item</li></ul>"

prettify

Returns a prettified version of the element.

html = HTML('<ul><li id="li-1">1</li></ul>')
ul_element = next(html.query("ul"))

assert ul_element.prettify() == """
<ul>
  <li id="li-1">1</li>
</ul>
"""

remove_children

Removes all children from an element.

html = HTML('''
<ul>
  <li id="li-1">1</li>
  <li id="li-2">2</li>
</ul>
''')
ul_element = next(html.query("ul"))
ul_element.remove_children()

assert str(ul_element) == "<ul></ul>"