Skip to content

niklasf/python-tinyhtml

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

tinyhtml

A tiny library to safely render compact HTML5 from Python expressions.

Test status PyPI package

Introduction

This is the entire API. The following documentation is longer than the implementation.

>>> from tinyhtml import html, h, frag, raw

The most important function is h(). Below you see how to render attributes, normal elements, and void/self-closing elements.

>>> html(lang="en")(
...     h("head")(
...         h("meta", charset="utf-8"),
...     ),
... ).render()
'<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></head></html>'

Use frag() to pass around groups of elements.

>>> frag(
...     h("h1")("Lorem ipsum ..."),
...     h("p")("... dolor sit amet."),
... )
raw('<h1>Lorem ipsum ...</h1><p>... dolor sit amet.</p>')

Of course all content and attributes are properly escaped. Use raw() as an escape hatch to render unescaped HTML.

>>> print(h("a", title="&<>\"'")("&<>\"'").render())
<a title="&amp;&lt;&gt;&quot;'">&amp;&lt;&gt;"'</a>

>>> print(raw("<!-- 💥"))
<!-- 💥

Installing

pip install tinyhtml

Features and patterns

  • Supports Python 3.7+.

  • Output is compact: Naturally produces no superfluous whitespace between elements.

  • Fragments provide _repr_html_() for Jupyter Notebook integration.

  • Includes mypy typings.

    >>> from tinyhtml import Frag
  • Write templates as functions.

    >>> def layout(title: str, body: Frag) -> Frag:
    ...     return html()(
    ...        h("head")(
    ...            h("title")(title),
    ...        ),
    ...        h("body")(body)
    ...     )
    
    >>> layout("Hello world", frag(
    ...     h("h1")("Hello world"),
    ...     h("p")("Lorem ipsum dolor sit amet."),
    ... ))
    raw('<!DOCTYPE html><html><head><title>Hello world</title></head><body><h1>Hello world</h1><p>Lorem ipsum dolor sit amet.</p></body></html>')
  • Use str, int, other fragments, None, or iterables of these as child elements. (Note that rendering consumes the iterables, so fragments using generators can be rendered only once.)

    >>> h("ul")(
    ...     h("li")(n) for n in range(3)
    ... )
    raw('<ul><li>0</li><li>1</li><li>2</li></ul>')
    
    >>> h("ul")(
    ...     h("li")("Foo") if False else None,
    ...     h("li")("Bar"),
    ... )
    raw('<ul><li>Bar</li></ul>')
  • Use str, int, None, iterables of these, bool, or dictionaries with boolean values as attributes.

    >>> h("input", type="checkbox", checked=True, disabled=False)
    raw('<input type="checkbox" checked>')
    
    >>> h("body", klass=["a", "b"])()
    raw('<body class="a b"></body>')
    
    >>> h("body", klass={
    ...    "a": True,
    ...    "b": False,
    ... })()
    raw('<body class="a"></body>')
  • Use klass instead of class, append a trailing underscore (for_), or use underscores instead of dashes (http_equiv) for attribute names that cannot be Python identifiers.

    >>> h("div", klass="container")()
    raw('<div class="container"></div>')
    
    >>> h("label", for_="name")("Name")
    raw('<label for="name">Name</label>')
    
    >>> h("meta", http_equiv="refresh", content=10)
    raw('<meta http-equiv="refresh" content="10">')
  • Render fragments as str, or into a list of str for efficient string building.

    >>> frag("Hello world", "!").render()
    'Hello world!'
    
    >>> builder = []
    >>> frag("Hello world", "!").render_into(builder)
    >>> builder
    ['Hello world', '!']
    >>> "".join(builder)
    'Hello world!'
  • Does not support comment nodes, unescapable raw text elements (like inline styles and scripts), or foreign elements (like inline SVG). Instead, reference external files, or use raw() with appropriate caution.

Acknowledgements

Inspired by (the good parts of) ScalaTags.

License

Licensed under the Apache License, Version 2.0, or the MIT license, at your option.

About

A tiny library to safely render compact HTML5 from Python expressions.

Topics

Resources

License

Apache-2.0, Unknown licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
Unknown
LICENSE-MIT

Stars

Watchers

Forks

Sponsor this project