etgen.html

Defines an ElementTree Builder for generating HTML documents.

etgen.html.E

The global ElementTree Builder object.

Usage:

>>> # from etgen.html import E
>>> import lxml.usedoctest
>>> html = E.html(
...            E.head( E.title("Hello World") ),
...            E.body(
...              E.h1("Hello World !"),
...              CLASS("main")
...            )
...        )
>>> print (tostring_pretty(html))
<html>
  <head>
    <title>Hello World</title>
  </head>
  <body class="main">
    <h1>Hello World !</h1>
  </body>
</html>
>>> kw = dict(title=u'Ein süßes Beispiel')
>>> kw.update(href="foo/bar.html")
>>> btn = E.button(type='button', **CLASS('x-btn-text x-tbar-upload'))
>>> html = E.a(btn, **kw)
>>> print (tostring_pretty(html))
<a href="foo/bar.html" title="Ein süßes Beispiel">
  <button class="x-btn-text x-tbar-upload" type="button"/>
</a>

You can also do the opposite, i.e. parse HTML:

>>> from lxml import etree
>>> E_raw = etree.fromstring
>>> html = E_raw('''<a href="foo/bar.html"
... title="Ein s&#252;&#223;es Beispiel">
... <button class="x-btn-text x-tbar-upload" type="button"/>
... </a>''')
>>> print(tostring_pretty(html))
<a href="foo/bar.html" title="Ein süßes Beispiel">
  <button class="x-btn-text x-tbar-upload" type="button"/>
</a>
>>> print(tostring(E_raw(
...     '<ul type="disc"><li>First</li><li>Second</li></ul>')))
<ul type="disc"><li>First</li><li>Second</li></ul>
>>> html = E.div(E.p("First"), E.p("Second"))
>>> print(tostring_pretty(html))
<div>
  <p>First</p>
  <p>Second</p>
</div>
>>> html.attrib['class'] = 'htmlText'
>>> print(tostring_pretty(html))
<div class="htmlText">
  <p>First</p>
  <p>Second</p>
</div>

Avoid self-closing tags

lxml generates self-closing tags for elements without children:

>>> print(tostring(E.div()))
<div/>

Some environments refuse empty div> elements and interpret a <div/> as <div> (don’t ask me why). You can avoid the self-closing tag by setting the text attribute to an empty string:

>>> html = E.div()
>>> html.text = ""
>>> print(tostring(html))
<div></div>

Note that you must set text explicitly. Simply specifying it when instantiating the element is not enough:

>>> print(tostring(E.div("")))
<div/>
>>> print(tostring(E.div(" ")))
<div/>

The real solution would be to use the “html” method when writing the tree to html:

>>> print(tostring(E.div(), method="html"))
<div></div>

TODO: This approach has been active as default value (see disabled line in code of tostring()) and I don’t remember why we disabled it. I suggest to re-enable it and test thoroughly whether this causes regressions (and if yes, why it causes them).

(This module’s source code is available here.)

Functions

CLASS(*args)

lines2p(lines[, min_height])

Convert the given list of text lines lines into a paragraph (<p>) with one <br> between each line.

table_body_row(*cells, **kw)

table_header_row(*headers, **kw)

to_rst(v[, stripped])

tostring(v, *args, **kw)

tostring_pretty(*args, **kw)

Classes

Document(title[, stylesheets])

A pythonic representation of a <body> with a <title> and some <head> tags for stylesheets.

Table()

A pythonic representation of a <table> with <head>, <foot> and <body>.

class etgen.html.Table

Bases: object

A pythonic representation of a <table> with <head>, <foot> and <body>.

class etgen.html.Document(title, stylesheets=None)

Bases: object

A pythonic representation of a <body> with a <title> and some <head> tags for stylesheets.

etgen.html.lines2p(lines, min_height=0, **attrs)

Convert the given list of text lines lines into a paragraph (<p>) with one <br> between each line. If optional min_height is given, add empty lines if necessary.

Examples:

>>> print(tostring(lines2p(['first', 'second'])))
<p>first<br/>second</p>
>>> print(tostring(lines2p(['first', 'second'], min_height=5)))
<p>first<br/>second<br/><br/><br/></p>

If min_height is specified, and lines contains more items, then we don’t truncate:

>>> print(tostring(lines2p(['a', 'b', 'c', 'd', 'e'], min_height=4)))
<p>a<br/>b<br/>c<br/>d<br/>e</p>

This also works:

>>> print(tostring(lines2p([], min_height=5)))
<p><br/><br/><br/><br/></p>