HTML generator using pure Python
Project description
domify
HTML generator using pure Python.
Simple example:
from domify import html_elements as e
html = e.Html(lang="en")
with html:
with e.Head():
e.Meta(charset="utf-8")
e.Title("Example page")
with e.Body():
e.H1("Hello world")
e.P("Lorem ipsum ", e.I("dolor sit amet"))
print(str(html))
HTML output (formatted for legibility):
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Example page</title>
</head>
<body>
<h1>Hello world</h1>
<p>Lorem ipsum <i>dolor sit amet</i></p>
</body>
</html>
Note: every example on this page assumes domify has already been imported:
from domify import html_elements as e
domify.html_elements contains a class for each HTML element, with the first letter
converted to uppercase:
p = e.P("Lorem ipsum dolor sit amet")
print(str(p))
<p>Lorem ipsum dolor sit amet</p>
You can pass strings or additional elements as positional arguments, and they will be treated as children:
p = e.P("Lorem ipsum dolor sit amet", e.Br(), "consectetur adipiscing elit.")
print(str(p))
<p>
Lorem ipsum dolor sit amet
<br>
consectetur adipiscing elit.
</p>
Attributes can be passed as keyword arguments, optionally appending an underscore to
attributes which are reserved keywords in python (for example class). Integers and
floats are automatically converted to strings, while additional underscores are replaced
with dashes (especially useful for data and aria attributes):
btn = e.Button("Click!", type="submit", class_="someclass", data_order=155)
print(str(btn))
<button type="submit" class="someclass" data-order="155">Click!</button>
HTML5 boolean attributes accept a boolean value instead:
text_input = e.Input(type="text", required=True, disabled=False)
print(str(text_input))
<input type="text" required>
Attributes can be added or modified by subscripting an element object:
html = e.Html()
html["lang"] = "en"
print(str(html))
<!DOCTYPE html>
<html lang="en"></html>
Children can be modified (but not added) by subscripting as well:
p = e.P("Text node 1", e.Br(), "Text node 2")
p[0] = "Text node 3"
p[1:] = [e.Hr()]
print(str(p))
<p>
Text node 3
<hr>
</p>
The del keyword can be used to delete both attributes and children:
div = e.Div("foo", e.Br(), "bar", e.Br(), "bar", id="someid", class_="someclass")
del div["class"]
del div[3:]
print(str(div))
<div id="someid">
foo
<br>
bar
</div>
add_class and remove_class can be used to manage classes:
div = e.Div(class_="some-class some-other-class")
div.remove_class("some-class")
div.add_class("third-class")
print(str(div))
<div class="some-other-class third-class"></div>
Children can be added using the add or insert methods, which return the newly added
element:
div = e.Div()
span = div.add(e.Span())
span.add("First line")
span.add(e.Br())
span.add("Second line")
div.insert(0, e.H1("Title"))
print(str(div))
<div>
<h1>Title</h1>
<span>
First line
<br>
Second line
</span>
</div>
Context managers can be used to add child elements too:
with e.Select() as select:
e.Option("Option 1", value=1)
e.Option("Option 2", value=2)
e.Option("Option 3", value=3)
print(str(select))
<select>
<option value="1">Option 1</option>
<option value="2">Option 2</option>
<option value="3">Option 3</option>
</select>
The + operator can be used to concatenate multiple elements and/or strings:
username = "Username: " + e.Input(type="text", name="username")
password = "Password: " + e.Input(type="password", name="password")
login_form = e.Label(username) + e.Label(password)
login_form += e.Button("Login", type="submit")
print(str(login_form))
<label>Username: <input type="text" name="username"></label>
<label>Password: <input type="password" name="password"></label>
<button type="submit">Login</button>
Text nodes can be created using TextNode (this is usually not required, since strings
are automatically coverted):
with e.P() as p:
e.TextNode("Lorem ipsum")
print(str(p))
<p>Lorem ipsum</p>
RawTextNode can be used to add strings without escaping:
with e.P() as p:
e.TextNode("<i>TextNode</i>")
e.Br()
e.RawTextNode("<i>RawTextNode</i>")
print(str(p))
<p>
<i>TextNode</i>
<br>
<i>RawTextNode</i>
</p>
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
File details
Details for the file domify-0.4.0.tar.gz.
File metadata
- Download URL: domify-0.4.0.tar.gz
- Upload date:
- Size: 15.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.0 CPython/3.10.6 Linux/5.15.0-1024-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0ad81eec8a7f22b977ad6ee876b799e74fbcc7c0210414a6eeb74250ab92888a |
|
| MD5 | 988135e94224e0c09b5ea37107616429 |
|
| BLAKE2b-256 | d0d5362914d0c8a9de8bebcfb6c0c6bff779df5046a0c2e3ea943c603e93d515 |
File details
Details for the file domify-0.4.0-py3-none-any.whl.
File metadata
- Download URL: domify-0.4.0-py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.0 CPython/3.10.6 Linux/5.15.0-1024-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 33146ce5cafeb91b7c8a26306cf0e11f774de9d8ce0d99a4cfc4eb3676e4f194 |
|
| MD5 | c5102f2375241dc36c5b467b1ab1c532 |
|
| BLAKE2b-256 | ef54f290a6d5caf38b17772b5733e882a840ca145b9ab625668073aa5856b8e1 |
