Hello ${hello}

+ + Hello ${hello} + +

reference me, please

- Hello ${name.title()} + Hello ${name.title()}

Hello ${select('@name')} diff --git a/examples/basic/common/macros.kid b/examples/basic/layout.kid rename from examples/basic/common/macros.kid rename to examples/basic/layout.kid --- a/examples/basic/common/macros.kid +++ b/examples/basic/layout.kid @@ -1,13 +1,15 @@ -

+ + Hello ${hello} + +

reference me, please

- Hello ${name.title()} + Hello ${name.title()}

Hello ${item.get('name')} - - ${item.findtext('')} - +

diff --git a/examples/basic/run.py b/examples/basic/run.py --- a/examples/basic/run.py +++ b/examples/basic/run.py @@ -9,9 +9,7 @@ def test(): base_path = os.path.dirname(os.path.abspath(__file__)) - loader = TemplateLoader([os.path.join(base_path, 'common'), - os.path.join(base_path, 'module')], - auto_reload=True) + loader = TemplateLoader([base_path], auto_reload=True) start = datetime.now() tmpl = loader.load('test.html') diff --git a/examples/basic/module/test.html b/examples/basic/test.html rename from examples/basic/module/test.html rename to examples/basic/test.html --- a/examples/basic/module/test.html +++ b/examples/basic/test.html @@ -3,9 +3,9 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - - + xmlns:xi="http://www.w3.org/2001/XInclude" + lang="en"> +

Item $prefix${item.split()[-1]}

reference me, please

+ Hello ${name.title()} +

+ + Hello ${select('@name')} + + +

+ + +

Item ${item.split()[-1]}

+ ${macro1()} ${macro1()} ${macro1()} + ${macro2('john')} + ${macro2('kate', classname='collapsed')} +

Replace me

+ + + Hello Silicon + + diff --git a/examples/includes/run.py b/examples/includes/run.py new file mode 100755 --- /dev/null +++ b/examples/includes/run.py @@ -0,0 +1,50 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +from datetime import datetime, timedelta +import os +import sys +import timing + +from markup.template import Context, TemplateLoader + +def test(): + base_path = os.path.dirname(os.path.abspath(__file__)) + loader = TemplateLoader([os.path.join(base_path, 'skins'), + os.path.join(base_path, 'module'), + os.path.join(base_path, 'common')]) + + timing.start() + tmpl = loader.load('test.html') + timing.finish() + print ' --> parse stage: %dms' % timing.milli() + + data = dict(hello='', skin='default', hey='ZYX', bozz=None, + items=['Number %d' % num for num in range(1, 15)]) + + print tmpl.generate(Context(**data)).render(method='html') + + times = [] + for i in range(100): + timing.start() + list(tmpl.generate(Context(**data))) + timing.finish() + sys.stdout.write('.') + sys.stdout.flush() + times.append(timing.milli()) + print + + print ' --> render stage: %dms (avg), %dms (min), %dms (max)' % ( + sum(times) / len(times), min(times), max(times)) + +if __name__ == '__main__': + if '-p' in sys.argv: + import hotshot, hotshot.stats + prof = hotshot.Profile("template.prof") + benchtime = prof.runcall(test) + stats = hotshot.stats.load("template.prof") + stats.strip_dirs() + stats.sort_stats('time', 'calls') + stats.print_stats() + else: + test() diff --git a/examples/includes/skins/default/footer.html b/examples/includes/skins/default/footer.html new file mode 100644 --- /dev/null +++ b/examples/includes/skins/default/footer.html @@ -0,0 +1,4 @@ + diff --git a/examples/includes/skins/default/header.html b/examples/includes/skins/default/header.html new file mode 100644 --- /dev/null +++ b/examples/includes/skins/default/header.html @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/examples/includes/skins/default/layout.html b/examples/includes/skins/default/layout.html new file mode 100644 --- /dev/null +++ b/examples/includes/skins/default/layout.html @@ -0,0 +1,17 @@ + + + + Hello ${hello} + + + + +

+ ${select('body/*')} +

