genshi/genshi-test: markup/template.py annotate

annotate markup/template.py @ 173:ae5d2f4a378a

Fix for #33.

author	cmlenz
date	Sun, 20 Aug 2006 11:35:46 +0000
parents	4b4e80b2b0b5
children	f0cdfcdaa092

rev	line source
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1 # -- coding: utf-8 --
821114ec4f69 Initial import. cmlenz parents: diff changeset	2 #
66 822089ae65ce Switch copyright to Edgewall and URLs to markup.edgewall.org. cmlenz parents: 65 diff changeset	3 # Copyright (C) 2006 Edgewall Software
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	4 # All rights reserved.
821114ec4f69 Initial import. cmlenz parents: diff changeset	5 #
821114ec4f69 Initial import. cmlenz parents: diff changeset	6 # This software is licensed as described in the file COPYING, which
821114ec4f69 Initial import. cmlenz parents: diff changeset	7 # you should have received as part of this distribution. The terms
66 822089ae65ce Switch copyright to Edgewall and URLs to markup.edgewall.org. cmlenz parents: 65 diff changeset	8 # are also available at http://markup.edgewall.org/wiki/License.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	9 #
821114ec4f69 Initial import. cmlenz parents: diff changeset	10 # This software consists of voluntary contributions made by many
821114ec4f69 Initial import. cmlenz parents: diff changeset	11 # individuals. For the exact contribution history, see the revision
66 822089ae65ce Switch copyright to Edgewall and URLs to markup.edgewall.org. cmlenz parents: 65 diff changeset	12 # history and logs, available at http://markup.edgewall.org/log/.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	13
82 c82c002d4c32 Some minor cleanup. cmlenz parents: 81 diff changeset	14 """Implementation of the template engine."""
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	15
70 0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	16 try:
0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	17 from collections import deque
0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	18 except ImportError:
0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	19 class deque(list):
0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	20 def appendleft(self, x): self.insert(0, x)
0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	21 def popleft(self): return self.pop(0)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	22 import compiler
821114ec4f69 Initial import. cmlenz parents: diff changeset	23 import os
821114ec4f69 Initial import. cmlenz parents: diff changeset	24 import re
821114ec4f69 Initial import. cmlenz parents: diff changeset	25 from StringIO import StringIO
821114ec4f69 Initial import. cmlenz parents: diff changeset	26
145 56d534eb53f9 * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples. cmlenz parents: 140 diff changeset	27 from markup.core import Attributes, Namespace, Stream, StreamEventKind, _ensure
56d534eb53f9 * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples. cmlenz parents: 140 diff changeset	28 from markup.core import START, END, START_NS, END_NS, TEXT, COMMENT
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	29 from markup.eval import Expression
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	30 from markup.input import XMLParser
14 76b5d4b189e6 The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general. cmlenz parents: 13 diff changeset	31 from markup.path import Path
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	32
150 39a8012f60e3 Removed to many classes from the `__all__` list of `markup.template` in [191]. cmlenz parents: 149 diff changeset	33 __all__ = ['BadDirectiveError', 'TemplateError', 'TemplateSyntaxError',
39a8012f60e3 Removed to many classes from the `__all__` list of `markup.template` in [191]. cmlenz parents: 149 diff changeset	34 'TemplateNotFound', 'Template', 'TemplateLoader']
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	35
821114ec4f69 Initial import. cmlenz parents: diff changeset	36
821114ec4f69 Initial import. cmlenz parents: diff changeset	37 class TemplateError(Exception):
821114ec4f69 Initial import. cmlenz parents: diff changeset	38 """Base exception class for errors related to template processing."""
821114ec4f69 Initial import. cmlenz parents: diff changeset	39
821114ec4f69 Initial import. cmlenz parents: diff changeset	40
821114ec4f69 Initial import. cmlenz parents: diff changeset	41 class TemplateSyntaxError(TemplateError):
821114ec4f69 Initial import. cmlenz parents: diff changeset	42 """Exception raised when an expression in a template causes a Python syntax
821114ec4f69 Initial import. cmlenz parents: diff changeset	43 error."""
821114ec4f69 Initial import. cmlenz parents: diff changeset	44
821114ec4f69 Initial import. cmlenz parents: diff changeset	45 def __init__(self, message, filename='<string>', lineno=-1, offset=-1):
821114ec4f69 Initial import. cmlenz parents: diff changeset	46 if isinstance(message, SyntaxError) and message.lineno is not None:
821114ec4f69 Initial import. cmlenz parents: diff changeset	47 message = str(message).replace(' (line %d)' % message.lineno, '')
80 d5db5e3aec58 * Improve template error messages cmlenz parents: 78 diff changeset	48 message = '%s (%s, line %d)' % (message, filename, lineno)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	49 TemplateError.__init__(self, message)
821114ec4f69 Initial import. cmlenz parents: diff changeset	50 self.filename = filename
821114ec4f69 Initial import. cmlenz parents: diff changeset	51 self.lineno = lineno
821114ec4f69 Initial import. cmlenz parents: diff changeset	52 self.offset = offset
821114ec4f69 Initial import. cmlenz parents: diff changeset	53
821114ec4f69 Initial import. cmlenz parents: diff changeset	54
821114ec4f69 Initial import. cmlenz parents: diff changeset	55 class BadDirectiveError(TemplateSyntaxError):
821114ec4f69 Initial import. cmlenz parents: diff changeset	56 """Exception raised when an unknown directive is encountered when parsing
821114ec4f69 Initial import. cmlenz parents: diff changeset	57 a template.
821114ec4f69 Initial import. cmlenz parents: diff changeset	58
821114ec4f69 Initial import. cmlenz parents: diff changeset	59 An unknown directive is any attribute using the namespace for directives,
821114ec4f69 Initial import. cmlenz parents: diff changeset	60 with a local name that doesn't match any registered directive.
821114ec4f69 Initial import. cmlenz parents: diff changeset	61 """
821114ec4f69 Initial import. cmlenz parents: diff changeset	62
821114ec4f69 Initial import. cmlenz parents: diff changeset	63 def __init__(self, name, filename='<string>', lineno=-1):
80 d5db5e3aec58 * Improve template error messages cmlenz parents: 78 diff changeset	64 msg = 'bad directive "%s" (%s, line %d)' % (name.localname, filename,
d5db5e3aec58 * Improve template error messages cmlenz parents: 78 diff changeset	65 lineno)
d5db5e3aec58 * Improve template error messages cmlenz parents: 78 diff changeset	66 TemplateSyntaxError.__init__(self, msg, filename, lineno)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	67
821114ec4f69 Initial import. cmlenz parents: diff changeset	68
821114ec4f69 Initial import. cmlenz parents: diff changeset	69 class TemplateNotFound(TemplateError):
821114ec4f69 Initial import. cmlenz parents: diff changeset	70 """Exception raised when a specific template file could not be found."""
821114ec4f69 Initial import. cmlenz parents: diff changeset	71
821114ec4f69 Initial import. cmlenz parents: diff changeset	72 def __init__(self, name, search_path):
821114ec4f69 Initial import. cmlenz parents: diff changeset	73 TemplateError.__init__(self, 'Template "%s" not found' % name)
821114ec4f69 Initial import. cmlenz parents: diff changeset	74 self.search_path = search_path
821114ec4f69 Initial import. cmlenz parents: diff changeset	75
821114ec4f69 Initial import. cmlenz parents: diff changeset	76
821114ec4f69 Initial import. cmlenz parents: diff changeset	77 class Context(object):
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	78 """Container for template input data.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	79
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	80 A context provides a stack of scopes (represented by dictionaries).
7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	81
7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	82 Template directives such as loops can push a new scope on the stack with
7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	83 data that should only be available inside the loop. When the loop
7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	84 terminates, that scope can get popped off the stack again.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	85
821114ec4f69 Initial import. cmlenz parents: diff changeset	86 >>> ctxt = Context(one='foo', other=1)
821114ec4f69 Initial import. cmlenz parents: diff changeset	87 >>> ctxt.get('one')
821114ec4f69 Initial import. cmlenz parents: diff changeset	88 'foo'
821114ec4f69 Initial import. cmlenz parents: diff changeset	89 >>> ctxt.get('other')
821114ec4f69 Initial import. cmlenz parents: diff changeset	90 1
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	91 >>> ctxt.push(dict(one='frost'))
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	92 >>> ctxt.get('one')
821114ec4f69 Initial import. cmlenz parents: diff changeset	93 'frost'
821114ec4f69 Initial import. cmlenz parents: diff changeset	94 >>> ctxt.get('other')
821114ec4f69 Initial import. cmlenz parents: diff changeset	95 1
821114ec4f69 Initial import. cmlenz parents: diff changeset	96 >>> ctxt.pop()
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	97 {'one': 'frost'}
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	98 >>> ctxt.get('one')
821114ec4f69 Initial import. cmlenz parents: diff changeset	99 'foo'
821114ec4f69 Initial import. cmlenz parents: diff changeset	100 """
821114ec4f69 Initial import. cmlenz parents: diff changeset	101
821114ec4f69 Initial import. cmlenz parents: diff changeset	102 def __init__(self, **data):
70 0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	103 self.frames = deque([data])
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	104 self.pop = self.frames.popleft
7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	105 self.push = self.frames.appendleft
157 40fc3d36f5b4 Fix for backwards compatibility proposed by cboos in #28. cmlenz parents: 154 diff changeset	106 self._match_templates = []
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	107
821114ec4f69 Initial import. cmlenz parents: diff changeset	108 def __repr__(self):
70 0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	109 return repr(self.frames)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	110
821114ec4f69 Initial import. cmlenz parents: diff changeset	111 def __setitem__(self, key, value):
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	112 """Set a variable in the current scope."""
70 0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	113 self.frames[0][key] = value
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	114
821114ec4f69 Initial import. cmlenz parents: diff changeset	115 def get(self, key):
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	116 """Get a variable's value, starting at the current scope and going
7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	117 upward.
29 4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	118 """
70 0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	119 for frame in self.frames:
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	120 if key in frame:
821114ec4f69 Initial import. cmlenz parents: diff changeset	121 return frame[key]
70 0498da8e5de7 Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations. cmlenz parents: 69 diff changeset	122 __getitem__ = get
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	123
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	124 def push(self, data):
7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	125 """Push a new scope on the stack."""
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	126
821114ec4f69 Initial import. cmlenz parents: diff changeset	127 def pop(self):
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	128 """Pop the top-most scope from the stack."""
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	129
821114ec4f69 Initial import. cmlenz parents: diff changeset	130
821114ec4f69 Initial import. cmlenz parents: diff changeset	131 class Directive(object):
821114ec4f69 Initial import. cmlenz parents: diff changeset	132 """Abstract base class for template directives.
821114ec4f69 Initial import. cmlenz parents: diff changeset	133
54 01981cbc7575 Fix a number of escaping problems: cmlenz parents: 53 diff changeset	134 A directive is basically a callable that takes three positional arguments:
01981cbc7575 Fix a number of escaping problems: cmlenz parents: 53 diff changeset	135 `ctxt` is the template data context, `stream` is an iterable over the
01981cbc7575 Fix a number of escaping problems: cmlenz parents: 53 diff changeset	136 events that the directive applies to, and `directives` is is a list of
01981cbc7575 Fix a number of escaping problems: cmlenz parents: 53 diff changeset	137 other directives on the same stream that need to be applied.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	138
821114ec4f69 Initial import. cmlenz parents: diff changeset	139 Directives can be "anonymous" or "registered". Registered directives can be
821114ec4f69 Initial import. cmlenz parents: diff changeset	140 applied by the template author using an XML attribute with the
821114ec4f69 Initial import. cmlenz parents: diff changeset	141 corresponding name in the template. Such directives should be subclasses of
31 9a958398bed9 * More test cases for expression evaluation. cmlenz parents: 29 diff changeset	142 this base class that can be instantiated with the value of the directive
9a958398bed9 * More test cases for expression evaluation. cmlenz parents: 29 diff changeset	143 attribute as parameter.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	144
821114ec4f69 Initial import. cmlenz parents: diff changeset	145 Anonymous directives are simply functions conforming to the protocol
821114ec4f69 Initial import. cmlenz parents: diff changeset	146 described above, and can only be applied programmatically (for example by
821114ec4f69 Initial import. cmlenz parents: diff changeset	147 template filters).
821114ec4f69 Initial import. cmlenz parents: diff changeset	148 """
821114ec4f69 Initial import. cmlenz parents: diff changeset	149 __slots__ = ['expr']
821114ec4f69 Initial import. cmlenz parents: diff changeset	150
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	151 def __init__(self, value, filename=None, lineno=-1, offset=-1):
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	152 try:
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	153 self.expr = value and Expression(value, filename, lineno) or None
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	154 except SyntaxError, err:
166 718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	155 err.msg += ' in expression "%s" of "%s" directive' % (value,
172 4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	156 self.tagname)
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	157 raise TemplateSyntaxError(err, filename, lineno,
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	158 offset + (err.offset or 0))
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	159
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	160 def __call__(self, stream, ctxt, directives):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	161 raise NotImplementedError
821114ec4f69 Initial import. cmlenz parents: diff changeset	162
821114ec4f69 Initial import. cmlenz parents: diff changeset	163 def __repr__(self):
821114ec4f69 Initial import. cmlenz parents: diff changeset	164 expr = ''
821114ec4f69 Initial import. cmlenz parents: diff changeset	165 if self.expr is not None:
821114ec4f69 Initial import. cmlenz parents: diff changeset	166 expr = ' "%s"' % self.expr.source
821114ec4f69 Initial import. cmlenz parents: diff changeset	167 return '<%s%s>' % (self.__class__.__name__, expr)
821114ec4f69 Initial import. cmlenz parents: diff changeset	168
172 4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	169 def tagname(self):
4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	170 """Return the local tag name of the directive as it is used in
4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	171 templates.
4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	172 """
166 718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	173 return self.__class__.__name__.lower().replace('directive', '')
172 4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	174 tagname = property(tagname)
166 718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	175
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	176
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	177 def _apply_directives(stream, ctxt, directives):
161 a25f9fc5787d Various docstring additions and other cosmetic changes. cmlenz parents: 157 diff changeset	178 """Apply the given directives to the stream."""
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	179 if directives:
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	180 stream = directives[0](iter(stream), ctxt, directives[1:])
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	181 return stream
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	182
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	183
821114ec4f69 Initial import. cmlenz parents: diff changeset	184 class AttrsDirective(Directive):
821114ec4f69 Initial import. cmlenz parents: diff changeset	185 """Implementation of the `py:attrs` template directive.
821114ec4f69 Initial import. cmlenz parents: diff changeset	186
821114ec4f69 Initial import. cmlenz parents: diff changeset	187 The value of the `py:attrs` attribute should be a dictionary. The keys and
821114ec4f69 Initial import. cmlenz parents: diff changeset	188 values of that dictionary will be added as attributes to the element:
821114ec4f69 Initial import. cmlenz parents: diff changeset	189
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	190 >>> tmpl = Template('''<ul xmlns:py="http://markup.edgewall.org/">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	191 ... <li py:attrs="foo">Bar</li>
821114ec4f69 Initial import. cmlenz parents: diff changeset	192 ... </ul>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	193 >>> print tmpl.generate(foo={'class': 'collapse'})
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	194 <ul>
821114ec4f69 Initial import. cmlenz parents: diff changeset	195 <li class="collapse">Bar</li>
821114ec4f69 Initial import. cmlenz parents: diff changeset	196 </ul>
821114ec4f69 Initial import. cmlenz parents: diff changeset	197
821114ec4f69 Initial import. cmlenz parents: diff changeset	198 If the value evaluates to `None` (or any other non-truth value), no
821114ec4f69 Initial import. cmlenz parents: diff changeset	199 attributes are added:
821114ec4f69 Initial import. cmlenz parents: diff changeset	200
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	201 >>> print tmpl.generate(foo=None)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	202 <ul>
821114ec4f69 Initial import. cmlenz parents: diff changeset	203 <li>Bar</li>
821114ec4f69 Initial import. cmlenz parents: diff changeset	204 </ul>
821114ec4f69 Initial import. cmlenz parents: diff changeset	205 """
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	206 __slots__ = []
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	207
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	208 def __call__(self, stream, ctxt, directives):
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	209 def _generate():
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	210 kind, (tag, attrib), pos = stream.next()
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	211 attrs = self.expr.evaluate(ctxt)
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	212 if attrs:
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	213 attrib = Attributes(attrib[:])
77 f1aa49c759b2 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 75 diff changeset	214 if isinstance(attrs, Stream):
f1aa49c759b2 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 75 diff changeset	215 try:
f1aa49c759b2 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 75 diff changeset	216 attrs = iter(attrs).next()
f1aa49c759b2 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 75 diff changeset	217 except StopIteration:
f1aa49c759b2 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 75 diff changeset	218 attrs = []
f1aa49c759b2 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 75 diff changeset	219 elif not isinstance(attrs, list): # assume it's a dict
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	220 attrs = attrs.items()
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	221 for name, value in attrs:
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	222 if value is None:
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	223 attrib.remove(name)
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	224 else:
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	225 attrib.set(name, unicode(value).strip())
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	226 yield kind, (tag, attrib), pos
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	227 for event in stream:
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	228 yield event
77 f1aa49c759b2 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 75 diff changeset	229
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	230 return _apply_directives(_generate(), ctxt, directives)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	231
821114ec4f69 Initial import. cmlenz parents: diff changeset	232
821114ec4f69 Initial import. cmlenz parents: diff changeset	233 class ContentDirective(Directive):
821114ec4f69 Initial import. cmlenz parents: diff changeset	234 """Implementation of the `py:content` template directive.
821114ec4f69 Initial import. cmlenz parents: diff changeset	235
821114ec4f69 Initial import. cmlenz parents: diff changeset	236 This directive replaces the content of the element with the result of
821114ec4f69 Initial import. cmlenz parents: diff changeset	237 evaluating the value of the `py:content` attribute:
821114ec4f69 Initial import. cmlenz parents: diff changeset	238
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	239 >>> tmpl = Template('''<ul xmlns:py="http://markup.edgewall.org/">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	240 ... <li py:content="bar">Hello</li>
821114ec4f69 Initial import. cmlenz parents: diff changeset	241 ... </ul>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	242 >>> print tmpl.generate(bar='Bye')
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	243 <ul>
821114ec4f69 Initial import. cmlenz parents: diff changeset	244 <li>Bye</li>
821114ec4f69 Initial import. cmlenz parents: diff changeset	245 </ul>
821114ec4f69 Initial import. cmlenz parents: diff changeset	246 """
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	247 __slots__ = []
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	248
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	249 def __call__(self, stream, ctxt, directives):
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	250 def _generate():
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	251 kind, data, pos = stream.next()
101 ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	252 if kind is START:
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	253 yield kind, data, pos # emit start tag
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	254 yield EXPR, self.expr, pos
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	255 previous = stream.next()
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	256 for event in stream:
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	257 previous = event
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	258 if previous is not None:
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	259 yield previous
87 c6f07b7cd3ea Fix some problems in expression evaluation by transforming the AST and compiling that to bytecode, instead of generating bytecode directly. Invalidates #13. cmlenz parents: 82 diff changeset	260
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	261 return _apply_directives(_generate(), ctxt, directives)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	262
821114ec4f69 Initial import. cmlenz parents: diff changeset	263
821114ec4f69 Initial import. cmlenz parents: diff changeset	264 class DefDirective(Directive):
821114ec4f69 Initial import. cmlenz parents: diff changeset	265 """Implementation of the `py:def` template directive.
821114ec4f69 Initial import. cmlenz parents: diff changeset	266
821114ec4f69 Initial import. cmlenz parents: diff changeset	267 This directive can be used to create "Named Template Functions", which
821114ec4f69 Initial import. cmlenz parents: diff changeset	268 are template snippets that are not actually output during normal
821114ec4f69 Initial import. cmlenz parents: diff changeset	269 processing, but rather can be expanded from expressions in other places
821114ec4f69 Initial import. cmlenz parents: diff changeset	270 in the template.
821114ec4f69 Initial import. cmlenz parents: diff changeset	271
821114ec4f69 Initial import. cmlenz parents: diff changeset	272 A named template function can be used just like a normal Python function
821114ec4f69 Initial import. cmlenz parents: diff changeset	273 from template expressions:
821114ec4f69 Initial import. cmlenz parents: diff changeset	274
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	275 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	276 ... <p py:def="echo(greeting, name='world')" class="message">
821114ec4f69 Initial import. cmlenz parents: diff changeset	277 ... ${greeting}, ${name}!
821114ec4f69 Initial import. cmlenz parents: diff changeset	278 ... </p>
90 242610137d1f When an expression evaluates to a callable, it is called implicitly. cmlenz parents: 89 diff changeset	279 ... ${echo('Hi', name='you')}
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	280 ... </div>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	281 >>> print tmpl.generate(bar='Bye')
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	282 <div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	283 <p class="message">
90 242610137d1f When an expression evaluates to a callable, it is called implicitly. cmlenz parents: 89 diff changeset	284 Hi, you!
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	285 </p>
821114ec4f69 Initial import. cmlenz parents: diff changeset	286 </div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	287
90 242610137d1f When an expression evaluates to a callable, it is called implicitly. cmlenz parents: 89 diff changeset	288 If a function does not require parameters, the parenthesis can be omitted
242610137d1f When an expression evaluates to a callable, it is called implicitly. cmlenz parents: 89 diff changeset	289 both when defining and when calling it:
242610137d1f When an expression evaluates to a callable, it is called implicitly. cmlenz parents: 89 diff changeset	290
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	291 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/">
90 242610137d1f When an expression evaluates to a callable, it is called implicitly. cmlenz parents: 89 diff changeset	292 ... <p py:def="helloworld" class="message">
242610137d1f When an expression evaluates to a callable, it is called implicitly. cmlenz parents: 89 diff changeset	293 ... Hello, world!
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	294 ... </p>
90 242610137d1f When an expression evaluates to a callable, it is called implicitly. cmlenz parents: 89 diff changeset	295 ... ${helloworld}
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	296 ... </div>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	297 >>> print tmpl.generate(bar='Bye')
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	298 <div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	299 <p class="message">
90 242610137d1f When an expression evaluates to a callable, it is called implicitly. cmlenz parents: 89 diff changeset	300 Hello, world!
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	301 </p>
821114ec4f69 Initial import. cmlenz parents: diff changeset	302 </div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	303 """
154 1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	304 __slots__ = ['name', 'args', 'defaults']
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	305
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	306 ATTRIBUTE = 'function'
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	307
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	308 def __init__(self, args, filename=None, lineno=-1, offset=-1):
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	309 Directive.__init__(self, None, filename, lineno, offset)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	310 ast = compiler.parse(args, 'eval').node
821114ec4f69 Initial import. cmlenz parents: diff changeset	311 self.args = []
821114ec4f69 Initial import. cmlenz parents: diff changeset	312 self.defaults = {}
821114ec4f69 Initial import. cmlenz parents: diff changeset	313 if isinstance(ast, compiler.ast.CallFunc):
821114ec4f69 Initial import. cmlenz parents: diff changeset	314 self.name = ast.node.name
821114ec4f69 Initial import. cmlenz parents: diff changeset	315 for arg in ast.args:
821114ec4f69 Initial import. cmlenz parents: diff changeset	316 if isinstance(arg, compiler.ast.Keyword):
821114ec4f69 Initial import. cmlenz parents: diff changeset	317 self.args.append(arg.name)
165 4ed68a904235 Fix handling of keyword arguments in `py:def` directive. Thanks to Christian Boos for reporting the problem and providing the basic patch for this change. cmlenz parents: 161 diff changeset	318 self.defaults[arg.name] = Expression(arg.expr, filename,
4ed68a904235 Fix handling of keyword arguments in `py:def` directive. Thanks to Christian Boos for reporting the problem and providing the basic patch for this change. cmlenz parents: 161 diff changeset	319 lineno)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	320 else:
821114ec4f69 Initial import. cmlenz parents: diff changeset	321 self.args.append(arg.name)
821114ec4f69 Initial import. cmlenz parents: diff changeset	322 else:
821114ec4f69 Initial import. cmlenz parents: diff changeset	323 self.name = ast.name
821114ec4f69 Initial import. cmlenz parents: diff changeset	324
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	325 def __call__(self, stream, ctxt, directives):
154 1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	326 stream = list(stream)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	327
154 1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	328 def function(args, *kwargs):
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	329 scope = {}
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	330 args = list(args) # make mutable
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	331 for name in self.args:
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	332 if args:
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	333 scope[name] = args.pop(0)
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	334 else:
165 4ed68a904235 Fix handling of keyword arguments in `py:def` directive. Thanks to Christian Boos for reporting the problem and providing the basic patch for this change. cmlenz parents: 161 diff changeset	335 if name in kwargs:
4ed68a904235 Fix handling of keyword arguments in `py:def` directive. Thanks to Christian Boos for reporting the problem and providing the basic patch for this change. cmlenz parents: 161 diff changeset	336 val = kwargs.pop(name)
4ed68a904235 Fix handling of keyword arguments in `py:def` directive. Thanks to Christian Boos for reporting the problem and providing the basic patch for this change. cmlenz parents: 161 diff changeset	337 else:
4ed68a904235 Fix handling of keyword arguments in `py:def` directive. Thanks to Christian Boos for reporting the problem and providing the basic patch for this change. cmlenz parents: 161 diff changeset	338 val = self.defaults.get(name).evaluate(ctxt)
4ed68a904235 Fix handling of keyword arguments in `py:def` directive. Thanks to Christian Boos for reporting the problem and providing the basic patch for this change. cmlenz parents: 161 diff changeset	339 scope[name] = val
154 1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	340 ctxt.push(scope)
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	341 for event in _apply_directives(stream, ctxt, directives):
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	342 yield event
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	343 ctxt.pop()
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	344 try:
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	345 function.__name__ = self.name
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	346 except TypeError:
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	347 # Function name can't be set in Python 2.3
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	348 pass
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	349
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	350 # Store the function reference in the bottom context frame so that it
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	351 # doesn't get popped off before processing the template has finished
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	352 ctxt.frames[-1][self.name] = function
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	353
1c404be518d1 * Make sure `py:def` macros don't go out of scope if they are defined inside another directive. cmlenz parents: 153 diff changeset	354 return []
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	355
172 4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	356 def __repr__(self):
4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	357 return '<%s "%s">' % (self.__class__.__name__, self.name)
4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	358
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	359
821114ec4f69 Initial import. cmlenz parents: diff changeset	360 class ForDirective(Directive):
31 9a958398bed9 * More test cases for expression evaluation. cmlenz parents: 29 diff changeset	361 """Implementation of the `py:for` template directive for repeating an
9a958398bed9 * More test cases for expression evaluation. cmlenz parents: 29 diff changeset	362 element based on an iterable in the context data.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	363
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	364 >>> tmpl = Template('''<ul xmlns:py="http://markup.edgewall.org/">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	365 ... <li py:for="item in items">${item}</li>
821114ec4f69 Initial import. cmlenz parents: diff changeset	366 ... </ul>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	367 >>> print tmpl.generate(items=[1, 2, 3])
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	368 <ul>
821114ec4f69 Initial import. cmlenz parents: diff changeset	369 <li>1</li><li>2</li><li>3</li>
821114ec4f69 Initial import. cmlenz parents: diff changeset	370 </ul>
821114ec4f69 Initial import. cmlenz parents: diff changeset	371 """
821114ec4f69 Initial import. cmlenz parents: diff changeset	372 __slots__ = ['targets']
821114ec4f69 Initial import. cmlenz parents: diff changeset	373
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	374 ATTRIBUTE = 'each'
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	375
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	376 def __init__(self, value, filename=None, lineno=-1, offset=-1):
29 4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	377 targets, value = value.split(' in ', 1)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	378 self.targets = [str(name.strip()) for name in targets.split(',')]
140 a2edde90ad24 Fix bug in HTML serializer, plus some other minor tweaks. cmlenz parents: 139 diff changeset	379 Directive.__init__(self, value.strip(), filename, lineno, offset)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	380
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	381 def __call__(self, stream, ctxt, directives):
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	382 iterable = self.expr.evaluate(ctxt)
101 ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	383 if iterable is None:
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	384 return
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	385
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	386 scope = {}
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	387 stream = list(stream)
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	388 targets = self.targets
140 a2edde90ad24 Fix bug in HTML serializer, plus some other minor tweaks. cmlenz parents: 139 diff changeset	389 single = len(targets) == 1
101 ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	390 for item in iter(iterable):
140 a2edde90ad24 Fix bug in HTML serializer, plus some other minor tweaks. cmlenz parents: 139 diff changeset	391 if single:
101 ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	392 scope[targets[0]] = item
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	393 else:
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	394 for idx, name in enumerate(targets):
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	395 scope[name] = item[idx]
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	396 ctxt.push(scope)
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	397 for event in _apply_directives(stream, ctxt, directives):
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	398 yield event
ef6794139671 Ported [115] to trunk. cmlenz parents: 95 diff changeset	399 ctxt.pop()
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	400
821114ec4f69 Initial import. cmlenz parents: diff changeset	401 def __repr__(self):
821114ec4f69 Initial import. cmlenz parents: diff changeset	402 return '<%s "%s in %s">' % (self.__class__.__name__,
821114ec4f69 Initial import. cmlenz parents: diff changeset	403 ', '.join(self.targets), self.expr.source)
821114ec4f69 Initial import. cmlenz parents: diff changeset	404
821114ec4f69 Initial import. cmlenz parents: diff changeset	405
821114ec4f69 Initial import. cmlenz parents: diff changeset	406 class IfDirective(Directive):
31 9a958398bed9 * More test cases for expression evaluation. cmlenz parents: 29 diff changeset	407 """Implementation of the `py:if` template directive for conditionally
9a958398bed9 * More test cases for expression evaluation. cmlenz parents: 29 diff changeset	408 excluding elements from being output.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	409
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	410 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	411 ... <b py:if="foo">${bar}</b>
821114ec4f69 Initial import. cmlenz parents: diff changeset	412 ... </div>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	413 >>> print tmpl.generate(foo=True, bar='Hello')
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	414 <div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	415 <b>Hello</b>
821114ec4f69 Initial import. cmlenz parents: diff changeset	416 </div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	417 """
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	418 __slots__ = []
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	419
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	420 ATTRIBUTE = 'test'
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	421
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	422 def __call__(self, stream, ctxt, directives):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	423 if self.expr.evaluate(ctxt):
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	424 return _apply_directives(stream, ctxt, directives)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	425 return []
821114ec4f69 Initial import. cmlenz parents: diff changeset	426
821114ec4f69 Initial import. cmlenz parents: diff changeset	427
821114ec4f69 Initial import. cmlenz parents: diff changeset	428 class MatchDirective(Directive):
821114ec4f69 Initial import. cmlenz parents: diff changeset	429 """Implementation of the `py:match` template directive.
14 76b5d4b189e6 The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general. cmlenz parents: 13 diff changeset	430
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	431 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/">
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	432 ... <span py:match="greeting">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	433 ... Hello ${select('@name')}
821114ec4f69 Initial import. cmlenz parents: diff changeset	434 ... </span>
821114ec4f69 Initial import. cmlenz parents: diff changeset	435 ... <greeting name="Dude" />
821114ec4f69 Initial import. cmlenz parents: diff changeset	436 ... </div>''')
14 76b5d4b189e6 The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general. cmlenz parents: 13 diff changeset	437 >>> print tmpl.generate()
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	438 <div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	439 <span>
821114ec4f69 Initial import. cmlenz parents: diff changeset	440 Hello Dude
821114ec4f69 Initial import. cmlenz parents: diff changeset	441 </span>
821114ec4f69 Initial import. cmlenz parents: diff changeset	442 </div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	443 """
821114ec4f69 Initial import. cmlenz parents: diff changeset	444 __slots__ = ['path', 'stream']
821114ec4f69 Initial import. cmlenz parents: diff changeset	445
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	446 ATTRIBUTE = 'path'
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	447
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	448 def __init__(self, value, filename=None, lineno=-1, offset=-1):
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	449 Directive.__init__(self, None, filename, lineno, offset)
139 54131cbb91a5 Implement position reporting for XPath syntax errors. Closes #20. cmlenz parents: 134 diff changeset	450 self.path = Path(value, filename, lineno)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	451 self.stream = []
821114ec4f69 Initial import. cmlenz parents: diff changeset	452
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	453 def __call__(self, stream, ctxt, directives):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	454 self.stream = list(stream)
38 fec9f4897415 Fix for #2 (incorrect context node in path expressions). Still some paths that produce incorrect results, but the common case seems to work now. cmlenz parents: 37 diff changeset	455 ctxt._match_templates.append((self.path.test(ignore_context=True),
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	456 self.path, self.stream, directives))
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	457 return []
821114ec4f69 Initial import. cmlenz parents: diff changeset	458
821114ec4f69 Initial import. cmlenz parents: diff changeset	459 def __repr__(self):
14 76b5d4b189e6 The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general. cmlenz parents: 13 diff changeset	460 return '<%s "%s">' % (self.__class__.__name__, self.path.source)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	461
821114ec4f69 Initial import. cmlenz parents: diff changeset	462
821114ec4f69 Initial import. cmlenz parents: diff changeset	463 class ReplaceDirective(Directive):
821114ec4f69 Initial import. cmlenz parents: diff changeset	464 """Implementation of the `py:replace` template directive.
821114ec4f69 Initial import. cmlenz parents: diff changeset	465
31 9a958398bed9 * More test cases for expression evaluation. cmlenz parents: 29 diff changeset	466 This directive replaces the element with the result of evaluating the
9a958398bed9 * More test cases for expression evaluation. cmlenz parents: 29 diff changeset	467 value of the `py:replace` attribute:
9a958398bed9 * More test cases for expression evaluation. cmlenz parents: 29 diff changeset	468
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	469 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	470 ... <span py:replace="bar">Hello</span>
821114ec4f69 Initial import. cmlenz parents: diff changeset	471 ... </div>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	472 >>> print tmpl.generate(bar='Bye')
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	473 <div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	474 Bye
821114ec4f69 Initial import. cmlenz parents: diff changeset	475 </div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	476
821114ec4f69 Initial import. cmlenz parents: diff changeset	477 This directive is equivalent to `py:content` combined with `py:strip`,
821114ec4f69 Initial import. cmlenz parents: diff changeset	478 providing a less verbose way to achieve the same effect:
821114ec4f69 Initial import. cmlenz parents: diff changeset	479
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	480 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	481 ... <span py:content="bar" py:strip="">Hello</span>
821114ec4f69 Initial import. cmlenz parents: diff changeset	482 ... </div>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	483 >>> print tmpl.generate(bar='Bye')
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	484 <div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	485 Bye
821114ec4f69 Initial import. cmlenz parents: diff changeset	486 </div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	487 """
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	488 __slots__ = []
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	489
54 01981cbc7575 Fix a number of escaping problems: cmlenz parents: 53 diff changeset	490 def __call__(self, stream, ctxt, directives):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	491 kind, data, pos = stream.next()
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	492 yield EXPR, self.expr, pos
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	493
821114ec4f69 Initial import. cmlenz parents: diff changeset	494
821114ec4f69 Initial import. cmlenz parents: diff changeset	495 class StripDirective(Directive):
821114ec4f69 Initial import. cmlenz parents: diff changeset	496 """Implementation of the `py:strip` template directive.
821114ec4f69 Initial import. cmlenz parents: diff changeset	497
821114ec4f69 Initial import. cmlenz parents: diff changeset	498 When the value of the `py:strip` attribute evaluates to `True`, the element
821114ec4f69 Initial import. cmlenz parents: diff changeset	499 is stripped from the output
821114ec4f69 Initial import. cmlenz parents: diff changeset	500
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	501 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	502 ... <div py:strip="True"><b>foo</b></div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	503 ... </div>''')
14 76b5d4b189e6 The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general. cmlenz parents: 13 diff changeset	504 >>> print tmpl.generate()
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	505 <div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	506 <b>foo</b>
821114ec4f69 Initial import. cmlenz parents: diff changeset	507 </div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	508
37 224b0b41d1da Moved some of the tests for the strip directive to a new unittest test case to not clutter up the documentation. cmlenz parents: 36 diff changeset	509 Leaving the attribute value empty is equivalent to a truth value.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	510
821114ec4f69 Initial import. cmlenz parents: diff changeset	511 This directive is particulary interesting for named template functions or
821114ec4f69 Initial import. cmlenz parents: diff changeset	512 match templates that do not generate a top-level element:
821114ec4f69 Initial import. cmlenz parents: diff changeset	513
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	514 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/">
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	515 ... <div py:def="echo(what)" py:strip="">
821114ec4f69 Initial import. cmlenz parents: diff changeset	516 ... <b>${what}</b>
821114ec4f69 Initial import. cmlenz parents: diff changeset	517 ... </div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	518 ... ${echo('foo')}
821114ec4f69 Initial import. cmlenz parents: diff changeset	519 ... </div>''')
14 76b5d4b189e6 The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general. cmlenz parents: 13 diff changeset	520 >>> print tmpl.generate()
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	521 <div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	522 <b>foo</b>
821114ec4f69 Initial import. cmlenz parents: diff changeset	523 </div>
821114ec4f69 Initial import. cmlenz parents: diff changeset	524 """
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	525 __slots__ = []
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	526
54 01981cbc7575 Fix a number of escaping problems: cmlenz parents: 53 diff changeset	527 def __call__(self, stream, ctxt, directives):
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	528 def _generate():
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	529 if self.expr:
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	530 strip = self.expr.evaluate(ctxt)
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	531 else:
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	532 strip = True
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	533 if strip:
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	534 stream.next() # skip start tag
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	535 previous = stream.next()
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	536 for event in stream:
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	537 yield previous
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	538 previous = event
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	539 else:
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	540 for event in stream:
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	541 yield event
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	542
fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	543 return _apply_directives(_generate(), ctxt, directives)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	544
821114ec4f69 Initial import. cmlenz parents: diff changeset	545
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	546 class ChooseDirective(Directive):
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	547 """Implementation of the `py:choose` directive for conditionally selecting
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	548 one of several body elements to display.
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	549
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	550 If the `py:choose` expression is empty the expressions of nested `py:when`
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	551 directives are tested for truth. The first true `py:when` body is output.
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	552 If no `py:when` directive is matched then the fallback directive
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	553 `py:otherwise` will be used.
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	554
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	555 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	556 ... py:choose="">
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	557 ... <span py:when="0 == 1">0</span>
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	558 ... <span py:when="1 == 1">1</span>
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	559 ... <span py:otherwise="">2</span>
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	560 ... </div>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	561 >>> print tmpl.generate()
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	562 <div>
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	563 <span>1</span>
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	564 </div>
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	565
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	566 If the `py:choose` directive contains an expression, the nested `py:when`
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	567 directives are tested for equality to the `py:choose` expression:
60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	568
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	569 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	570 ... py:choose="2">
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	571 ... <span py:when="1">1</span>
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	572 ... <span py:when="2">2</span>
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	573 ... </div>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	574 >>> print tmpl.generate()
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	575 <div>
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	576 <span>2</span>
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	577 </div>
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	578
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	579 Behavior is undefined if a `py:choose` block contains content outside a
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	580 `py:when` or `py:otherwise` block. Behavior is also undefined if a
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	581 `py:otherwise` occurs before `py:when` blocks.
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	582 """
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	583 __slots__ = ['matched', 'value']
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	584
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	585 ATTRIBUTE = 'test'
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	586
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	587 def __call__(self, stream, ctxt, directives):
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	588 if self.expr:
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	589 self.value = self.expr.evaluate(ctxt)
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	590 self.matched = False
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	591 ctxt.push(dict(_choose=self))
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	592 for event in _apply_directives(stream, ctxt, directives):
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	593 yield event
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	594 ctxt.pop()
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	595
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	596
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	597 class WhenDirective(Directive):
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	598 """Implementation of the `py:when` directive for nesting in a parent with
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	599 the `py:choose` directive.
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	600
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	601 See the documentation of `py:choose` for usage.
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	602 """
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	603
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	604 ATTRIBUTE = 'test'
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	605
54 01981cbc7575 Fix a number of escaping problems: cmlenz parents: 53 diff changeset	606 def __call__(self, stream, ctxt, directives):
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	607 choose = ctxt['_choose']
166 718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	608 if not choose:
718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	609 raise TemplateSyntaxError('when directives can only be used inside '
718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	610 'a choose directive', *stream.next()[2])
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	611 if choose.matched:
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	612 return []
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	613 value = self.expr.evaluate(ctxt)
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	614 try:
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	615 if value == choose.value:
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	616 choose.matched = True
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	617 return _apply_directives(stream, ctxt, directives)
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	618 except AttributeError:
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	619 if value:
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	620 choose.matched = True
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	621 return _apply_directives(stream, ctxt, directives)
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	622 return []
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	623
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	624
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	625 class OtherwiseDirective(Directive):
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	626 """Implementation of the `py:otherwise` directive for nesting in a parent
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	627 with the `py:choose` directive.
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	628
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	629 See the documentation of `py:choose` for usage.
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	630 """
54 01981cbc7575 Fix a number of escaping problems: cmlenz parents: 53 diff changeset	631 def __call__(self, stream, ctxt, directives):
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	632 choose = ctxt['_choose']
166 718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	633 if not choose:
718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	634 raise TemplateSyntaxError('an otherwise directive can only be used '
718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	635 'inside a choose directive',
718cba809cea Better error reporting for errors in directive expressions, and when `py:otherwise`/`py:when` are used outside a `py:choose` directive. Thanks to Christian Boos for the initial patch. cmlenz parents: 165 diff changeset	636 *stream.next()[2])
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	637 if choose.matched:
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	638 return []
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	639 choose.matched = True
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	640 return _apply_directives(stream, ctxt, directives)
44 42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	641
42bcb91bf025 implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks mgood parents: 38 diff changeset	642
104 e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	643 class WithDirective(Directive):
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	644 """Implementation of the `py:with` template directive, which allows
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	645 shorthand access to variables and expressions.
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	646
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	647 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/">
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	648 ... <span py:with="y=7; z=x+10">$x $y $z</span>
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	649 ... </div>''')
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	650 >>> print tmpl.generate(x=42)
104 e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	651 <div>
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	652 <span>42 7 52</span>
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	653 </div>
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	654 """
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	655 __slots__ = ['vars']
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	656
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	657 ATTRIBUTE = 'vars'
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	658
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	659 def __init__(self, value, filename=None, lineno=-1, offset=-1):
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	660 Directive.__init__(self, None, filename, lineno, offset)
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	661 self.vars = []
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	662 try:
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	663 for stmt in value.split(';'):
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	664 name, value = stmt.split('=', 1)
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	665 self.vars.append((name.strip(),
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	666 Expression(value.strip(), filename, lineno)))
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	667 except SyntaxError, err:
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	668 raise TemplateSyntaxError(err, filename, lineno,
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	669 offset + (err.offset or 0))
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	670
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	671 def __call__(self, stream, ctxt, directives):
120 eb6cead67474 * Allow `py:with` directives to define `lambda`s cmlenz parents: 116 diff changeset	672 ctxt.push(dict([(name, expr.evaluate(ctxt, nocall=True))
104 e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	673 for name, expr in self.vars]))
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	674 for event in _apply_directives(stream, ctxt, directives):
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	675 yield event
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	676 ctxt.pop()
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	677
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	678 def __repr__(self):
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	679 return '<%s "%s">' % (self.__class__.__name__,
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	680 '; '.join(['%s = %s' % (name, expr.source)
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	681 for name, expr in self.vars]))
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	682
e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	683
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	684 class Template(object):
821114ec4f69 Initial import. cmlenz parents: diff changeset	685 """Can parse a template and transform it into the corresponding output
821114ec4f69 Initial import. cmlenz parents: diff changeset	686 based on context data.
821114ec4f69 Initial import. cmlenz parents: diff changeset	687 """
61 33c2702cf6da Use a different namespace than Kid uses. cmlenz parents: 54 diff changeset	688 NAMESPACE = Namespace('http://markup.edgewall.org/')
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	689
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	690 EXPR = StreamEventKind('EXPR') # an expression
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	691 SUB = StreamEventKind('SUB') # a "subprogram"
10 c5890ef863ba Moved the template-specific stream event kinds into the template module. cmlenz parents: 6 diff changeset	692
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	693 directives = [('def', DefDirective),
821114ec4f69 Initial import. cmlenz parents: diff changeset	694 ('match', MatchDirective),
120 eb6cead67474 * Allow `py:with` directives to define `lambda`s cmlenz parents: 116 diff changeset	695 ('when', WhenDirective),
eb6cead67474 * Allow `py:with` directives to define `lambda`s cmlenz parents: 116 diff changeset	696 ('otherwise', OtherwiseDirective),
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	697 ('for', ForDirective),
821114ec4f69 Initial import. cmlenz parents: diff changeset	698 ('if', IfDirective),
53 60f1a556690e * Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive. cmlenz parents: 51 diff changeset	699 ('choose', ChooseDirective),
104 e9259920db05 Added `py:with` directive based on Jonas' patch in #17. cmlenz parents: 101 diff changeset	700 ('with', WithDirective),
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	701 ('replace', ReplaceDirective),
821114ec4f69 Initial import. cmlenz parents: diff changeset	702 ('content', ContentDirective),
821114ec4f69 Initial import. cmlenz parents: diff changeset	703 ('attrs', AttrsDirective),
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	704 ('strip', StripDirective)]
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	705 _dir_by_name = dict(directives)
821114ec4f69 Initial import. cmlenz parents: diff changeset	706 _dir_order = [directive[1] for directive in directives]
821114ec4f69 Initial import. cmlenz parents: diff changeset	707
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	708 def __init__(self, source, basedir=None, filename=None):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	709 """Initialize a template from either a string or a file-like object."""
821114ec4f69 Initial import. cmlenz parents: diff changeset	710 if isinstance(source, basestring):
821114ec4f69 Initial import. cmlenz parents: diff changeset	711 self.source = StringIO(source)
821114ec4f69 Initial import. cmlenz parents: diff changeset	712 else:
821114ec4f69 Initial import. cmlenz parents: diff changeset	713 self.source = source
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	714 self.basedir = basedir
172 4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	715 self.filename = filename
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	716 if basedir and filename:
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	717 self.filepath = os.path.join(basedir, filename)
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	718 else:
172 4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	719 self.filepath = None
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	720
23 00835401c8cc Separate match and eval filters from the include and user-supplied filters. cmlenz parents: 22 diff changeset	721 self.filters = []
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	722 self.parse()
821114ec4f69 Initial import. cmlenz parents: diff changeset	723
821114ec4f69 Initial import. cmlenz parents: diff changeset	724 def __repr__(self):
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	725 return '<%s "%s">' % (self.__class__.__name__, self.filename)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	726
821114ec4f69 Initial import. cmlenz parents: diff changeset	727 def parse(self):
821114ec4f69 Initial import. cmlenz parents: diff changeset	728 """Parse the template.
821114ec4f69 Initial import. cmlenz parents: diff changeset	729
821114ec4f69 Initial import. cmlenz parents: diff changeset	730 The parsing stage parses the XML template and constructs a list of
821114ec4f69 Initial import. cmlenz parents: diff changeset	731 directives that will be executed in the render stage. The input is
821114ec4f69 Initial import. cmlenz parents: diff changeset	732 split up into literal output (markup that does not depend on the
821114ec4f69 Initial import. cmlenz parents: diff changeset	733 context data) and actual directives (commands or variable
821114ec4f69 Initial import. cmlenz parents: diff changeset	734 substitution).
821114ec4f69 Initial import. cmlenz parents: diff changeset	735 """
821114ec4f69 Initial import. cmlenz parents: diff changeset	736 stream = [] # list of events of the "compiled" template
821114ec4f69 Initial import. cmlenz parents: diff changeset	737 dirmap = {} # temporary mapping of directives to elements
821114ec4f69 Initial import. cmlenz parents: diff changeset	738 ns_prefix = {}
821114ec4f69 Initial import. cmlenz parents: diff changeset	739 depth = 0
821114ec4f69 Initial import. cmlenz parents: diff changeset	740
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	741 for kind, data, pos in XMLParser(self.source, filename=self.filename):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	742
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	743 if kind is START_NS:
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	744 # Strip out the namespace declaration for template directives
821114ec4f69 Initial import. cmlenz parents: diff changeset	745 prefix, uri = data
821114ec4f69 Initial import. cmlenz parents: diff changeset	746 if uri == self.NAMESPACE:
821114ec4f69 Initial import. cmlenz parents: diff changeset	747 ns_prefix[prefix] = uri
821114ec4f69 Initial import. cmlenz parents: diff changeset	748 else:
821114ec4f69 Initial import. cmlenz parents: diff changeset	749 stream.append((kind, data, pos))
821114ec4f69 Initial import. cmlenz parents: diff changeset	750
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	751 elif kind is END_NS:
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	752 if data in ns_prefix:
821114ec4f69 Initial import. cmlenz parents: diff changeset	753 del ns_prefix[data]
821114ec4f69 Initial import. cmlenz parents: diff changeset	754 else:
821114ec4f69 Initial import. cmlenz parents: diff changeset	755 stream.append((kind, data, pos))
821114ec4f69 Initial import. cmlenz parents: diff changeset	756
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	757 elif kind is START:
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	758 # Record any directive attributes in start tags
821114ec4f69 Initial import. cmlenz parents: diff changeset	759 tag, attrib = data
821114ec4f69 Initial import. cmlenz parents: diff changeset	760 directives = []
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	761 strip = False
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	762
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	763 if tag in self.NAMESPACE:
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	764 cls = self._dir_by_name.get(tag.localname)
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	765 if cls is None:
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	766 raise BadDirectiveError(tag, pos[0], pos[1])
66 822089ae65ce Switch copyright to Edgewall and URLs to markup.edgewall.org. cmlenz parents: 65 diff changeset	767 value = attrib.get(getattr(cls, 'ATTRIBUTE', None), '')
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	768 directives.append(cls(value, *pos))
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	769 strip = True
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	770
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	771 new_attrib = []
821114ec4f69 Initial import. cmlenz parents: diff changeset	772 for name, value in attrib:
18 4cbebb15a834 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	773 if name in self.NAMESPACE:
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	774 cls = self._dir_by_name.get(name.localname)
821114ec4f69 Initial import. cmlenz parents: diff changeset	775 if cls is None:
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	776 raise BadDirectiveError(name, pos[0], pos[1])
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	777 directives.append(cls(value, *pos))
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	778 else:
75 c3c26300a46d Empty attributes in templates were being stripped out. Thanks to Jonas for the patch. cmlenz parents: 74 diff changeset	779 if value:
c3c26300a46d Empty attributes in templates were being stripped out. Thanks to Jonas for the patch. cmlenz parents: 74 diff changeset	780 value = list(self._interpolate(value, *pos))
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	781 if len(value) == 1 and value[0][0] is TEXT:
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	782 value = value[0][1]
75 c3c26300a46d Empty attributes in templates were being stripped out. Thanks to Jonas for the patch. cmlenz parents: 74 diff changeset	783 else:
c3c26300a46d Empty attributes in templates were being stripped out. Thanks to Jonas for the patch. cmlenz parents: 74 diff changeset	784 value = [(TEXT, u'', pos)]
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	785 new_attrib.append((name, value))
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	786
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	787 if directives:
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	788 directives.sort(lambda a, b: cmp(self._dir_order.index(a.__class__),
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	789 self._dir_order.index(b.__class__)))
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	790 dirmap[(depth, tag)] = (directives, len(stream), strip)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	791
821114ec4f69 Initial import. cmlenz parents: diff changeset	792 stream.append((kind, (tag, Attributes(new_attrib)), pos))
821114ec4f69 Initial import. cmlenz parents: diff changeset	793 depth += 1
821114ec4f69 Initial import. cmlenz parents: diff changeset	794
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	795 elif kind is END:
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	796 depth -= 1
821114ec4f69 Initial import. cmlenz parents: diff changeset	797 stream.append((kind, data, pos))
821114ec4f69 Initial import. cmlenz parents: diff changeset	798
821114ec4f69 Initial import. cmlenz parents: diff changeset	799 # If there have have directive attributes with the corresponding
821114ec4f69 Initial import. cmlenz parents: diff changeset	800 # start tag, move the events inbetween into a "subprogram"
821114ec4f69 Initial import. cmlenz parents: diff changeset	801 if (depth, data) in dirmap:
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	802 directives, start_offset, strip = dirmap.pop((depth, data))
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	803 substream = stream[start_offset:]
65 5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	804 if strip:
5c024cf58ecb Support the use of directives as elements to reduce the need for using `py:strip`. cmlenz parents: 61 diff changeset	805 substream = substream[1:-1]
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	806 stream[start_offset:] = [(SUB, (directives, substream),
e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	807 pos)]
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	808
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	809 elif kind is TEXT:
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	810 for kind, data, pos in self._interpolate(data, *pos):
821114ec4f69 Initial import. cmlenz parents: diff changeset	811 stream.append((kind, data, pos))
821114ec4f69 Initial import. cmlenz parents: diff changeset	812
89 d4c7617900e3 Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 87 diff changeset	813 elif kind is COMMENT:
d4c7617900e3 Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 87 diff changeset	814 if not data.lstrip().startswith('!'):
d4c7617900e3 Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 87 diff changeset	815 stream.append((kind, data, pos))
d4c7617900e3 Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 87 diff changeset	816
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	817 else:
821114ec4f69 Initial import. cmlenz parents: diff changeset	818 stream.append((kind, data, pos))
821114ec4f69 Initial import. cmlenz parents: diff changeset	819
821114ec4f69 Initial import. cmlenz parents: diff changeset	820 self.stream = stream
821114ec4f69 Initial import. cmlenz parents: diff changeset	821
821114ec4f69 Initial import. cmlenz parents: diff changeset	822 _FULL_EXPR_RE = re.compile(r'(?<!\$)\$\{(.+?)\}')
821114ec4f69 Initial import. cmlenz parents: diff changeset	823 _SHORT_EXPR_RE = re.compile(r'(?<!\$)\$([a-zA-Z][a-zA-Z0-9_\.]*)')
821114ec4f69 Initial import. cmlenz parents: diff changeset	824
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	825 def _interpolate(cls, text, filename=None, lineno=-1, offset=-1):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	826 """Parse the given string and extract expressions.
821114ec4f69 Initial import. cmlenz parents: diff changeset	827
821114ec4f69 Initial import. cmlenz parents: diff changeset	828 This method returns a list containing both literal text and `Expression`
821114ec4f69 Initial import. cmlenz parents: diff changeset	829 objects.
14 76b5d4b189e6 The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general. cmlenz parents: 13 diff changeset	830
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	831 @param text: the text to parse
821114ec4f69 Initial import. cmlenz parents: diff changeset	832 @param lineno: the line number at which the text was found (optional)
821114ec4f69 Initial import. cmlenz parents: diff changeset	833 @param offset: the column number at which the text starts in the source
821114ec4f69 Initial import. cmlenz parents: diff changeset	834 (optional)
821114ec4f69 Initial import. cmlenz parents: diff changeset	835 """
134 df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	836 def _interpolate(text, patterns, filename=filename, lineno=lineno,
df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	837 offset=offset):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	838 for idx, group in enumerate(patterns.pop(0).split(text)):
821114ec4f69 Initial import. cmlenz parents: diff changeset	839 if idx % 2:
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	840 try:
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	841 yield EXPR, Expression(group, filename, lineno), \
134 df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	842 (filename, lineno, offset)
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	843 except SyntaxError, err:
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	844 raise TemplateSyntaxError(err, filename, lineno,
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	845 offset + (err.offset or 0))
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	846 elif group:
821114ec4f69 Initial import. cmlenz parents: diff changeset	847 if patterns:
74 3c271699c398 Fix expression interpolation where both shorthand notation and full notation are used inside a single text node. Thanks Jonas. cmlenz parents: 73 diff changeset	848 for result in _interpolate(group, patterns[:]):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	849 yield result
821114ec4f69 Initial import. cmlenz parents: diff changeset	850 else:
134 df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	851 yield TEXT, group.replace('$$', '$'), \
df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	852 (filename, lineno, offset)
df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	853 if '\n' in group:
df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	854 lines = group.splitlines()
df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	855 lineno += len(lines) - 1
df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	856 offset += len(lines[-1])
df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	857 else:
df44110ca91d * Improve the accuracy of line numbers for text nodes, so that reported errors about syntax or evaluation errors in expressions point to the right line (not quite perfect yet, though). cmlenz parents: 133 diff changeset	858 offset += len(group)
74 3c271699c398 Fix expression interpolation where both shorthand notation and full notation are used inside a single text node. Thanks Jonas. cmlenz parents: 73 diff changeset	859 return _interpolate(text, [cls._FULL_EXPR_RE, cls._SHORT_EXPR_RE])
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	860 _interpolate = classmethod(_interpolate)
821114ec4f69 Initial import. cmlenz parents: diff changeset	861
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	862 def generate(self, args, *kwargs):
29 4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	863 """Apply the template to the given context data.
4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	864
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	865 Any keyword arguments are made available to the template as context
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	866 data.
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	867
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	868 Only one positional argument is accepted: if it is provided, it must be
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	869 an instance of the `Context` class, and keyword arguments are ignored.
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	870 This calling style is used for internal processing.
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	871
29 4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	872 @return: a markup event stream representing the result of applying
4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	873 the template to the context data.
4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	874 """
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	875 if args:
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	876 assert len(args) == 1
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	877 ctxt = args[0]
173 ae5d2f4a378a Fix for #33. cmlenz parents: 172 diff changeset	878 if ctxt is None:
ae5d2f4a378a Fix for #33. cmlenz parents: 172 diff changeset	879 ctxt = Context(**kwargs)
149 7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	880 assert isinstance(ctxt, Context)
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	881 else:
7306bf730ff3 `Template.generate()` now accepts the context data as keyword arguments, so that you don't have to import the `Context` class every time you want to pass data into a template. cmlenz parents: 145 diff changeset	882 ctxt = Context(**kwargs)
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	883
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	884 stream = self.stream
e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	885 for filter_ in [self._eval, self._match, self._flatten] + self.filters:
35 3bc4778787c5 Simplify template processing model by removing dynamically generated `SUB` events. cmlenz parents: 31 diff changeset	886 stream = filter_(iter(stream), ctxt)
3bc4778787c5 Simplify template processing model by removing dynamically generated `SUB` events. cmlenz parents: 31 diff changeset	887 return Stream(stream)
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	888
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	889 def _eval(self, stream, ctxt=None):
29 4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	890 """Internal stream filter that evaluates any expressions in `START` and
4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	891 `TEXT` events.
4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	892 """
172 4b4e80b2b0b5 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 166 diff changeset	893 filters = (self._eval, self._match, self._flatten)
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	894
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	895 for kind, data, pos in stream:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	896
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	897 if kind is START and data[1]:
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	898 # Attributes may still contain expressions in start tags at
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	899 # this point, so do some evaluation
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	900 tag, attrib = data
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	901 new_attrib = []
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	902 for name, substream in attrib:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	903 if isinstance(substream, basestring):
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	904 value = substream
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	905 else:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	906 values = []
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	907 for subkind, subdata, subpos in substream:
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	908 if subkind is EXPR:
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	909 values.append(subdata.evaluate(ctxt))
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	910 else:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	911 values.append(subdata)
48 06c642ba2b08 convert the result of expressions in attributes to strings so that values like ints are output correctly mgood parents: 44 diff changeset	912 value = [unicode(x) for x in values if x is not None]
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	913 if not value:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	914 continue
23 00835401c8cc Separate match and eval filters from the include and user-supplied filters. cmlenz parents: 22 diff changeset	915 new_attrib.append((name, u''.join(value)))
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	916 yield kind, (tag, Attributes(new_attrib)), pos
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	917
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	918 elif kind is EXPR:
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	919 result = data.evaluate(ctxt)
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	920 if result is None:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	921 continue
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	922
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	923 # First check for a string, otherwise the iterable test below
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	924 # succeeds, and the string will be chopped up into individual
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	925 # characters
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	926 if isinstance(result, basestring):
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	927 yield TEXT, result, pos
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	928 else:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	929 # Test if the expression evaluated to an iterable, in which
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	930 # case we yield the individual items
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	931 try:
111 8a4d9064f363 Some fixes and more unit tests for the XPath engine. cmlenz parents: 104 diff changeset	932 substream = _ensure(result)
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	933 for filter_ in filters:
77 f1aa49c759b2 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 75 diff changeset	934 substream = filter_(substream, ctxt)
f1aa49c759b2 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 75 diff changeset	935 for event in substream:
35 3bc4778787c5 Simplify template processing model by removing dynamically generated `SUB` events. cmlenz parents: 31 diff changeset	936 yield event
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	937 except TypeError:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	938 # Neither a string nor an iterable, so just pass it
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	939 # through
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	940 yield TEXT, unicode(result), pos
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	941
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	942 else:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	943 yield kind, data, pos
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	944
23 00835401c8cc Separate match and eval filters from the include and user-supplied filters. cmlenz parents: 22 diff changeset	945 def _flatten(self, stream, ctxt=None):
29 4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	946 """Internal stream filter that expands `SUB` events in the stream."""
81 cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	947 for kind, data, pos in stream:
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	948 if kind is SUB:
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	949 # This event is a list of directives and a list of nested
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	950 # events to which those directives should be applied
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	951 directives, substream = data
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	952 substream = _apply_directives(substream, ctxt, directives)
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	953 for filter_ in (self._eval, self._match, self._flatten):
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	954 substream = filter_(substream, ctxt)
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	955 for event in substream:
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	956 yield event
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	957 else:
cc034182061e Template expressions are now compiled to Python bytecode. cmlenz parents: 80 diff changeset	958 yield kind, data, pos
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	959
36 57d607f25484 Fix for #7: match templates no longer process their own output. cmlenz parents: 35 diff changeset	960 def _match(self, stream, ctxt=None, match_templates=None):
29 4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	961 """Internal stream filter that applies any defined match templates
4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	962 to the stream.
4b6cee37ce62 * Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using cmlenz parents: 27 diff changeset	963 """
36 57d607f25484 Fix for #7: match templates no longer process their own output. cmlenz parents: 35 diff changeset	964 if match_templates is None:
57d607f25484 Fix for #7: match templates no longer process their own output. cmlenz parents: 35 diff changeset	965 match_templates = ctxt._match_templates
57d607f25484 Fix for #7: match templates no longer process their own output. cmlenz parents: 35 diff changeset	966
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	967 for kind, data, pos in stream:
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	968
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	969 # We (currently) only care about start and end events for matching
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	970 # We might care about namespace events in the future, though
92 3b75c6730b29 More performance improvements... this time for whitespace normalization and template loops. cmlenz parents: 90 diff changeset	971 if not match_templates or kind not in (START, END):
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	972 yield kind, data, pos
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	973 continue
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	974
50 a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	975 for idx, (test, path, template, directives) in \
a053ffb834cb Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives. cmlenz parents: 48 diff changeset	976 enumerate(match_templates):
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	977
116 88ac4c680120 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 111 diff changeset	978 if test(kind, data, pos) is True:
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	979 # Consume and store all events until an end event
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	980 # corresponding to this start event is encountered
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	981 content = [(kind, data, pos)]
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	982 depth = 1
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	983 while depth > 0:
73 b0fd16111f2e Some more performance tweaks. cmlenz parents: 71 diff changeset	984 kind, data, pos = stream.next()
b0fd16111f2e Some more performance tweaks. cmlenz parents: 71 diff changeset	985 if kind is START:
b0fd16111f2e Some more performance tweaks. cmlenz parents: 71 diff changeset	986 depth += 1
b0fd16111f2e Some more performance tweaks. cmlenz parents: 71 diff changeset	987 elif kind is END:
b0fd16111f2e Some more performance tweaks. cmlenz parents: 71 diff changeset	988 depth -= 1
b0fd16111f2e Some more performance tweaks. cmlenz parents: 71 diff changeset	989 content.append((kind, data, pos))
b0fd16111f2e Some more performance tweaks. cmlenz parents: 71 diff changeset	990 test(kind, data, pos)
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	991
23 00835401c8cc Separate match and eval filters from the include and user-supplied filters. cmlenz parents: 22 diff changeset	992 content = list(self._flatten(content, ctxt))
95 7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	993 select = lambda path: Stream(content).select(path)
7d6426183a90 Improve performance of push/pop operations on the context. cmlenz parents: 93 diff changeset	994 ctxt.push(dict(select=select))
36 57d607f25484 Fix for #7: match templates no longer process their own output. cmlenz parents: 35 diff changeset	995
78 fa4bafcbe4c7 Minor improvements to how directives are applied in template processing. cmlenz parents: 77 diff changeset	996 template = _apply_directives(template, ctxt, directives)
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	997 for event in self._match(self._eval(template, ctxt),
e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	998 ctxt, match_templates[:idx] +
e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	999 match_templates[idx + 1:]):
35 3bc4778787c5 Simplify template processing model by removing dynamically generated `SUB` events. cmlenz parents: 31 diff changeset	1000 yield event
116 88ac4c680120 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 111 diff changeset	1001
35 3bc4778787c5 Simplify template processing model by removing dynamically generated `SUB` events. cmlenz parents: 31 diff changeset	1002 ctxt.pop()
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	1003 break
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	1004
e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	1005 else: # no matches
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	1006 yield kind, data, pos
ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	1007
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1008
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	1009 EXPR = Template.EXPR
e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	1010 SUB = Template.SUB
e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	1011
e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	1012
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1013 class TemplateLoader(object):
821114ec4f69 Initial import. cmlenz parents: diff changeset	1014 """Responsible for loading templates from files on the specified search
821114ec4f69 Initial import. cmlenz parents: diff changeset	1015 path.
821114ec4f69 Initial import. cmlenz parents: diff changeset	1016
821114ec4f69 Initial import. cmlenz parents: diff changeset	1017 >>> import tempfile
821114ec4f69 Initial import. cmlenz parents: diff changeset	1018 >>> fd, path = tempfile.mkstemp(suffix='.html', prefix='template')
821114ec4f69 Initial import. cmlenz parents: diff changeset	1019 >>> os.write(fd, '<p>$var</p>')
821114ec4f69 Initial import. cmlenz parents: diff changeset	1020 11
821114ec4f69 Initial import. cmlenz parents: diff changeset	1021 >>> os.close(fd)
821114ec4f69 Initial import. cmlenz parents: diff changeset	1022
821114ec4f69 Initial import. cmlenz parents: diff changeset	1023 The template loader accepts a list of directory paths that are then used
821114ec4f69 Initial import. cmlenz parents: diff changeset	1024 when searching for template files, in the given order:
821114ec4f69 Initial import. cmlenz parents: diff changeset	1025
821114ec4f69 Initial import. cmlenz parents: diff changeset	1026 >>> loader = TemplateLoader([os.path.dirname(path)])
821114ec4f69 Initial import. cmlenz parents: diff changeset	1027
821114ec4f69 Initial import. cmlenz parents: diff changeset	1028 The `load()` method first checks the template cache whether the requested
821114ec4f69 Initial import. cmlenz parents: diff changeset	1029 template has already been loaded. If not, it attempts to locate the
821114ec4f69 Initial import. cmlenz parents: diff changeset	1030 template file, and returns the corresponding `Template` object:
821114ec4f69 Initial import. cmlenz parents: diff changeset	1031
821114ec4f69 Initial import. cmlenz parents: diff changeset	1032 >>> template = loader.load(os.path.basename(path))
821114ec4f69 Initial import. cmlenz parents: diff changeset	1033 >>> isinstance(template, Template)
821114ec4f69 Initial import. cmlenz parents: diff changeset	1034 True
821114ec4f69 Initial import. cmlenz parents: diff changeset	1035
821114ec4f69 Initial import. cmlenz parents: diff changeset	1036 Template instances are cached: requesting a template with the same name
821114ec4f69 Initial import. cmlenz parents: diff changeset	1037 results in the same instance being returned:
821114ec4f69 Initial import. cmlenz parents: diff changeset	1038
821114ec4f69 Initial import. cmlenz parents: diff changeset	1039 >>> loader.load(os.path.basename(path)) is template
821114ec4f69 Initial import. cmlenz parents: diff changeset	1040 True
152 064ba1078f92 Add some tests for relative template includes (see #27). cmlenz parents: 150 diff changeset	1041
064ba1078f92 Add some tests for relative template includes (see #27). cmlenz parents: 150 diff changeset	1042 >>> os.remove(path)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1043 """
821114ec4f69 Initial import. cmlenz parents: diff changeset	1044 def __init__(self, search_path=None, auto_reload=False):
821114ec4f69 Initial import. cmlenz parents: diff changeset	1045 """Create the template laoder.
821114ec4f69 Initial import. cmlenz parents: diff changeset	1046
821114ec4f69 Initial import. cmlenz parents: diff changeset	1047 @param search_path: a list of absolute path names that should be
821114ec4f69 Initial import. cmlenz parents: diff changeset	1048 searched for template files
821114ec4f69 Initial import. cmlenz parents: diff changeset	1049 @param auto_reload: whether to check the last modification time of
821114ec4f69 Initial import. cmlenz parents: diff changeset	1050 template files, and reload them if they have changed
821114ec4f69 Initial import. cmlenz parents: diff changeset	1051 """
821114ec4f69 Initial import. cmlenz parents: diff changeset	1052 self.search_path = search_path
821114ec4f69 Initial import. cmlenz parents: diff changeset	1053 if self.search_path is None:
821114ec4f69 Initial import. cmlenz parents: diff changeset	1054 self.search_path = []
821114ec4f69 Initial import. cmlenz parents: diff changeset	1055 self.auto_reload = auto_reload
821114ec4f69 Initial import. cmlenz parents: diff changeset	1056 self._cache = {}
821114ec4f69 Initial import. cmlenz parents: diff changeset	1057 self._mtime = {}
821114ec4f69 Initial import. cmlenz parents: diff changeset	1058
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1059 def load(self, filename, relative_to=None):
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1060 """Load the template with the given name.
821114ec4f69 Initial import. cmlenz parents: diff changeset	1061
22 31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1062 If the `filename` parameter is relative, this method searches the search
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1063 path trying to locate a template matching the given name. If the file
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1064 name is an absolute path, the search path is not bypassed.
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1065
22 31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1066 If requested template is not found, a `TemplateNotFound` exception is
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1067 raised. Otherwise, a `Template` object is returned that represents the
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1068 parsed template.
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1069
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1070 Template instances are cached to avoid having to parse the same
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1071 template file more than once. Thus, subsequent calls of this method
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1072 with the same template file name will return the same `Template`
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1073 object (unless the `auto_reload` option is enabled and the file was
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1074 changed since the last parse.)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1075
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1076 If the `relative_to` parameter is provided, the `filename` is
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1077 interpreted as being relative to that path.
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1078
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1079 @param filename: the relative path of the template file to load
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1080 @param relative_to: the filename of the template from which the new
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1081 template is being loaded, or `None` if the template is being loaded
eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1082 directly
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1083 """
69 e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	1084 from markup.filters import IncludeFilter
e9a3930f8823 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	1085
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1086 if relative_to:
153 7a4086c22a64 Fix relative includes on Windows. Closes #27. cmlenz parents: 152 diff changeset	1087 filename = os.path.join(os.path.dirname(relative_to), filename)
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1088 filename = os.path.normpath(filename)
22 31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1089
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1090 # First check the cache to avoid reparsing the same file
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1091 try:
821114ec4f69 Initial import. cmlenz parents: diff changeset	1092 tmpl = self._cache[filename]
821114ec4f69 Initial import. cmlenz parents: diff changeset	1093 if not self.auto_reload or \
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1094 os.path.getmtime(tmpl.filepath) == self._mtime[filename]:
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1095 return tmpl
821114ec4f69 Initial import. cmlenz parents: diff changeset	1096 except KeyError:
821114ec4f69 Initial import. cmlenz parents: diff changeset	1097 pass
22 31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1098
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1099 # Bypass the search path if the filename is absolute
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1100 search_path = self.search_path
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1101 if os.path.isabs(filename):
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1102 search_path = [os.path.dirname(filename)]
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1103
31b13ddf9f53 Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute. cmlenz parents: 21 diff changeset	1104 for dirname in search_path:
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1105 filepath = os.path.join(dirname, filename)
821114ec4f69 Initial import. cmlenz parents: diff changeset	1106 try:
133 b9a0031d4bbb Minor cleanup and performance improvement for the builder module. cmlenz parents: 120 diff changeset	1107 fileobj = open(filepath, 'U')
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1108 try:
21 eca77129518a * Include paths are now interpreted relative to the path of the including template. Closes #3. cmlenz parents: 18 diff changeset	1109 tmpl = Template(fileobj, basedir=dirname, filename=filename)
17 ad63ad459524 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 14 diff changeset	1110 tmpl.filters.append(IncludeFilter(self))
1 821114ec4f69 Initial import. cmlenz parents: diff changeset	1111 finally:
821114ec4f69 Initial import. cmlenz parents: diff changeset	1112 fileobj.close()
821114ec4f69 Initial import. cmlenz parents: diff changeset	1113 self._cache[filename] = tmpl
821114ec4f69 Initial import. cmlenz parents: diff changeset	1114 self._mtime[filename] = os.path.getmtime(filepath)
821114ec4f69 Initial import. cmlenz parents: diff changeset	1115 return tmpl
821114ec4f69 Initial import. cmlenz parents: diff changeset	1116 except IOError:
821114ec4f69 Initial import. cmlenz parents: diff changeset	1117 continue
821114ec4f69 Initial import. cmlenz parents: diff changeset	1118 raise TemplateNotFound(filename, self.search_path)

Mercurial > genshi > genshi-test

annotate markup/template.py @ 173:ae5d2f4a378a