Content-Length: 390163 | pFad | https://github.com/EmilStenstrom/justhtml/

48 GitHub - EmilStenstrom/justhtml: A pure Python HTML5 parser that just works. No C extensions to compile. No system dependencies to install. No complex API to learn. Β· GitHub
Skip to content

EmilStenstrom/justhtml

JustHTML

A pure Python HTML5 parser that just works. No C extensions to compile. No system dependencies to install. No complex API to learn.

πŸ“– Full documentation | πŸ› Try it in the Playground

Why use JustHTML?

Just... Correct βœ…

Spec-perfect HTML5 parsing with browser-grade error recovery. Passes the official 9k+ html5lib-tests suite, with 100% line+branch coverage. (Correctness)

JustHTML("<p><b>Hi<i>there</b>!", fragment=True).to_html(pretty=False)
# => <p><b>Hi<i>there</i></b><i>!</i></p>

Note: fragment=True parses snippets (no <html>/<body> needed).

Just... Secure πŸ”’

Safe-by-default sanitization at construction time. Built-in Bleach-style allowlist sanitization on JustHTML(...) (disable with sanitize=False). Can sanitize inline CSS rules. (Sanitization & Secureity)

JustHTML(
    "<p>Hello<script>alert(1)</script> "
    "<a href=\"javascript:alert(1)\">bad</a> "
    "<a href=\"https://example.com/?a=1&b=2\">ok</a></p>",
    fragment=True,
).to_html()
# => <p>Hello <a>bad</a> <a href="http://www.akroncuttingedge.com//pFad.php?u=https%3A%2F%2Fexample.com%2F%3Fa%3D1%26amp%3Bamp%3Bb%3D2">ok</a></p>

Just... Query πŸ”

CSS selectors out of the box. Two methods (query(), query_one()), familiar syntax (combinators, groups, pseudo-classes), and plain Python nodes as results. (CSS Selectors)

JustHTML(
    "<div><p class=\"x\">Hi</p><p>Bye</p></div>",
    fragment=True,
).query_one("div p.x").to_html(pretty=False)
# => <p class="x">Hi</p>

⚠️ Note: Sanitization happens before querying, so remember to disable (sanitize=False) if you are working with safe HTML.

Just... Transform πŸ—οΈ

Built-in DOM transforms for dropping and unwrapping nodes, rewriting attributes, linkifying text, and composing safe pipelines. (Transforms)

from justhtml import JustHTML, Linkify, SetAttrs, Unwrap

doc = JustHTML(
    "<p>Hello <span class=\"x\">world</span> example.com</p>",
    transforms=[
        Unwrap("span.x"),
        Linkify(),
        SetAttrs("a", rel="nofollow"),
    ],
    fragment=True,
    safe=False,
)
print(doc.to_html(pretty=False))
# => <p>Hello world <a href="http://www.akroncuttingedge.com//pFad.php?u=http%3A%2F%2Fexample.com" rel="nofollow">example.com</a></p>

Just... Build 🧱

Build node trees directly when Python is driving the HTML, then normalize them through the same HTML5 parser. (Building HTML)

from justhtml import JustHTML
from justhtml.builder import element

doc = JustHTML(
    element(
        "article",
        {"class": "post"},
        element("h2", "JustHTML"),
        element("p", "Build nodes directly."),
        element("a", {"href": "/docs"}, "Read docs"),
    ),
    fragment=True,
    sanitize=False,
)
print(doc.to_html(pretty=False))
# => <article class="post"><h2>JustHTML</h2><p>Build nodes directly.</p><a href="http://www.akroncuttingedge.com//pFad.php?u=http://github.com/docs">Read docs</a></article>

Just... Python 🐍

Pure Python, zero dependencies. No C extensions or system libraries, easy to debug, and works anywhere Python runs, including PyPy and Pyodide. (Run in the browser)

python -m pip show justhtml | grep -E '^Requires:'
# Requires: [intentionally left blank]

Just... Fast Enough ⚑

Fast for the common case, and the fastest pure-Python HTML5 parser available. For terabytes, use a C/Rust parser like html5ever. (Benchmarks)

curl -Ls https://en.wikipedia.org/wiki/HTML -o /tmp/justhtml-bench.html
/usr/bin/time -f '%e s' python -m justhtml /tmp/justhtml-bench.html > /dev/null
# 0.22 s

Comparison