+ + + diff --git a/markup/__init__.py b/markup/__init__.py --- a/markup/__init__.py +++ b/markup/__init__.py @@ -54,4 +54,4 @@ """ from markup.core import * -from markup.input import XML, HTML +from markup.input import ParseError, XML, HTML diff --git a/markup/filters.py b/markup/filters.py --- a/markup/filters.py +++ b/markup/filters.py @@ -53,7 +53,6 @@ ns_prefixes = [] in_fallback = False include_href, fallback_stream = None, None - indent = 0 for kind, data, pos in stream: @@ -62,7 +61,6 @@ tag, attrib = data if tag.localname == 'include': include_href = attrib.get('href') - indent = pos[1] elif tag.localname == 'fallback': in_fallback = True fallback_stream = [] @@ -73,7 +71,8 @@ if not include_href: raise TemplateError('Include misses required ' 'attribute "href"') - template = self.loader.load(include_href) + template = self.loader.load(include_href, + relative_to=pos[0]) for event in template.generate(ctxt): yield event @@ -85,7 +84,6 @@ include_href = None fallback_stream = None - indent = 0 elif data.localname == 'fallback': in_fallback = False diff --git a/markup/input.py b/markup/input.py --- a/markup/input.py +++ b/markup/input.py @@ -24,12 +24,24 @@ from markup.core import Attributes, Markup, QName, Stream +class ParseError(Exception): + """Exception raised when fatal syntax errors are found in the input being + parsed.""" + + def __init__(self, message, filename='', lineno=-1, offset=-1): + Exception.__init__(self, message) + self.filename = filename + self.lineno = lineno + self.offset = offset + + class XMLParser(object): """Generator-based XML parser based on roughly equivalent code in Kid/ElementTree.""" - def __init__(self, source): + def __init__(self, source, filename=None): self.source = source + self.filename = filename # Setup the Expat parser parser = expat.ParserCreate('utf-8', '}') @@ -48,73 +60,80 @@ # Location reporting is only support in Python >= 2.4 if not hasattr(parser, 'CurrentLineNumber'): - self.getpos = self._getpos_unknown + self._getpos = self._getpos_unknown self.expat = parser - self.queue = [] + self._queue = [] def __iter__(self): - bufsize = 4 * 1024 # 4K - done = False - while True: - while not done and len(self.queue) == 0: - data = self.source.read(bufsize) - if data == '': # end of data - if hasattr(self, 'expat'): - self.expat.Parse('', True) - del self.expat # get rid of circular references - done = True - else: - self.expat.Parse(data, False) - for event in self.queue: - yield event - self.queue = [] - if done: - break + try: + bufsize = 4 * 1024 # 4K + done = False + while True: + while not done and len(self._queue) == 0: + data = self.source.read(bufsize) + if data == '': # end of data + if hasattr(self, 'expat'): + self.expat.Parse('', True) + del self.expat # get rid of circular references + done = True + else: + self.expat.Parse(data, False) + for event in self._queue: + yield event + self._queue = [] + if done: + break + except expat.ExpatError, e: + msg = str(e) + if self.filename: + msg += ', in ' + self.filename + raise ParseError(msg, self.filename, e.lineno, e.offset) def _getpos_unknown(self): - return (-1, -1) + return (self.filename or '', -1, -1) - def getpos(self): - return self.expat.CurrentLineNumber, self.expat.CurrentColumnNumber + def _getpos(self): + return (self.filename or '', self.expat.CurrentLineNumber, + self.expat.CurrentColumnNumber) def _handle_start(self, tag, attrib): - self.queue.append((Stream.START, (QName(tag), Attributes(attrib.items())), - self.getpos())) + self._queue.append((Stream.START, (QName(tag), Attributes(attrib.items())), + self._getpos())) def _handle_end(self, tag): - self.queue.append((Stream.END, QName(tag), self.getpos())) + self._queue.append((Stream.END, QName(tag), self._getpos())) def _handle_data(self, text): - self.queue.append((Stream.TEXT, text, self.getpos())) + self._queue.append((Stream.TEXT, text, self._getpos())) def _handle_prolog(self, version, encoding, standalone): - self.queue.append((Stream.PROLOG, (version, encoding, standalone), - self.getpos())) + self._queue.append((Stream.PROLOG, (version, encoding, standalone), + self._getpos())) def _handle_doctype(self, name, sysid, pubid, has_internal_subset): - self.queue.append((Stream.DOCTYPE, (name, pubid, sysid), self.getpos())) + self._queue.append((Stream.DOCTYPE, (name, pubid, sysid), self._getpos())) def _handle_start_ns(self, prefix, uri): - self.queue.append((Stream.START_NS, (prefix or '', uri), self.getpos())) + self._queue.append((Stream.START_NS, (prefix or '', uri), self._getpos())) def _handle_end_ns(self, prefix): - self.queue.append((Stream.END_NS, prefix or '', self.getpos())) + self._queue.append((Stream.END_NS, prefix or '', self._getpos())) def _handle_pi(self, target, data): - self.queue.append((Stream.PI, (target, data), self.getpos())) + self._queue.append((Stream.PI, (target, data), self._getpos())) def _handle_comment(self, text): - self.queue.append((Stream.COMMENT, text, self.getpos())) + self._queue.append((Stream.COMMENT, text, self._getpos())) def _handle_other(self, text): if text.startswith('&'): # deal with undefined entities try: text = unichr(htmlentitydefs.name2codepoint[text[1:-1]]) - self.queue.append((Stream.TEXT, text, self.getpos())) + self._queue.append((Stream.TEXT, text, self._getpos())) except KeyError: - lineno, offset = self.getpos() + lineno, offset = self._getpos() raise expat.error("undefined entity %s: line %d, column %d" % (text, lineno, offset)) @@ -123,7 +142,7 @@ return Stream(list(XMLParser(StringIO(text)))) -class HTMLParser(html.HTMLParser): +class HTMLParser(html.HTMLParser, object): """Parser for HTML input based on the Python `HTMLParser` module. This class provides the same interface for generating stream events as @@ -134,68 +153,79 @@ 'hr', 'img', 'input', 'isindex', 'link', 'meta', 'param']) - def __init__(self, source): + def __init__(self, source, filename=None): html.HTMLParser.__init__(self) self.source = source - self.queue = [] + self.filename = filename + self._queue = [] self._open_tags = [] def __iter__(self): - bufsize = 4 * 1024 # 4K - done = False - while True: - while not done and len(self.queue) == 0: - data = self.source.read(bufsize) - if data == '': # end of data - self.close() - done = True - else: - self.feed(data) - for kind, data, pos in self.queue: - yield kind, data, pos - self.queue = [] - if done: - open_tags = self._open_tags - open_tags.reverse() - for tag in open_tags: - yield Stream.END, QName(tag), pos - break + try: + bufsize = 4 * 1024 # 4K + done = False + while True: + while not done and len(self._queue) == 0: + data = self.source.read(bufsize) + if data == '': # end of data + self.close() + done = True + else: + self.feed(data) + for kind, data, pos in self._queue: + yield kind, data, pos + self._queue = [] + if done: + open_tags = self._open_tags + open_tags.reverse() + for tag in open_tags: + yield Stream.END, QName(tag), pos + break + except html.HTMLParseError, e: + msg = '%s: line %d, column %d' % (e.msg, e.lineno, e.offset) + if self.filename: + msg += ', in %s' % self.filename + raise ParseError(msg, self.filename, e.lineno, e.offset) + + def _getpos(self): + lineno, column = self.getpos() + return (self.filename, lineno, column) def handle_starttag(self, tag, attrib): - pos = self.getpos() - self.queue.append((Stream.START, (QName(tag), Attributes(attrib)), pos)) + pos = self._getpos() + self._queue.append((Stream.START, (QName(tag), Attributes(attrib)), pos)) if tag in self._EMPTY_ELEMS: - self.queue.append((Stream.END, QName(tag), pos)) + self._queue.append((Stream.END, QName(tag), pos)) else: self._open_tags.append(tag) def handle_endtag(self, tag): if tag not in self._EMPTY_ELEMS: - pos = self.getpos() + pos = self._getpos() while self._open_tags: open_tag = self._open_tags.pop() if open_tag.lower() == tag.lower(): break - self.queue.append((Stream.END, QName(open_tag), pos)) - self.queue.append((Stream.END, QName(tag), pos)) + self._queue.append((Stream.END, QName(open_tag), pos)) + self._queue.append((Stream.END, QName(tag), pos)) def handle_data(self, text): - self.queue.append((Stream.TEXT, text, self.getpos())) + self._queue.append((Stream.TEXT, text, self._getpos())) def handle_charref(self, name): - self.queue.append((Stream.TEXT, Markup('&#%s;' % name), self.getpos())) + self._queue.append((Stream.TEXT, Markup('&#%s;' % name), self._getpos())) def handle_entityref(self, name): - self.queue.append((Stream.TEXT, Markup('&%s;' % name), self.getpos())) + self._queue.append((Stream.TEXT, Markup('&%s;' % name), self._getpos())) def handle_pi(self, data): target, data = data.split(maxsplit=1) data = data.rstrip('?') - self.queue.append((Stream.PI, (target.strip(), data.strip()), - self.getpos())) + self._queue.append((Stream.PI, (target.strip(), data.strip()), + self._getpos())) def handle_comment(self, text): - self.queue.append((Stream.COMMENT, text, self.getpos())) + self._queue.append((Stream.COMMENT, text, self._getpos())) def HTML(text): diff --git a/markup/plugin.py b/markup/plugin.py --- a/markup/plugin.py +++ b/markup/plugin.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# Copyright (C) 2006 Mattew Good +# Copyright (C) 2006 Matthew Good # All rights reserved. # # This software is licensed as described in the file COPYING, which @@ -34,18 +34,16 @@ if divider >= 0: package = templatename[:divider] basename = templatename[divider + 1:] + '.html' - fullpath = resource_filename(package, basename) - dirname, templatename = os.path.split(fullpath) - self.loader.search_path.append(dirname) # Kludge + templatename = resource_filename(package, basename) return self.loader.load(templatename) def render(self, info, format='html', fragment=False, template=None): - """Renders the template to a string using the provided info.""" + """Render the template to a string using the provided info.""" return self.transform(info, template).render(method=format) def transform(self, info, template): - "Render the output to Elements" + """Render the output to an event stream.""" if not isinstance(template, Template): template = self.load_template(template) diff --git a/markup/template.py b/markup/template.py --- a/markup/template.py +++ b/markup/template.py @@ -43,6 +43,7 @@ import compiler import os +import posixpath import re from StringIO import StringIO @@ -574,20 +575,24 @@ _dir_by_name = dict(directives) _dir_order = [directive[1] for directive in directives] - def __init__(self, source, filename=None): + def __init__(self, source, basedir=None, filename=None): """Initialize a template from either a string or a file-like object.""" if isinstance(source, basestring): self.source = StringIO(source) else: self.source = source + self.basedir = basedir self.filename = filename or '' + if basedir and filename: + self.filepath = os.path.join(basedir, filename) + else: + self.filepath = '' self.filters = [self._eval, self._match] self.parse() def __repr__(self): - return '<%s "%s">' % (self.__class__.__name__, - os.path.basename(self.filename)) + return '<%s "%s">' % (self.__class__.__name__, self.filename) def parse(self): """Parse the template. @@ -603,7 +608,7 @@ ns_prefix = {} depth = 0 - for kind, data, pos in XMLParser(self.source): + for kind, data, pos in XMLParser(self.source, filename=self.filename): if kind is Stream.START_NS: # Strip out the namespace declaration for template directives @@ -628,7 +633,7 @@ if name in self.NAMESPACE: cls = self._dir_by_name.get(name.localname) if cls is None: - raise BadDirectiveError(name, self.filename, pos[0]) + raise BadDirectiveError(name, self.filename, pos[1]) else: directives.append(cls(self, value, pos)) else: @@ -666,7 +671,7 @@ _FULL_EXPR_RE = re.compile(r'(?') self.assertEquals('', str(markup.sanitize())) markup = Markup('alert("foo")') - self.assertRaises(HTMLParseError, markup.sanitize().render) + self.assertRaises(ParseError, markup.sanitize().render) markup = Markup('') - self.assertRaises(HTMLParseError, markup.sanitize().render) + self.assertRaises(ParseError, markup.sanitize().render) def test_sanitize_remove_onclick_attr(self): markup = Markup('

') @@ -156,7 +156,7 @@ self.assertEquals('', str(markup.sanitize())) # Grave accents (not parsed) markup = Markup('

') - self.assertRaises(HTMLParseError, markup.sanitize().render) + self.assertRaises(ParseError, markup.sanitize().render) # Protocol encoded using UTF-8 numeric entities markup = Markup('

') diff --git a/markup/tests/template.py b/markup/tests/template.py --- a/markup/tests/template.py +++ b/markup/tests/template.py @@ -69,7 +69,7 @@ def test_bad_directive_error(self): xml = '

' try: - tmpl = Template(xml, 'test.html') + tmpl = Template(xml, filename='test.html') except BadDirectiveError, e: self.assertEqual('test.html', e.filename) if sys.version_info[:2] >= (2, 4): @@ -77,7 +77,7 @@ def test_directive_value_syntax_error(self): xml = '

' - tmpl = Template(xml, 'test.html') + tmpl = Template(xml, filename='test.html') try: list(tmpl.generate(Context())) self.fail('Expected SyntaxError')

And goodbye

Welcome