genshi/mirror: markup/template.py annotate

annotate markup/template.py @ 202:92353f28ae54 trunk

Remove the (hopefully) last instance where directives store state in instance variables, allowing templates to be cached and reused in a threadsafe manner. Closes #39. Many thanks to Christian Boos for the patch!

author	cmlenz
date	Fri, 25 Aug 2006 12:43:01 +0000
parents	71ce4b5335ba
children	b700e5326421

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

Mercurial > genshi > mirror

annotate markup/template.py @ 202:92353f28ae54 trunk