html - Django-Components" > html - Django-Components" >
Skip to content

html ¤

Functions:

  • parse_document_or_nodes –

    Use this if you do NOT know whether the given HTML is a full document

  • parse_multiroot_html –

    Use this when you know the given HTML is a multiple nodes like

  • parse_node –

    Use this when you know the given HTML is a single node like

parse_document_or_nodes ¤

parse_document_or_nodes(html: str) -> Union[List[LexborNode], LexborHTMLParser]

Use this if you do NOT know whether the given HTML is a full document with <html>, <head>, and <body> tags, or an HTML fragment.

Source code in src/django_components/util/html.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def parse_document_or_nodes(html: str) -> Union[List[LexborNode], LexborHTMLParser]:
    """
    Use this if you do NOT know whether the given HTML is a full document
    with `<html>`, `<head>`, and `<body>` tags, or an HTML fragment.
    """
    html = html.strip()
    tree = LexborHTMLParser(html)
    is_fragment = is_html_parser_fragment(html, tree)

    if is_fragment:
        nodes = parse_multiroot_html(html)
        return nodes
    else:
        return tree

parse_multiroot_html ¤

parse_multiroot_html(html: str) -> List[LexborNode]

Use this when you know the given HTML is a multiple nodes like

<div> Hi </div> <span> Hello </span>

Source code in src/django_components/util/html.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def parse_multiroot_html(html: str) -> List[LexborNode]:
    """
    Use this when you know the given HTML is a multiple nodes like

    `<div> Hi </div> <span> Hello </span>`
    """
    # NOTE: HTML / XML MUST have a single root. So, to support multiple
    # top-level elements, we wrap them in a dummy singular root.
    parser = LexborHTMLParser(f"<root>{html}</root>")

    # Get all contents of the root
    root_elem = parser.css_first("root")
    elems = [*root_elem.iter()] if root_elem else []
    return elems

parse_node ¤

parse_node(html: str) -> LexborNode

Use this when you know the given HTML is a single node like

<div> Hi </div>

Source code in src/django_components/util/html.py 
 6
 7
 8
 9
10
11
12
13
14
15
def parse_node(html: str) -> LexborNode:
    """
    Use this when you know the given HTML is a single node like

    `<div> Hi </div>`
    """
    tree = LexborHTMLParser(html)
    # NOTE: The parser automatically places <style> tags inside <head>
    # while <script> tags are inside <body>.
    return tree.body.child or tree.head.child  # type: ignore[union-attr, return-value]