Installation

$ tar xzf Webext-0.0.1.tar.gz
$ cd Webext-0.0.1
$ sudo python setup.py install

Functions

Webext provides following functions:

• webext.escape_html()

  • escapes HTML special characters (< > & “).

  • converts unicode into str with ‘utf8’ encoding.

  • converts None into empty string (= ‘’).

• webext.escape()

  • alias to webext.escape_html()

• webext.to_str()

  • converts argument into str (same as str())

  • converts unicode into str with ‘utf8’ encoding.

  • converts None into empty string (= ‘’).

• webext.get_encoding()

  • returns default encoding for escape_html() and to_str()

  • default value is ‘utf8’

• webext.set_encoding(arg)

  • sets default encoding for escape_html() and to_str()

Example

### import escape_html() and to_str()
>>> from webext import escape_html, to_str

### escape_html() escapes html special characters
>>> escape_html('< > & "')
'&lt; &gt; &amp; &quot;'

### to_str() and escape_html() convert unicode into str with 'utf8' encoding
>>> to_str(u'\u65e5\u672c\u8a9e')
'\xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e'
>>> escape_html(u'\u65e5\u672c\u8a9e')
'\xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e'

### to_str() and escape_html() convert None into empty string
### (this is more desirable than str() for web application)
>>> to_str(None)
''
>>> escape_html(None)
''

Using with Tenjin

Tenjin is a very fast template engine implemented in pure Python. You can make Tenjin much faster by using Webext.

import tenjin
from tenjin.helpers import *
from webext import to_str, escape    # use webext's to_str() and escape() instead of tenjin's
engine = tenjin.Engine()
context = { 'items': ['<AAA>', 'B&B', '"CCC"'] }
print engine.render('example.pyhtml', context)

Tenjin’s benchmark now supports Webext. The following is an example of benchmark result on Mac OS X 10.6, Intel Core Duo 2GHz, Tenjin 0.9.0. This shows that Webext boosts Tenjin especially html escaping.

## without html escaping
$ python bench.py -n 10000 tenjin tenjin-
webext
import tenjin ... done. (0.001740 sec)
import webext ... done. (0.000466 sec)
*** loading context data (file=bench_context.py)...
*** start benchmark
*** ntimes=10000
                                    utime     stime     total      real
tenjin                             3.8100    0.0400    3.8500    3.8584
tenjin-webext                      2.5000    0.0300    2.5300    2.5367

## with html escaping
$ python bench.py -e -n 10000 tenjin tenj
in-webext
import tenjin ... done. (0.001580 sec)
import webext ... done. (0.000459 sec)
*** loading context data (file=bench_context.py)...
*** start benchmark
*** ntimes=10000
                                    utime     stime     total      real
tenjin                             7.2100    0.0500    7.2600    7.2935
tenjin-webext                      2.9800    0.0400    3.0200    3.0476