HTML5Tagger

1.3.0 · active · verified Sat Apr 11

HTML5Tagger is a Python library designed for Pythonic HTML generation and templating without the need for external template files. It provides a simplified HTML5 syntax, allowing developers to create entire HTML documents using only Python code. Maintained under the Sanic organization, it aims for speed and simplicity, offering a pure Python implementation with no external dependencies. The library sees infrequent but consistent updates, with the latest major release in March 2023.

Warnings

gotcha Automatic Tag Closing and Empty Elements: Tags are automatically closed when new content or another tag is added. Setting attributes alone does not close an element. For self-closing or empty elements (e.g., `<script src='...'></script>`) where subsequent content should not be nested, explicitly close with `(None)`.
Fix: To close an empty element (e.g., `<script>`) or prevent further nesting into an empty tag after setting attributes, pass `None` as the first argument: `doc.script(None, src='path/to/script.js')`.
gotcha Security: Unsafe use of `html5tagger.HTML()` with untrusted input can lead to Cross-Site Scripting (XSS). While content is generally auto-escaped, `html5tagger.HTML(string)` explicitly marks `string` as safe HTML, bypassing escaping.
Fix: NEVER use `html5tagger.HTML()` to wrap user-generated or untrusted content. Only use it for HTML strings that you have explicitly verified as safe. All other content should be passed directly to HTML5Tagger elements for automatic escaping.
gotcha Templating behavior: When using template variables, `doc.TemplateName_` does NOT close the preceding tag but inserts the variable's content *inside* any currently open element. This differs from how new tag calls (`doc.p(...)`) close prior tags.
Fix: Be mindful of the current nesting context when inserting template variables. If the variable should be at a different level, ensure the preceding elements are correctly closed by adding content or explicit `(None)` calls before inserting the template.
deprecated Potential deprecation of non-underscored `_script` and `_style` methods: The introduction of `_script` and `_style` special methods in 2023 suggests a potential future shift to primarily use underscored versions for special element handling, with the non-underscored versions potentially being deprecated or changed.
Fix: While not yet deprecated, consider using `_script` and `_style` for clarity and future compatibility if explicitly handling script/style blocks. Consult the latest documentation for definitive guidance on these methods.

Install

pip install html5tagger Install with pip

Imports

Document
```
from html5tagger import Document
```
Primary class for generating full HTML5 documents with a DOCTYPE declaration.
E
```
from html5tagger import E
```
An empty builder for creating HTML snippets.
HTML
```
from html5tagger import HTML
```
Used to wrap preformatted HTML strings to prevent automatic escaping, especially for known safe content.

Quickstart

This quickstart demonstrates how to create a basic HTML5 document using `html5tagger`. It shows how to initialize a `Document` object, add standard HTML elements using attribute access (e.g., `doc.h1`), pass attributes as keyword arguments, nest elements using `with` statements, and utilize template variables for dynamic content. Finally, it shows how to render the complete HTML string.

from html5tagger import Document, E

# Create a full HTML document
doc = Document(
    E.TitleText_,
    lang="en", # HTML tag attributes as keyword arguments
    _urls=["style.css", "script.js"], # Special argument for linking resources
)

# Add elements directly or with context managers
with doc.body:
    doc.h1("Welcome to html5tagger!")
    with doc.p("This is an example of creating HTML content in Python. It's ") as p:
        p.strong("easy")
        p(" and ")
        p.em("intuitive")
        p(".")
    
    # Nesting elements
    with doc.ul:
        doc.li("No manual closing tags for most elements.")
        doc.li("Attributes are passed as keyword arguments.")
        doc.li.a(href="https://github.com/sanic-org/html5tagger")("Check out the GitHub repo!")
    
    # Add a paragraph with a dynamic title using template variables
    doc.p(doc.IntroText_, id="intro-paragraph")

# Fill in template variables (optional)
doc.TitleText = "My Dynamic Page"
doc.IntroText = "Here's some dynamic content."

# Render the document to an HTML string
html_output = doc.render()
print(html_output)

view raw JSON →