Composable HTML generation in python
Project description
html-compose
✨ Composable HTML generation in Python 3.10+ with extensive type hinting 📚
from html_compose import a, article, body, br, head, html, p, strong, title
>>> username = "github wanderer"
>>> print(
html()[
head()[title()[f"Welcome, {username}!"]],
body()[
article()[
p()["Welcome to the internet", strong()[username], "!"],
br(),
p()[
"Have you checked out this cool thing called a ",
a(href="https://google.com")["search engine"],
"?",
],
]
],
].render()
)
<html><head><title>Welcome, github wanderer!</title></head><body><article><p>Welcome to the internet<strong>github wanderer</strong>!</p><br /><p>Have you checked out this cool thing called a <a href="https://google.com">search engine</a>?</p></article></body></html>
Features ✨
- ⚡ Lazy evaluation leading to performance gains
- 🛏 Define children via
[]syntax:from html_compose import p, strong p()["a", strong()["bold"], "statement"] #<p>a <strong>bold</strong> statement # The above is identical to p().append(["a", strong()["bold"], "statement"])
- 🧩 Skip constructor via same
[]syntax for text only elements.from html_compose import ul, li ul[ li["Look ma!"] li["No constructor!"], li["This feels natural"], li["for text elements"] ]
- 🌐 Define attributes in a variety of ways:
from html_compose import div ## With type hints div(tabindex=1) div(attrs=[div.tabindex(1)]) # <div tabindex=1></div> ## Positionally div([div.tabindex(1)]) # <div tabindex=1></div> div({"data-for-something": "foo"}) # <div data-for-something="foo"></div> ## With class dictionary resolution is_dark_mode = False div(class_={"dark-mode": is_dark_mode, "flex": True}) # <div class="flex"></div> ## Combine the two ` div(attrs=[div.class_("flex")], class_={"dark-mode": True}) # <div class="flex dark-mode"></div>
- 🎭 Type hints for the editor generated from WhatWG spec
Goals 🛠️
- Be a stable layer for further abstraction of client-server model applications and libraries
- Put web developer documentation in the hands of developers via their IDE
- 🚀 Opinionate as few things as possible favoring expression; stay out of the way
- Clearly mark any potentially breaking changes through discovered development optimizations in changelog
Magic decisions 🪄
The code base is littered with "Magic" decisions to make your life easier, but the keen developer will want to know exactly what these are.
Children 🌟
The children iterator/resolver makes some decisions to marshal input into strings:
- 🔒 All text elements and attribute values are escaped by default to prevent XSS
- To inject unsafe text it must explicitly be marked unsafe via
html_compose.unsafe_text.
- To inject unsafe text it must explicitly be marked unsafe via
- 💡 Bools are translated to string
true/false - ✨ Floats passed as-is are converted to strings by rounding to a fixed precision. The default is defined in
ElementBase.FLOAT_PRECISIONand can be overridden in two ways:- Set
ElementBase.FLOAT_PRECISIONto the desired value - global - Set
YourElement.FLOAT_PRECISIONto the desired value - applies just to the element. i.e.td.FLOAT_PRECISION
- Set
- 🏷️ Children can be callables, like functions, lambdas, or classes that implement
__call__. These are resolved at render time.
Inspiration ✨
Inspiration and motivation for this library are listed below.
- Throw out your templates by Tavis Rudd
- The Principle from pydantic FastUI
- htpy for its syntax ideas, which itself is inspired by projects not in this list
- htmx Transition library to a "dumb client" model
- alpinejs Another "dumb client" transition library
- hyperaxe Similar tool for JavaScript
- flexx A Python super toolkit for developing user applications
- lit lit and the web component engine that it wraps
The WhatWG spec 📝
The Web Hypertext Application Technology Working Group (WHATWG) is a community of people interested in evolving HTML and related technologies.
They produce a document which defines the HTML spec.
We parse this document to produce code-generated type hints and annotations.
Generating ⚙️
For maintainers.
In the virtual environment, run python tools/spec_generator.py followed by python tools/generate_attributes.py or python tools/generate_elements.py
This will update the tools/generated directory.
We track this in git so we can see 1:1 changes to our generation.
The generated code is moved into the actual src directory and then the repo tooling is run over it:
rye lint --fixrye fmt
Maintaining ⚖️
Elements or attributes may be slightly different from the live package. These should be merged in.
Code generation was used as a trick to bootstrap this package quickly, but the web spec changes quickly, as tools such as the popover API were recently added.
Maintainers will run the generating step, which will update the tools/generated/ classes.
Updates pertaining to those changes should be shipped into the actual module under src.
Dependencies
- PalletsProjects markupsafe for text escaping
beautifulsoup4to optionally beautify HTML
Development tools ⚙️
- Developed using rye
- Linted and formatted with ruff. Differences from black
License
MIT.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file html_compose-0.3.0.tar.gz.
File metadata
- Download URL: html_compose-0.3.0.tar.gz
- Upload date:
- Size: 117.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f56915d17c537082d3cc008e105e7a650f2d1d8074578c6bac0325ca14e4af8b
|
|
| MD5 |
31f6026559e379ed25f3b333f4fd8ff8
|
|
| BLAKE2b-256 |
73fec6139863a1fbe3fe852acc70ada488f0576f7fde6ac9da3479c88b81249f
|
File details
Details for the file html_compose-0.3.0-py3-none-any.whl.
File metadata
- Download URL: html_compose-0.3.0-py3-none-any.whl
- Upload date:
- Size: 83.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6c5718be90954f837e3be86e4a359ad6f470b7432ef0816d4ca91de92a0724e6
|
|
| MD5 |
e60aac2306e5fdacca72cda61e14cd6c
|
|
| BLAKE2b-256 |
e0d2c806fa9fe701af9f7aad9f0192f14b6b4c1ff62a9c2c29086ace160a27ab
|