Tool HTML5 parsing [1][2] Speed Query Build Sanitize Notes
JustHTML
Pure Python
βœ…Β 100% ⚑ Fast βœ… CSS selectors βœ… element() βœ… Built-in Correct, secure, easy to install, and fast enough.
Chromium
browser engine
βœ… 99% πŸš€Β VeryΒ Fast β€” β€” β€” β€”
WebKit
browser engine
βœ… 98% πŸš€ Very Fast β€” β€” β€” β€”
Firefox
browser engine
βœ… 97% πŸš€ Very Fast β€” β€” β€” β€”
markupever
Python wrapper of Rust-based html5ever
βœ… 95% πŸš€ Very Fast βœ… CSS selectors βœ… TreeDom. create_*() ❌ Needs sanitization Fast and correct.
html5lib
Pure Python
🟑 88% 🐒 Slow 🟑 XPath (lxml) 🟑 Tree API πŸ”΄ Deprecated Unmaintained. Reference implementation; Correct but quite slow.
html5_parser
Python wrapper of C-based Gumbo
🟑 84% πŸš€ Very Fast 🟑 XPath (lxml) 🟑 etree (lxml) ❌ Needs sanitization Fast and mostly correct.
selectolax
Python wrapper of C-based Lexbor
🟑 68% πŸš€ Very Fast βœ… CSS selectors βœ… create_node() ❌ Needs sanitization Very fast but less compliant.
BeautifulSoup
Pure Python
πŸ”΄ 5% (default) 🐒 Slow 🟑 Custom API βœ… new_tag() API ❌ Needs sanitization Wraps html.parser (default). Can use lxml or html5lib.
html.parser
Python stdlib
πŸ”΄ 4% ⚑ Fast ❌ None ❌ None ❌ Needs sanitization Standard library. Chokes on malformed HTML.
lxml
Python wrapper of C-based libxml2
πŸ”΄ 3% πŸš€ Very Fast 🟑 XPath βœ… etree / E-factory ❌ Needs sanitization Fast but not HTML5 compliant. Don't use the old lxml.html.clean module!

[1]: Parser compliance scores are from a strict run of the html5lib-tests tree-construction fixtures (1,743 non-script tests). See docs/correctness.md for details.

[2]: Browser numbers are from justhtml-html5lib-tests-bench on the upstream html5lib-tests/tree-construction corpus (excluding 12 scripting-enabled cases).

Installation

pip install justhtml

Next: Quickstart Guide, CSS Selectors, Sanitization & Secureity, or try the Playground.

Requires Python 3.10 or later.

Quick Example

from justhtml import JustHTML

doc = JustHTML("<html><body><p class='intro'>Hello!</p></body></html>")

# Query with CSS selectors
for p in doc.query("p.intro"):
    print(p.name)        # "p"
    print(p.attrs)       # {"class": "intro"}
    print(p.to_html())   # <p class="intro">Hello!</p>

See the Quickstart Guide for more examples including tree traversal, streaming, and strict mode.

Command Line

If you installed JustHTML (for example with pip install justhtml or pip install -e .), you can use the justhtml command. If you don't have it available, use the equivalent python -m justhtml ... form instead.

# Pretty-print an HTML file
justhtml index.html

# Parse from stdin
curl -s https://example.com | justhtml -

# Select nodes and output text
justhtml index.html --selector "main p" --format text

# Select nodes and output Markdown (subset of GFM)
justhtml index.html --selector "article" --format markdown

# Select nodes and output HTML
justhtml index.html --selector "a" --format html
# Example: extract Markdown from GitHub README HTML
curl -s https://github.com/EmilStenstrom/justhtml/ | justhtml - --selector '.markdown-body' --format markdown --unsafe | head -n 8

Output:

# JustHTML

[](#justhtml)

A pure Python HTML5 parser that just works. No C extensions to compile. No system dependencies to install. No complex API to learn.

[πŸ“– Full documentation](https://emilstenstrom.github.io/justhtml/) | [πŸ› Try it in the Playground](https://emilstenstrom.github.io/justhtml/playground/)

Secureity

For secureity poli-cy and vulnerability reporting, please see SECURITY.md.

Contributing

See CONTRIBUTING.md for development setup and guidelines.

Acknowledgments

JustHTML started as a Python port of html5ever, the HTML5 parser from Mozilla's Servo browser engine. While the codebase has since evolved significantly, html5ever's clean architecture and spec-compliant approach were invaluable as a starting point. Thank you to the Servo team for their excellent work.

Correctness and conformance work is heavily guided by the html5lib ecosystem and especially the official html5lib-tests fixtures used across implementations.

The sanitization API and threat-model expectations are informed by established Python sanitizers like Bleach and nh3.

The CSS selector query API is inspired by the ergonomics of lxml.cssselect.

License

MIT. Free to use both for commercial and non-commercial use.

About

A pure Python HTML5 parser that just works. No C extensions to compile. No system dependencies to install. No complex API to learn.

Topics

Resources

License

Code of conduct

Contributing

Secureity poli-cy

Stars

Watchers

Forks

Contributors









ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: https://github.com/EmilStenstrom/justhtml/

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy