blob: 8b6b7d25107d506388fc3ceb81902642a7b91667 [file]
# -*- coding: utf-8 -*-
from mako.template import Template, ModuleTemplate
from mako.lookup import TemplateLookup
from mako.ext.preprocessors import convert_comments
from mako import exceptions
import re, os
from util import flatten_result, result_lines
import codecs
from test import TemplateTest, eq_, template_base, module_base, skip_if
class EncodingTest(TemplateTest):
def test_unicode(self):
self._do_memory_test(
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""",
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"""
)
def test_encoding_doesnt_conflict(self):
self._do_memory_test(
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""",
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""",
output_encoding='utf-8'
)
def test_unicode_arg(self):
val = u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"""
self._do_memory_test(
"${val}",
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""",
template_args={'val':val}
)
def test_unicode_file(self):
self._do_file_test(
"unicode.html",
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"""
)
def test_unicode_file_code(self):
self._do_file_test(
'unicode_code.html',
u"""hi, drôle de petit voix m’a réveillé.""",
filters=flatten_result
)
def test_unicode_file_lookup(self):
lookup = TemplateLookup(
directories=[template_base],
output_encoding='utf-8',
default_filters=['decode.utf8'])
template = lookup.get_template('/chs_unicode.html')
eq_(
flatten_result(template.render(name='毛泽东')),
'毛泽东 是 新中国的主席<br/> Welcome 你 to 北京.'
)
def test_unicode_bom(self):
self._do_file_test(
'bom.html',
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"""
)
self._do_file_test(
'bommagic.html',
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"""
)
self.assertRaises(
exceptions.CompileException,
Template, filename=self._file_path('badbom.html'),
module_directory=module_base
)
def test_unicode_memory(self):
val = u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"""
self._do_memory_test(
"## -*- coding: utf-8 -*-\n" + val.encode('utf-8'),
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"""
)
def test_unicode_text(self):
val = u"""<%text>Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »</%text>"""
self._do_memory_test(
"## -*- coding: utf-8 -*-\n" + val.encode('utf-8'),
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"""
)
def test_unicode_text_ccall(self):
val = u"""
<%def name="foo()">
${capture(caller.body)}
</%def>
<%call expr="foo()">
<%text>Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »</%text>
</%call>"""
self._do_memory_test(
"## -*- coding: utf-8 -*-\n" + val.encode('utf-8'),
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""",
filters=flatten_result
)
def test_unicode_literal_in_expr(self):
self._do_memory_test(
u"""## -*- coding: utf-8 -*-
${u"Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"}
""".encode('utf-8'),
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""",
filters = lambda s:s.strip()
)
def test_unicode_literal_in_expr_file(self):
self._do_file_test(
'unicode_expr.html',
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""",
lambda t:t.strip()
)
def test_unicode_literal_in_code(self):
self._do_memory_test(
u"""## -*- coding: utf-8 -*-
<%
context.write(u"Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »")
%>
""".encode('utf-8'),
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""",
filters=lambda s:s.strip()
)
def test_unicode_literal_in_controlline(self):
self._do_memory_test(
u"""## -*- coding: utf-8 -*-
<%
x = u"drôle de petit voix m’a réveillé."
%>
% if x==u"drôle de petit voix m’a réveillé.":
hi, ${x}
% endif
""".encode('utf-8'),
u"""hi, drôle de petit voix m’a réveillé.""",
filters=lambda s:s.strip(),
)
def test_unicode_literal_in_def(self):
self._do_memory_test(
u"""## -*- coding: utf-8 -*-
<%def name="bello(foo, bar)">
Foo: ${ foo }
Bar: ${ bar }
</%def>
<%call expr="bello(foo=u'árvíztűrő tükörfúrógép', bar=u'ÁRVÍZTŰRŐ TÜKÖRFÚRÓGÉP')">
</%call>""".encode('utf-8'),
u"""Foo: árvíztűrő tükörfúrógép Bar: ÁRVÍZTŰRŐ TÜKÖRFÚRÓGÉP""",
filters=flatten_result
)
self._do_memory_test(
u"""## -*- coding: utf-8 -*-
<%def name="hello(foo=u'árvíztűrő tükörfúrógép', bar=u'ÁRVÍZTŰRŐ TÜKÖRFÚRÓGÉP')">
Foo: ${ foo }
Bar: ${ bar }
</%def>
${ hello() }""".encode('utf-8'),
u"""Foo: árvíztűrő tükörfúrógép Bar: ÁRVÍZTŰRŐ TÜKÖRFÚRÓGÉP""",
filters=flatten_result
)
def test_input_encoding(self):
"""test the 'input_encoding' flag on Template, and that unicode
objects arent double-decoded"""
self._do_memory_test(
u"hello ${f(u'śląsk')}",
u"hello śląsk",
input_encoding='utf-8',
template_args={'f':lambda x:x}
)
self._do_memory_test(
u"## -*- coding: utf-8 -*-\nhello ${f(u'śląsk')}",
u"hello śląsk",
template_args={'f':lambda x:x}
)
def test_raw_strings(self):
"""test that raw strings go straight thru with default_filters turned off"""
self._do_memory_test(
u"## -*- coding: utf-8 -*-\nhello ${x}",
"hello śląsk",
default_filters=[],
template_args={'x':'śląsk'},
unicode_=False
)
# now, the way you *should* be doing it....
self._do_memory_test(
u"## -*- coding: utf-8 -*-\nhello ${x}",
u"hello śląsk",
template_args={'x':u'śląsk'}
)
def test_encoding(self):
self._do_memory_test(
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""",
u"""Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »""".encode('utf-8'),
output_encoding='utf-8',
unicode_=False
)
def test_encoding_errors(self):
self._do_memory_test(
u"""KGB (transliteration of "КГБ") is the Russian-language abbreviation for Committee for State Security, (Russian: Комит́ет Госуд́арственной Безоп́асности (help·info); Komitet Gosudarstvennoy Bezopasnosti)""",
u"""KGB (transliteration of "КГБ") is the Russian-language abbreviation for Committee for State Security, (Russian: Комит́ет Госуд́арственной Безоп́асности (help·info); Komitet Gosudarstvennoy Bezopasnosti)""".encode('iso-8859-1', 'replace'),
output_encoding='iso-8859-1', encoding_errors='replace',
unicode_=False
)
def test_read_unicode(self):
lookup = TemplateLookup(directories=[template_base],
filesystem_checks=True, output_encoding='utf-8')
template = lookup.get_template('/read_unicode.html')
data = template.render(path=self._file_path('internationalization.html'))
def test_bytestring_passthru(self):
self._do_file_test(
'chs_utf8.html',
'毛泽东 是 新中国的主席<br/> Welcome 你 to 北京. Welcome 你 to 北京.',
default_filters=[],
disable_unicode=True,
template_args={'name':'毛泽东'},
filters=flatten_result,
unicode_=False
)
self._do_file_test(
'chs_utf8.html',
'毛泽东 是 新中国的主席<br/> Welcome 你 to 北京. Welcome 你 to 北京.',
disable_unicode=True,
template_args={'name':'毛泽东'},
filters=flatten_result,
unicode_=False
)
template = self._file_template('chs_utf8.html', disable_unicode=True)
self.assertRaises(UnicodeDecodeError, template.render_unicode, name='毛泽东')
template = Template("""${'Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »'}""", disable_unicode=True, input_encoding='utf-8')
assert template.render() == """Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »"""
template = Template("""${'Alors vous imaginez ma surprise, au lever du jour, quand une drôle de petit voix m’a réveillé. Elle disait: « S’il vous plaît… dessine-moi un mouton! »'}""", input_encoding='utf8', output_encoding='utf8', disable_unicode=False, default_filters=[])
self.assertRaises(UnicodeDecodeError, template.render) # raises because expression contains an encoded bytestring which cannot be decoded
class PageArgsTest(TemplateTest):
def test_basic(self):
template = Template("""
<%page args="x, y, z=7"/>
this is page, ${x}, ${y}, ${z}
""")
assert flatten_result(template.render(x=5, y=10)) == "this is page, 5, 10, 7"
assert flatten_result(template.render(x=5, y=10, z=32)) == "this is page, 5, 10, 32"
try:
template.render(y=10)
assert False
except TypeError, e:
assert True
def test_with_context(self):
template = Template("""
<%page args="x, y, z=7"/>
this is page, ${x}, ${y}, ${z}, ${w}
""")
#print template.code
assert flatten_result(template.render(x=5, y=10, w=17)) == "this is page, 5, 10, 7, 17"
def test_overrides_builtins(self):
template = Template("""
<%page args="id"/>
this is page, id is ${id}
""")
assert flatten_result(template.render(id="im the id")) == "this is page, id is im the id"
def test_canuse_builtin_names(self):
template = Template("""
exception: ${Exception}
id: ${id}
""")
assert flatten_result(template.render(id='some id', Exception='some exception')) == "exception: some exception id: some id"
def test_builtin_names_dont_clobber_defaults_in_includes(self):
lookup = TemplateLookup()
lookup.put_string("test.mako",
"""
<%include file="test1.mako"/>
""")
lookup.put_string("test1.mako", """
<%page args="id='foo'"/>
${id}
""")
for template in ("test.mako", "test1.mako"):
assert flatten_result(lookup.get_template(template).render()) == "foo"
assert flatten_result(lookup.get_template(template).render(id=5)) == "5"
assert flatten_result(lookup.get_template(template).render(id=id)) == "<built-in function id>"
def test_dict_locals(self):
template = Template("""
<%
dict = "this is dict"
locals = "this is locals"
%>
dict: ${dict}
locals: ${locals}
""")
assert flatten_result(template.render()) == "dict: this is dict locals: this is locals"
class IncludeTest(TemplateTest):
def test_basic(self):
lookup = TemplateLookup()
lookup.put_string("a", """
this is a
<%include file="b" args="a=3,b=4,c=5"/>
""")
lookup.put_string("b", """
<%page args="a,b,c"/>
this is b. ${a}, ${b}, ${c}
""")
assert flatten_result(lookup.get_template("a").render()) == "this is a this is b. 3, 4, 5"
def test_localargs(self):
lookup = TemplateLookup()
lookup.put_string("a", """
this is a
<%include file="b" args="a=a,b=b,c=5"/>
""")
lookup.put_string("b", """
<%page args="a,b,c"/>
this is b. ${a}, ${b}, ${c}
""")
assert flatten_result(lookup.get_template("a").render(a=7,b=8)) == "this is a this is b. 7, 8, 5"
def test_viakwargs(self):
lookup = TemplateLookup()
lookup.put_string("a", """
this is a
<%include file="b" args="c=5, **context.kwargs"/>
""")
lookup.put_string("b", """
<%page args="a,b,c"/>
this is b. ${a}, ${b}, ${c}
""")
#print lookup.get_template("a").code
assert flatten_result(lookup.get_template("a").render(a=7,b=8)) == "this is a this is b. 7, 8, 5"
def test_include_withargs(self):
lookup = TemplateLookup()
lookup.put_string("a", """
this is a
<%include file="${i}" args="c=5, **context.kwargs"/>
""")
lookup.put_string("b", """
<%page args="a,b,c"/>
this is b. ${a}, ${b}, ${c}
""")
assert flatten_result(lookup.get_template("a").render(a=7,b=8,i='b')) == "this is a this is b. 7, 8, 5"
def test_within_ccall(self):
lookup = TemplateLookup()
lookup.put_string("a", """this is a""")
lookup.put_string("b", """
<%def name="bar()">
bar: ${caller.body()}
<%include file="a"/>
</%def>
""")
lookup.put_string("c", """
<%namespace name="b" file="b"/>
<%b:bar>
calling bar
</%b:bar>
""")
assert flatten_result(lookup.get_template("c").render()) == "bar: calling bar this is a"
class ControlTest(TemplateTest):
def test_control(self):
t = Template("""
## this is a template.
% for x in y:
% if x.has_key('test'):
yes x has test
% else:
no x does not have test
%endif
%endfor
""")
assert result_lines(t.render(y=[{'test':'one'}, {'foo':'bar'}, {'foo':'bar', 'test':'two'}])) == [
"yes x has test",
"no x does not have test",
"yes x has test"
]
def test_multiline_control(self):
t = Template("""
% for x in \\
[y for y in [1,2,3]]:
${x}
% endfor
""")
#print t.code
assert flatten_result(t.render()) == "1 2 3"
class GlobalsTest(TemplateTest):
def test_globals(self):
self._do_memory_test(
"""
<%!
y = "hi"
%>
y is ${y}
""",
"y is hi",
filters=lambda t:t.strip()
)
class RichTracebackTest(TemplateTest):
def _do_test_traceback(self, utf8, memory, syntax):
if memory:
if syntax:
source = u'## coding: utf-8\n<% print "m’a réveillé. '\
u'Elle disait: « S’il vous plaît… dessine-moi un mouton! » %>'
else:
source = u'## coding: utf-8\n<% print u"m’a réveillé. '\
u'Elle disait: « S’il vous plaît… dessine-moi un mouton! »" + str(5/0) %>'
if utf8:
source = source.encode('utf-8')
else:
source = source
templateargs = {'text':source}
else:
if syntax:
filename = 'unicode_syntax_error.html'
else:
filename = 'unicode_runtime_error.html'
source = file(self._file_path(filename)).read()
if not utf8:
source = source.decode('utf-8')
templateargs = {'filename':self._file_path(filename)}
try:
template = Template(**templateargs)
if not syntax:
template.render_unicode()
assert False
except Exception, e:
tback = exceptions.RichTraceback()
if utf8:
assert tback.source == source.decode('utf-8')
else:
assert tback.source == source
for utf8 in (True, False):
for memory in (True, False):
for syntax in (True, False):
def _do_test(self):
self._do_test_traceback(utf8, memory, syntax)
name = 'test_%s_%s_%s' % (utf8 and 'utf8' or 'unicode',
memory and 'memory' or 'file',
syntax and 'syntax' or 'runtime')
_do_test.__name__ = name
setattr(RichTracebackTest, name, _do_test)
del _do_test
class ModuleDirTest(TemplateTest):
def test_basic(self):
t = self._file_template("modtest.html")
t2 = self._file_template('subdir/modtest.html')
eq_(
t.module.__file__,
os.path.join(module_base, 'modtest.html.py')
)
eq_(
t2.module.__file__,
os.path.join(module_base, 'subdir', 'modtest.html.py')
)
def test_callable(self):
def get_modname(filename, uri):
return os.path.join(
module_base,
os.path.dirname(uri)[1:],
'foo',
os.path.basename(filename) + ".py")
lookup = TemplateLookup(template_base, modulename_callable=get_modname)
t = lookup.get_template('/modtest.html')
t2 = lookup.get_template('/subdir/modtest.html')
eq_(
t.module.__file__,
os.path.join(module_base, 'foo', 'modtest.html.py')
)
eq_(
t2.module.__file__,
os.path.join(module_base, 'subdir', 'foo', 'modtest.html.py')
)
class ModuleTemplateTest(TemplateTest):
def test_module_roundtrip(self):
lookup = TemplateLookup()
template = Template("""
<%inherit file="base.html"/>
% for x in range(5):
${x}
% endfor
""", lookup=lookup)
base = Template("""
This is base.
${self.body()}
""", lookup=lookup)
lookup.put_template("base.html", base)
lookup.put_template("template.html", template)
assert result_lines(template.render()) == [
"This is base.", "0", "1", "2", "3", "4"
]
lookup = TemplateLookup()
template = ModuleTemplate(template.module, lookup=lookup)
base = ModuleTemplate(base.module, lookup=lookup)
lookup.put_template("base.html", base)
lookup.put_template("template.html", template)
assert result_lines(template.render()) == [
"This is base.", "0", "1", "2", "3", "4"
]
class PreprocessTest(TemplateTest):
def test_old_comments(self):
t = Template("""
im a template
# old style comment
# more old style comment
## new style comment
- # not a comment
- ## not a comment
""", preprocessor=convert_comments)
assert flatten_result(t.render()) == "im a template - # not a comment - ## not a comment"