Skip to content
An intuitive, high performance HTML rendering framework
Python
Branch: master
Clone or download
Latest commit e7a9da5 Aug 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples cleaner readme example Jul 19, 2019
htmldoom Docstring fix Aug 14, 2019
tests Show better errors Jul 3, 2019
.gitignore
.travis.yml Functional API and performance improvements Jun 26, 2019
CONTRIBUTING.md Fix typecheck Jun 23, 2019
LICENSE Create LICENSE May 25, 2019
README.md cleaner readme example Jul 19, 2019
dev-requirements.txt Fix typecheck Jun 23, 2019
requirements.txt Fix typecheck Jun 23, 2019
setup.py
tox.ini Fix typecheck Jun 23, 2019

README.md

htmldoom

An intuitive, high performance HTML rendering framework

PyPI version PyPI version Build Status codecov Code style: black

Usage

A basic tag

>>> from htmldoom import render, elements as e
>>> 
>>> print(render(
...     e.textarea("required", class_="input")("text")
... ))
<textarea required class="input">text</textarea>

A custom tag

>>> from htmldoom import render, composite_tag
>>> 
>>> clipboard_copy = composite_tag("clipboard-copy")
>>> print(render(
...     clipboard_copy(value="foo")("Copy Me")
... ))
<clipboard-copy value="foo">Copy Me</clipboard-copy>

A fast dynamic elements rendering mechanism

Choose whichever syntax suits you:

Syntax 1

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

Syntax 2

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

NOTE: This mechanism pre-renders the template when the file loads and reuse it.

renders( ...pre-rendered template... )( ...dynamic rendering logic... )

The more elements you pre-render as template, the faster it gets.
If you properly use this mechanism and refactor your dynamic pages into smaller components, it might surpass the performance of traditional template rendering engines.

WARNING: It performs a "{rendered_elements}".format(**returned_data). So each `{` or `}` in the pre-rendered template needs to be escaped with `{{` or `}}`.

A functional style foreach loop with a switch case (probably useless)

>>> 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>')

Find more examples here

Q/A

What is the goal here?

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

What about performance?

Although performance is not the primary goal here, it's been given a very high priority. htmldoom uses pure functions with hashable input parameters as elements. Hence, it makes effective use of caching internally. It also offers a friendly mechanism to pre-render the static parts of the page using the @renders decorator and reuse it.
Also since it helps you (probably forces you) to refactor the webpage into multiple render functions, you are free to use whatever optimisation you prefer. Try putting an @lru_cache in a render function?

Is there any benchmark?

Refer to the benchmarks here.

Plugins and ecosystem

  • moodlmth: Convert raw HTML pages into python source code

Contributing

Check out the contributing guidelines.

NOTE: This file was generated using this script.

You can’t perform that action at this time.