Template-less html rendering in Python
Project description
simple_html
Template-less. Type-safe. Minified by default.
simple_html is built to simplify HTML rendering in Python. No templates needed. Just create HTML in normal Python. In most cases, the code will be more concise than standard HTML. Other benefits include:
- typically renders fewer bytes than template-based rendering
- types mean your editor and tools can help you write correct code faster
- no framework needed
- lightweight
Installation
pip install simple-html
Usage
from simple_html.nodes import body, head, html, p
from simple_html.render import render
node = html(
head,
body(
p.attrs(id="hello")(
"Hello World!"
)
)
)
render(node) # returns: <html><head></head><body><p id="hello">Hello World!</p></body></html>
Strings are escaped by default, but you can pass in SafeStrings to avoid escaping.
from simple_html.nodes import br, p, SafeString
from simple_html.render import render
node = p(
"Escaped & stuff",
br,
SafeString("Not escaped & stuff")
)
render(node) # returns: <p>Escaped & stuff<br/>Not escaped & stuff</p>
For convenience, many tags are provided, but you can create your own as well:
from simple_html.nodes import TagBase
from simple_html.render import render
custom_elem = TagBase("custom-elem")
render(
custom_elem.attrs(id="some-custom-elem-id")(
"Wow"
)
) # returns: <custom-elem id="some-custom-elem-id">Wow</custom-elem>
Likewise, some attributes have been created as type-safe presets. Note that there are multiple ways to create attributes. The examples below are all equivalent:
from simple_html.attributes import height, id_
from simple_html.nodes import div
# **kwargs: recommended for most cases
div.attrs(id="some-id", height="100")
# *args: useful for attributes that may be reserved keywords or when type constraints are desired.
# Presets, raw tuples, and kwargs can be used interchangeably.
div.attrs(("id", "some-id"), ("height", "100"))
div.attrs(("id", "some-id"), height(100))
div.attrs(id_("some-id"), height(100))
div.attrs(id_("some-id"), height="100")
# each would render to: <div id="some-id" height="100"></div>
You can build your own presets, using str_attr, int_attr, or bool_attr. For instance, here are
several of the attribute preset definitions
from simple_html.attributes import bool_attr, int_attr, str_attr
checked = bool_attr('checked')
class_ = str_attr('class')
cols = int_attr('cols')
But anything that renders to the type of Attribute will work.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for simple_html-0.5.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e5cd373a50cde70600b04b07bf721dd0b88e383e5c37beca9c7a39ce989b2b37 |
|
| MD5 | d3e3cbcec55b18d0924ac353723b98cb |
|
| BLAKE2b-256 | 7d1da4ec09c9e208e3db4caf1f33ca5e824f0c6d5fdff9a79691a99650b37d72 |
