htmldoom 0.6.1

An intuitive, high performance HTML rendering framework

htmldoom

An intuitive, high performance HTML rendering framework

    

Usage

A basic tag

>>> from htmldoom import render, elements as e
>>> 
>>> print(render(e.p(style="color='red'")("This is a paragraph")))
<p style="color:'red';">This is a paragraph</p>

A functional style foreach loop with a switch case

>>> from htmldoom import elements as e
>>> from htmldoom import functions as fn
>>> 
>>> tuple(fn.foreach(["good", "bad", "evil"])(
...     lambda x: fn.switch({
...         x == "good": lambda: e.span(style="color: green")(f"this is {x}"),
...         x == "bad": lambda: e.span(style="color: yellow")(f"this is {x}"),
...         x == "evil": lambda: e.span(style="color: red")(f"this is {x}"),
...         fn.Case.DEFAULT: lambda: fn.Error.throw(ValueError(x)),
...     })
... ))
(b'<span style="color: green">this is good</span>',
 b'<span style="color: yellow">this is bad</span>',
 b'<span style="color: red">this is evil</span>')

A fast dynamic elements rendering mechanism

Choose whichever syntax suits you:

Syntax 1

>>> @renders(
...     e.p()("{x}"),
...     e.p()("another {x}"),
... )
... def render_paras(data: dict) -> dict:
...     return {"x": data["x"]}
>>> 
>>> render_paras({"x": "awesome paragraph"})
<p>awesome paragraph</p><p>another awesome paragraph</p>

Syntax 2

>>> render_paras = renders(
...     e.p()("{x}"),
...     e.p()("another {x}"),
... )(lambda data: {"x": data["x"]})
>>> 
>>> render_paras({"x": "awesome paragraph"})
<p>awesome paragraph</p><p>another awesome paragraph</p>

Find more examples here

Q/A

What is the goal here?

The primary goal is to make writing HTML pages cleaner, easier, safer and intuitive using Python.

What about performance?

Although performance is not the primary goal here, it should not be a roadblock. htmldoom is copying the syntax and some of the rendering properties of elm, an existing fast and purely functional programming language that specializes in rendering HTML in virtual doms. Elm does all the optimisation internally, which I believe can be implemented in Python to a great extent.
Furthermore, if we follow the the DOM size recommendations, i.e.

• less than 1500 nodes total.
• maximum depth of 32 nodes.
• no parent node with more than 60 child nodes.

htmldoom should perform really well.

Plugins and ecosystem

• moodlmth: Convert raw HTML pages into python source code

• pyramid_htmldoom: htmldoom rendering library plugin for Pyramid

Contributing

Check out the contributing guidelines.