Core Functions - Render HTML

The core module contains the html function which renders HTML from data structure. All strings are escaped by default; to prevent a string to be escaped, use the raw function.

Syntax Reminder

Hy

=> (html ["p"])
"<p><p/>"
=> (html ["p" "some text"])
"<p>some text</p>"
=> (html ["p" {"attr" "an-attr"} "some text"])
"<p attr="an-attr">some text</p>"
=> (html ["p" (dict :attr "an-attr")
            ["div" "lorem"]
            ["div" "ipsum"]])
"<p attr=\"an-attr\">
  <div>lorem</div>
  <div>ipsum</div>
</p>"
=> (html ["p" {"attr" "an-attr"}
            *[["div" "lorem"]
              ["div" "ipsum"]]])
"<p attr=\"an-attr\">
  <div>lorem</div>
  <div>ipsum</div>
</p>"
=> (html ["p" {"attr" "an-attr"}
            (iter [["div" "lorem"]
                   ["div" "ipsum"]])])
"<p attr=\"an-attr\">
  <div>lorem</div>
  <div>ipsum</div>
</p>"

Python

>>> html(['p'])
'<p></p>'
>>> html(['p', 'some text'])
'<p>some text</p>'
>>> html(['p', {'attr': 'an-attr'}, 'some text'])
'<p attr="an-attr">some text</p>'
>>> html(['p', {'attr': 'an-attr'},
          ['div', 'lorem'],
          ['div', 'ipsum']])
'<p attr="an-attr">
  <div>lorem</div>
  <div>ipsum</div>
</p>'
>>> html(['p', {'attr': 'an-attr'},
          *[['div', 'lorem'],
            ['div', 'ipsum']]])
'<p attr="an-attr">
  <div>lorem</div>
  <div>ipsum</div>
</p>'
>>> html(['p', {'attr': 'an-attr'},
          iter([['div', 'lorem'],
                ['div', 'ipsum']])])
'<p attr="an-attr">
  <div>lorem</div>
  <div>ipsum</div>
</p>'

String Escaping

By default, html escapes all strings. This behaviour can be customized with escape-strings parameter:

Hy

=> (setv content ["p" "line<br>other"])
=> (html content :escape-strings False)
"<p>line<br>other</p>"

Python

>>> content = ['p', 'line<br>other']
>>> html(content, escape_strings=False)
'<p>line<br>other</p>'

raw function can be used to prevent a single expression to be escaped:

Hy

=> (setv content ["p" (raw "line<br>other")])
=> (html content)
"<p>line<br>other</p>"

Python

>>> content = ['p', raw('line<br>other')]
>>> html(content)
'<p>line<br>other</p>'

Note that html returns a raw string:

Hy

=> (setv content (html ["p" "some text"]))
=> (html ["div" content])
"<div><p>some text</p></div>"

Python

>>> content = html(['p', 'some text'])
>>> html(['div', content])
'<div><p>some text</p></div>'

API

Source code: hyccup/core.hy