Skip to main content

HTML 5 Generator

Project description

https://img.shields.io/pypi/l/htmlgen.svg https://img.shields.io/github/release/srittau/python-htmlgen/all.svg https://img.shields.io/pypi/v/htmlgen.svg https://travis-ci.org/srittau/python-htmlgen.svg?branch=master

Library to generate HTML from classes.

Basic usage:

>>> from htmlgen import Division, Span
>>> Division("This is ", Span("important!"), "!")

A more verbose example:

>>> span = Span("important")
>>> span.add_css_classes("important")
>>> div = Division()
>>> div.id = "my-block"
>>> div.append("This is ")
>>> div.append(span)
>>> div.append("!")

A tree constructed like this can be converted to a string:

>>> str(div)
'<div id="my-block">This is <span class="important">important</span>!</div>'
>>> "<p>This is {}!</p>".format(span)
'<p>This is <span class="important">important</span>!</p>'

Alternatively, all elements can be used as iterators, for example to return them from a WSGI callback:

>>> def application(env, start_response):
...     start_response("200 OK", [("Content-Type", "text/html")])
...     return div

There are two different ways to render children of HTML elements. The tree construction approach shown above is mainly suitable for elements with few children. The disadvantage of this approach is that the whole tree must be constructed in memory. An alternative way, best suited for custom sub-classes of elements, is to override the generate_children method of the Element class:

>>> class MyBlock(Division):
...     def __init__(self):
...         super(MyBlock, self).__init__()
...         self.id = "my-block"
...     def generate_children(self):
...         yield "This is "
...         span = Span("important")
...         span.add_css_classes("important")
...         yield span
...         yield "!"
>>> str(MyBlock())
'<div id="my-block">This is <span class="important">important</span>!</div>'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

htmlgen-1.0.0-py3-none-any.whl (46.2 kB view details)

Uploaded Python 3

htmlgen-1.0.0-py2-none-any.whl (46.2 kB view details)

Uploaded Python 2

File details

Details for the file htmlgen-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for htmlgen-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e5751ad8e231ee336917ef8e977f4e9a0c54421e91f53b00eb1812e539644dd
MD5 dc2bf526f3f14e9a86d18607ee4eda0e
BLAKE2b-256 821b730bc4603022123547f942649e3afe877586f6d5c75f34d77cbf4aa63bdd

See more details on using hashes here.

File details

Details for the file htmlgen-1.0.0-py2-none-any.whl.

File metadata

File hashes

Hashes for htmlgen-1.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 aebbfc6f60d26d6130a3b344c2578fa7f97ca52f7c5a756d5c9fe9ef22fa3596
MD5 83fde5febd53bd7d4e3c607b0f6069ce
BLAKE2b-256 a5bd08f6815113152a9babacd06752ea56f037a8dbbb72a9b0b84257de496a8d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page