A minimal python dsl for generating html.
Project description
hype
A minimal python dsl for generating html.
Install
Install via pip
pip install hype-html
Alternatively, in the spirit of removing dependencies, you could simply copy/paste the hype/element.py file into your project.
Usage
Hype exposes classes for each html tag.
from hype import *
doc = Doc(Html('Hello World!'))
print(doc)
# <!DOCTYPE html>
# <div>Hello World!</div>
Elements can also be rendered by calling their render method.
doc.render() == str(doc)
Inner HTML
Arguments passed in the element constructor are rendered using the str function and indented (if the element only has one argument it will not be indented.)
body = Body(
H1('Hello World'),
P('This is a paragraph'),
'Just a string',
P('Another paragraph')
)
print(body)
# <body>
# <h1>Hello World</h1>
# <p>This is a paragraph</p>Just a string
# <p>Another paragraph</p>
# </body>
Append to an elements' list of inner html elements.
body = Body(
H1('Hello World'),
P('This is a paragraph'),
'Just a string'
)
body.append(P('Another paragraph'))
print(body)
# <body>
# <h1>Hello World</h1>
# <p>This is a paragraph</p>Just a string
# <p>Another paragraph</p>
# </body>
Attributes
Attributes are passed as keyword arguments to the element's constructor.
span = Span('span', width='50px')
print(span)
# <span width="50px">span</span>
Since some built-in, and possibly custom, attributes conflict with python keywords, keywords will automatically have all leading underscores stripped.
span = Span('span', _id='my-span', width='50px')
print(span)
# <span id="my-span" width="50px">span</span>
Any remaining underscores will be converted to hyphens.
span = Span('span', custom_attrbiute='custom')
print(span)
# <span custom-attribute="custom">span</span>
Also add attributes using a method's attrs method add keyword arguments.
span = Span('span')
span.attrs(_id='my-span', test='test')
print(span)
# <span id="my-span" test="test">span</span>
Custom Elements
If you to create a custom tag, just subtype the Element class and add a tag.
class CustomTag(Element):
tag = 'custom-tag'
tag = CustomTag()
print(tag)
# <custom-tag></custom-tag>
To create a custom self closing tag, subtype the SelfClosingElement class.
class CustomTag(SelfClosingElement):
tag = 'custom-tag'
tag = CustomTag()
print(tag)
# <custom-tag/>
Indents
The indent to be used can be passed as a keyword arg to the Doc constructor.
doc = Doc(content, indent=Indent.TAB)
It can also be passed as a keyword arg when calling and element.
div = Div(H1('Header'))
print(div(indent=Indent.FOUR_SPACES))
# <div>
# <h1>Header</h1>
# </div>
Async Elements
If your elements content's use coroutines you can use the async elements in hype.asyncio.
The API is nearly identical with two main differences. Of course, the render method is a coroutine. Because of they do not render when calling the str function on them You must explicitly call their render method instead.
import ayncio
from hype.asyncio import *
div = Div(H1('Header'))
result = asyncio.run(div.render)
print(result)
# <div>
# <h1>Header</h1>
# </div>
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 hype_html-2.0.0.tar.gz.
File metadata
- Download URL: hype_html-2.0.0.tar.gz
- Upload date:
- Size: 18.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/4.4.0-19041-Microsoft
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3c6c539b7f706a404d9b5a5c44babe057ba34ecb660899af32bf7def045a12e5 |
|
| MD5 | 89bdeece836a3d2ffc1f7f8e05dc7ff9 |
|
| BLAKE2b-256 | 06565d8919dd8fffcf01869a75f71314a18a602913251bd1e047b1209f033321 |
File details
Details for the file hype_html-2.0.0-py3-none-any.whl.
File metadata
- Download URL: hype_html-2.0.0-py3-none-any.whl
- Upload date:
- Size: 20.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/4.4.0-19041-Microsoft
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bc40fe9d5c1a110b0c3a900317390cd378ada8cdf568123803be1497d5dd9f86 |
|
| MD5 | 7f49a33d8fffd487cb0a4f76739c426a |
|
| BLAKE2b-256 | 3957a8e9de18236da4e01611c397b90519984c18807e75936604d04ad0f0a158 |
