py_tasks_melange: app/django/template/__init_

54 03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	1	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	2	This is the Django template system.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	3
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	4	How it works:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	5
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	6	The Lexer.tokenize() function converts a template string (i.e., a string containing
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	7	markup with custom template tags) to tokens, which can be either plain text
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	8	(TOKEN_TEXT), variables (TOKEN_VAR) or block statements (TOKEN_BLOCK).
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	9
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	10	The Parser() class takes a list of tokens in its constructor, and its parse()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	11	method returns a compiled template -- which is, under the hood, a list of
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	12	Node objects.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	13
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	14	Each Node is responsible for creating some sort of output -- e.g. simple text
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	15	(TextNode), variable values in a given context (VariableNode), results of basic
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	16	logic (IfNode), results of looping (ForNode), or anything else. The core Node
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	17	types are TextNode, VariableNode, IfNode and ForNode, but plugin modules can
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	18	define their own custom node types.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	19
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	20	Each Node has a render() method, which takes a Context and returns a string of
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	21	the rendered node. For example, the render() method of a Variable Node returns
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	22	the variable's value as a string. The render() method of an IfNode returns the
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	23	rendered output of whatever was inside the loop, recursively.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	24
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	25	The Template class is a convenient wrapper that takes care of template
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	26	compilation and rendering.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	27
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	28	Usage:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	29
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	30	The only thing you should ever use directly in this file is the Template class.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	31	Create a compiled template object with a template_string, then call render()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	32	with a context. In the compilation stage, the TemplateSyntaxError exception
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	33	will be raised if the template doesn't have proper syntax.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	34
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	35	Sample code:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	36
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	37	>>> from django import template
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	38	>>> s = u'<html>{% if test %}<h1>{{ varvalue }}</h1>{% endif %}</html>'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	39	>>> t = template.Template(s)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	40
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	41	(t is now a compiled template, and its render() method can be called multiple
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	42	times with multiple contexts)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	43
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	44	>>> c = template.Context({'test':True, 'varvalue': 'Hello'})
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	45	>>> t.render(c)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	46	u'<html><h1>Hello</h1></html>'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	47	>>> c = template.Context({'test':False, 'varvalue': 'Hello'})
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	48	>>> t.render(c)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	49	u'<html></html>'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	50	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	51	import re
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	52	from inspect import getargspec
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	53	from django.conf import settings
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	54	from django.template.context import Context, RequestContext, ContextPopException
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	55	from django.utils.itercompat import is_iterable
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	56	from django.utils.functional import curry, Promise
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	57	from django.utils.text import smart_split
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	58	from django.utils.encoding import smart_unicode, force_unicode
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	59	from django.utils.translation import ugettext as _
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	60	from django.utils.safestring import SafeData, EscapeData, mark_safe, mark_for_escaping
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	61	from django.utils.html import escape
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	62
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	63	__all__ = ('Template', 'Context', 'RequestContext', 'compile_string')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	64
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	65	TOKEN_TEXT = 0
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	66	TOKEN_VAR = 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	67	TOKEN_BLOCK = 2
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	68	TOKEN_COMMENT = 3
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	69
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	70	# template syntax constants
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	71	FILTER_SEPARATOR = '\|'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	72	FILTER_ARGUMENT_SEPARATOR = ':'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	73	VARIABLE_ATTRIBUTE_SEPARATOR = '.'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	74	BLOCK_TAG_START = '{%'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	75	BLOCK_TAG_END = '%}'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	76	VARIABLE_TAG_START = '{{'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	77	VARIABLE_TAG_END = '}}'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	78	COMMENT_TAG_START = '{#'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	79	COMMENT_TAG_END = '#}'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	80	SINGLE_BRACE_START = '{'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	81	SINGLE_BRACE_END = '}'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	82
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	83	ALLOWED_VARIABLE_CHARS = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	84
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	85	# what to report as the origin for templates that come from non-loader sources
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	86	# (e.g. strings)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	87	UNKNOWN_SOURCE="<unknown source>"
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	88
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	89	# match a variable or block tag and capture the entire tag, including start/end delimiters
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	90	tag_re = re.compile('(%s.?%s\|%s.?%s\|%s.*?%s)' % (re.escape(BLOCK_TAG_START), re.escape(BLOCK_TAG_END),
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	91	re.escape(VARIABLE_TAG_START), re.escape(VARIABLE_TAG_END),
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	92	re.escape(COMMENT_TAG_START), re.escape(COMMENT_TAG_END)))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	93
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	94	# global dictionary of libraries that have been loaded using get_library
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	95	libraries = {}
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	96	# global list of libraries to load by default for a new parser
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	97	builtins = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	98
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	99	# True if TEMPLATE_STRING_IF_INVALID contains a format string (%s). None means
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	100	# uninitialised.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	101	invalid_var_format_string = None
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	102
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	103	class TemplateSyntaxError(Exception):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	104	def __str__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	105	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	106	import cStringIO as StringIO
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	107	except ImportError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	108	import StringIO
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	109	output = StringIO.StringIO()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	110	output.write(Exception.__str__(self))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	111	# Check if we wrapped an exception and print that too.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	112	if hasattr(self, 'exc_info'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	113	import traceback
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	114	output.write('\n\nOriginal ')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	115	e = self.exc_info
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	116	traceback.print_exception(e[0], e[1], e[2], 500, output)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	117	return output.getvalue()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	118
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	119	class TemplateDoesNotExist(Exception):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	120	pass
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	121
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	122	class TemplateEncodingError(Exception):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	123	pass
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	124
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	125	class VariableDoesNotExist(Exception):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	126
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	127	def __init__(self, msg, params=()):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	128	self.msg = msg
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	129	self.params = params
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	130
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	131	def __str__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	132	return unicode(self).encode('utf-8')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	133
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	134	def __unicode__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	135	return self.msg % tuple([force_unicode(p, errors='replace') for p in self.params])
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	136
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	137	class InvalidTemplateLibrary(Exception):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	138	pass
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	139
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	140	class Origin(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	141	def __init__(self, name):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	142	self.name = name
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	143
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	144	def reload(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	145	raise NotImplementedError
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	146
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	147	def __str__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	148	return self.name
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	149
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	150	class StringOrigin(Origin):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	151	def __init__(self, source):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	152	super(StringOrigin, self).__init__(UNKNOWN_SOURCE)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	153	self.source = source
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	154
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	155	def reload(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	156	return self.source
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	157
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	158	class Template(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	159	def __init__(self, template_string, origin=None, name='<Unknown Template>'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	160	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	161	template_string = smart_unicode(template_string)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	162	except UnicodeDecodeError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	163	raise TemplateEncodingError("Templates can only be constructed from unicode or UTF-8 strings.")
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	164	if settings.TEMPLATE_DEBUG and origin is None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	165	origin = StringOrigin(template_string)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	166	self.nodelist = compile_string(template_string, origin)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	167	self.name = name
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	168
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	169	def __iter__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	170	for node in self.nodelist:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	171	for subnode in node:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	172	yield subnode
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	173
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	174	def render(self, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	175	"Display stage -- can be called many times"
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	176	return self.nodelist.render(context)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	177
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	178	def compile_string(template_string, origin):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	179	"Compiles template_string into NodeList ready for rendering"
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	180	if settings.TEMPLATE_DEBUG:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	181	from debug import DebugLexer, DebugParser
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	182	lexer_class, parser_class = DebugLexer, DebugParser
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	183	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	184	lexer_class, parser_class = Lexer, Parser
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	185	lexer = lexer_class(template_string, origin)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	186	parser = parser_class(lexer.tokenize())
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	187	return parser.parse()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	188
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	189	class Token(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	190	def __init__(self, token_type, contents):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	191	# token_type must be TOKEN_TEXT, TOKEN_VAR, TOKEN_BLOCK or TOKEN_COMMENT.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	192	self.token_type, self.contents = token_type, contents
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	193
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	194	def __str__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	195	return '<%s token: "%s...">' % \
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	196	({TOKEN_TEXT: 'Text', TOKEN_VAR: 'Var', TOKEN_BLOCK: 'Block', TOKEN_COMMENT: 'Comment'}[self.token_type],
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	197	self.contents[:20].replace('\n', ''))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	198
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	199	def split_contents(self):
323 ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	200	split = []
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	201	bits = iter(smart_split(self.contents))
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	202	for bit in bits:
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	203	# Handle translation-marked template pieces
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	204	if bit.startswith('_("') or bit.startswith("_('"):
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	205	sentinal = bit[2] + ')'
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	206	trans_bit = [bit]
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	207	while not bit.endswith(sentinal):
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	208	bit = bits.next()
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	209	trans_bit.append(bit)
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	210	bit = ' '.join(trans_bit)
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	211	split.append(bit)
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	212	return split
54 03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	213
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	214	class Lexer(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	215	def __init__(self, template_string, origin):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	216	self.template_string = template_string
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	217	self.origin = origin
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	218
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	219	def tokenize(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	220	"Return a list of tokens from a given template_string."
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	221	in_tag = False
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	222	result = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	223	for bit in tag_re.split(self.template_string):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	224	if bit:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	225	result.append(self.create_token(bit, in_tag))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	226	in_tag = not in_tag
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	227	return result
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	228
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	229	def create_token(self, token_string, in_tag):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	230	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	231	Convert the given token string into a new Token object and return it.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	232	If in_tag is True, we are processing something that matched a tag,
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	233	otherwise it should be treated as a literal string.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	234	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	235	if in_tag:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	236	if token_string.startswith(VARIABLE_TAG_START):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	237	token = Token(TOKEN_VAR, token_string[len(VARIABLE_TAG_START):-len(VARIABLE_TAG_END)].strip())
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	238	elif token_string.startswith(BLOCK_TAG_START):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	239	token = Token(TOKEN_BLOCK, token_string[len(BLOCK_TAG_START):-len(BLOCK_TAG_END)].strip())
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	240	elif token_string.startswith(COMMENT_TAG_START):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	241	token = Token(TOKEN_COMMENT, '')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	242	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	243	token = Token(TOKEN_TEXT, token_string)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	244	return token
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	245
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	246	class Parser(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	247	def __init__(self, tokens):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	248	self.tokens = tokens
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	249	self.tags = {}
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	250	self.filters = {}
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	251	for lib in builtins:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	252	self.add_library(lib)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	253
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	254	def parse(self, parse_until=None):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	255	if parse_until is None: parse_until = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	256	nodelist = self.create_nodelist()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	257	while self.tokens:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	258	token = self.next_token()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	259	if token.token_type == TOKEN_TEXT:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	260	self.extend_nodelist(nodelist, TextNode(token.contents), token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	261	elif token.token_type == TOKEN_VAR:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	262	if not token.contents:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	263	self.empty_variable(token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	264	filter_expression = self.compile_filter(token.contents)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	265	var_node = self.create_variable_node(filter_expression)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	266	self.extend_nodelist(nodelist, var_node,token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	267	elif token.token_type == TOKEN_BLOCK:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	268	if token.contents in parse_until:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	269	# put token back on token list so calling code knows why it terminated
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	270	self.prepend_token(token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	271	return nodelist
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	272	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	273	command = token.contents.split()[0]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	274	except IndexError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	275	self.empty_block_tag(token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	276	# execute callback function for this tag and append resulting node
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	277	self.enter_command(command, token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	278	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	279	compile_func = self.tags[command]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	280	except KeyError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	281	self.invalid_block_tag(token, command)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	282	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	283	compiled_result = compile_func(self, token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	284	except TemplateSyntaxError, e:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	285	if not self.compile_function_error(token, e):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	286	raise
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	287	self.extend_nodelist(nodelist, compiled_result, token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	288	self.exit_command()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	289	if parse_until:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	290	self.unclosed_block_tag(parse_until)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	291	return nodelist
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	292
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	293	def skip_past(self, endtag):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	294	while self.tokens:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	295	token = self.next_token()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	296	if token.token_type == TOKEN_BLOCK and token.contents == endtag:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	297	return
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	298	self.unclosed_block_tag([endtag])
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	299
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	300	def create_variable_node(self, filter_expression):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	301	return VariableNode(filter_expression)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	302
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	303	def create_nodelist(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	304	return NodeList()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	305
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	306	def extend_nodelist(self, nodelist, node, token):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	307	if node.must_be_first and nodelist:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	308	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	309	if nodelist.contains_nontext:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	310	raise AttributeError
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	311	except AttributeError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	312	raise TemplateSyntaxError("%r must be the first tag in the template." % node)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	313	if isinstance(nodelist, NodeList) and not isinstance(node, TextNode):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	314	nodelist.contains_nontext = True
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	315	nodelist.append(node)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	316
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	317	def enter_command(self, command, token):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	318	pass
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	319
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	320	def exit_command(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	321	pass
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	322
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	323	def error(self, token, msg):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	324	return TemplateSyntaxError(msg)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	325
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	326	def empty_variable(self, token):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	327	raise self.error(token, "Empty variable tag")
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	328
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	329	def empty_block_tag(self, token):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	330	raise self.error(token, "Empty block tag")
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	331
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	332	def invalid_block_tag(self, token, command):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	333	raise self.error(token, "Invalid block tag: '%s'" % command)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	334
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	335	def unclosed_block_tag(self, parse_until):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	336	raise self.error(None, "Unclosed tags: %s " % ', '.join(parse_until))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	337
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	338	def compile_function_error(self, token, e):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	339	pass
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	340
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	341	def next_token(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	342	return self.tokens.pop(0)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	343
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	344	def prepend_token(self, token):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	345	self.tokens.insert(0, token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	346
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	347	def delete_first_token(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	348	del self.tokens[0]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	349
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	350	def add_library(self, lib):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	351	self.tags.update(lib.tags)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	352	self.filters.update(lib.filters)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	353
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	354	def compile_filter(self, token):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	355	"Convenient wrapper for FilterExpression"
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	356	return FilterExpression(token, self)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	357
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	358	def find_filter(self, filter_name):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	359	if filter_name in self.filters:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	360	return self.filters[filter_name]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	361	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	362	raise TemplateSyntaxError("Invalid filter: '%s'" % filter_name)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	363
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	364	class TokenParser(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	365	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	366	Subclass this and implement the top() method to parse a template line. When
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	367	instantiating the parser, pass in the line from the Django template parser.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	368
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	369	The parser's "tagname" instance-variable stores the name of the tag that
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	370	the filter was called with.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	371	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	372	def __init__(self, subject):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	373	self.subject = subject
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	374	self.pointer = 0
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	375	self.backout = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	376	self.tagname = self.tag()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	377
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	378	def top(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	379	"Overload this method to do the actual parsing and return the result."
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	380	raise NotImplementedError()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	381
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	382	def more(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	383	"Returns True if there is more stuff in the tag."
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	384	return self.pointer < len(self.subject)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	385
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	386	def back(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	387	"Undoes the last microparser. Use this for lookahead and backtracking."
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	388	if not len(self.backout):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	389	raise TemplateSyntaxError("back called without some previous parsing")
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	390	self.pointer = self.backout.pop()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	391
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	392	def tag(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	393	"A microparser that just returns the next tag from the line."
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	394	subject = self.subject
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	395	i = self.pointer
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	396	if i >= len(subject):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	397	raise TemplateSyntaxError("expected another tag, found end of string: %s" % subject)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	398	p = i
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	399	while i < len(subject) and subject[i] not in (' ', '\t'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	400	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	401	s = subject[p:i]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	402	while i < len(subject) and subject[i] in (' ', '\t'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	403	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	404	self.backout.append(self.pointer)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	405	self.pointer = i
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	406	return s
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	407
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	408	def value(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	409	"A microparser that parses for a value: some string constant or variable name."
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	410	subject = self.subject
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	411	i = self.pointer
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	412	if i >= len(subject):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	413	raise TemplateSyntaxError("Searching for value. Expected another value but found end of string: %s" % subject)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	414	if subject[i] in ('"', "'"):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	415	p = i
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	416	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	417	while i < len(subject) and subject[i] != subject[p]:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	418	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	419	if i >= len(subject):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	420	raise TemplateSyntaxError("Searching for value. Unexpected end of string in column %d: %s" % (i, subject))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	421	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	422	res = subject[p:i]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	423	while i < len(subject) and subject[i] in (' ', '\t'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	424	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	425	self.backout.append(self.pointer)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	426	self.pointer = i
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	427	return res
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	428	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	429	p = i
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	430	while i < len(subject) and subject[i] not in (' ', '\t'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	431	if subject[i] in ('"', "'"):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	432	c = subject[i]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	433	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	434	while i < len(subject) and subject[i] != c:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	435	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	436	if i >= len(subject):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	437	raise TemplateSyntaxError("Searching for value. Unexpected end of string in column %d: %s" % (i, subject))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	438	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	439	s = subject[p:i]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	440	while i < len(subject) and subject[i] in (' ', '\t'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	441	i += 1
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	442	self.backout.append(self.pointer)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	443	self.pointer = i
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	444	return s
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	445
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	446	filter_raw_string = r"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	447	^%(i18n_open)s"(?P<i18n_constant>%(str)s)"%(i18n_close)s\|
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	448	^"(?P<constant>%(str)s)"\|
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	449	^(?P<var>[%(var_chars)s]+)\|
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	450	(?:%(filter_sep)s
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	451	(?P<filter_name>\w+)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	452	(?:%(arg_sep)s
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	453	(?:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	454	%(i18n_open)s"(?P<i18n_arg>%(str)s)"%(i18n_close)s\|
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	455	"(?P<constant_arg>%(str)s)"\|
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	456	(?P<var_arg>[%(var_chars)s]+)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	457	)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	458	)?
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	459	)""" % {
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	460	'str': r"""[^"\\](?:\\.[^"\\])*""",
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	461	'var_chars': "\w\." ,
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	462	'filter_sep': re.escape(FILTER_SEPARATOR),
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	463	'arg_sep': re.escape(FILTER_ARGUMENT_SEPARATOR),
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	464	'i18n_open' : re.escape("_("),
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	465	'i18n_close' : re.escape(")"),
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	466	}
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	467
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	468	filter_raw_string = filter_raw_string.replace("\n", "").replace(" ", "")
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	469	filter_re = re.compile(filter_raw_string, re.UNICODE)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	470
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	471	class FilterExpression(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	472	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	473	Parses a variable token and its optional filters (all as a single string),
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	474	and return a list of tuples of the filter name and arguments.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	475	Sample:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	476	>>> token = 'variable\|default:"Default value"\|date:"Y-m-d"'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	477	>>> p = Parser('')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	478	>>> fe = FilterExpression(token, p)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	479	>>> len(fe.filters)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	480	2
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	481	>>> fe.var
323 ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	482	<Variable: 'variable'>
54 03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	483
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	484	This class should never be instantiated outside of the
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	485	get_filters_from_token helper function.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	486	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	487	def __init__(self, token, parser):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	488	self.token = token
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	489	matches = filter_re.finditer(token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	490	var = None
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	491	filters = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	492	upto = 0
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	493	for match in matches:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	494	start = match.start()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	495	if upto != start:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	496	raise TemplateSyntaxError("Could not parse some characters: %s\|%s\|%s" % \
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	497	(token[:upto], token[upto:start], token[start:]))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	498	if var == None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	499	var, constant, i18n_constant = match.group("var", "constant", "i18n_constant")
323 ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	500	if i18n_constant is not None:
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	501	# Don't pass the empty string to gettext, because the empty
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	502	# string translates to meta information.
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	503	if i18n_constant == "":
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	504	var = '""'
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	505	else:
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	506	var = '"%s"' % _(i18n_constant.replace(r'\"', '"'))
ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	507	elif constant is not None:
54 03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	508	var = '"%s"' % constant.replace(r'\"', '"')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	509	upto = match.end()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	510	if var == None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	511	raise TemplateSyntaxError("Could not find variable at start of %s" % token)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	512	elif var.find(VARIABLE_ATTRIBUTE_SEPARATOR + '_') > -1 or var[0] == '_':
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	513	raise TemplateSyntaxError("Variables and attributes may not begin with underscores: '%s'" % var)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	514	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	515	filter_name = match.group("filter_name")
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	516	args = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	517	constant_arg, i18n_arg, var_arg = match.group("constant_arg", "i18n_arg", "var_arg")
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	518	if i18n_arg:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	519	args.append((False, _(i18n_arg.replace(r'\"', '"'))))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	520	elif constant_arg is not None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	521	args.append((False, constant_arg.replace(r'\"', '"')))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	522	elif var_arg:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	523	args.append((True, Variable(var_arg)))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	524	filter_func = parser.find_filter(filter_name)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	525	self.args_check(filter_name,filter_func, args)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	526	filters.append( (filter_func,args))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	527	upto = match.end()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	528	if upto != len(token):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	529	raise TemplateSyntaxError("Could not parse the remainder: '%s' from '%s'" % (token[upto:], token))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	530	self.filters = filters
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	531	self.var = Variable(var)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	532
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	533	def resolve(self, context, ignore_failures=False):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	534	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	535	obj = self.var.resolve(context)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	536	except VariableDoesNotExist:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	537	if ignore_failures:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	538	obj = None
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	539	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	540	if settings.TEMPLATE_STRING_IF_INVALID:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	541	global invalid_var_format_string
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	542	if invalid_var_format_string is None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	543	invalid_var_format_string = '%s' in settings.TEMPLATE_STRING_IF_INVALID
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	544	if invalid_var_format_string:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	545	return settings.TEMPLATE_STRING_IF_INVALID % self.var
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	546	return settings.TEMPLATE_STRING_IF_INVALID
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	547	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	548	obj = settings.TEMPLATE_STRING_IF_INVALID
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	549	for func, args in self.filters:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	550	arg_vals = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	551	for lookup, arg in args:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	552	if not lookup:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	553	arg_vals.append(mark_safe(arg))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	554	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	555	arg_vals.append(arg.resolve(context))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	556	if getattr(func, 'needs_autoescape', False):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	557	new_obj = func(obj, autoescape=context.autoescape, *arg_vals)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	558	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	559	new_obj = func(obj, *arg_vals)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	560	if getattr(func, 'is_safe', False) and isinstance(obj, SafeData):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	561	obj = mark_safe(new_obj)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	562	elif isinstance(obj, EscapeData):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	563	obj = mark_for_escaping(new_obj)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	564	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	565	obj = new_obj
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	566	return obj
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	567
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	568	def args_check(name, func, provided):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	569	provided = list(provided)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	570	plen = len(provided)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	571	# Check to see if a decorator is providing the real function.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	572	func = getattr(func, '_decorated_function', func)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	573	args, varargs, varkw, defaults = getargspec(func)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	574	# First argument is filter input.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	575	args.pop(0)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	576	if defaults:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	577	nondefs = args[:-len(defaults)]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	578	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	579	nondefs = args
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	580	# Args without defaults must be provided.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	581	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	582	for arg in nondefs:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	583	provided.pop(0)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	584	except IndexError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	585	# Not enough
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	586	raise TemplateSyntaxError("%s requires %d arguments, %d provided" % (name, len(nondefs), plen))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	587
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	588	# Defaults can be overridden.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	589	defaults = defaults and list(defaults) or []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	590	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	591	for parg in provided:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	592	defaults.pop(0)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	593	except IndexError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	594	# Too many.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	595	raise TemplateSyntaxError("%s requires %d arguments, %d provided" % (name, len(nondefs), plen))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	596
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	597	return True
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	598	args_check = staticmethod(args_check)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	599
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	600	def __str__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	601	return self.token
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	602
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	603	def resolve_variable(path, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	604	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	605	Returns the resolved variable, which may contain attribute syntax, within
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	606	the given context.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	607
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	608	Deprecated; use the Variable class instead.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	609	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	610	return Variable(path).resolve(context)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	611
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	612	class Variable(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	613	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	614	A template variable, resolvable against a given context. The variable may be
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	615	a hard-coded string (if it begins and ends with single or double quote
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	616	marks)::
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	617
323 ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	618	>>> c = {'article': {'section':u'News'}}
54 03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	619	>>> Variable('article.section').resolve(c)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	620	u'News'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	621	>>> Variable('article').resolve(c)
323 ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	622	{'section': u'News'}
54 03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	623	>>> class AClass: pass
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	624	>>> c = AClass()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	625	>>> c.article = AClass()
323 ff1a9aa48cfd Load ../vendor/django into trunk/app/django. Pawel Solyga <Pawel.Solyga@gmail.com> parents: 54 diff changeset	626	>>> c.article.section = u'News'
54 03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	627	>>> Variable('article.section').resolve(c)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	628	u'News'
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	629
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	630	(The example assumes VARIABLE_ATTRIBUTE_SEPARATOR is '.')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	631	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	632
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	633	def __init__(self, var):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	634	self.var = var
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	635	self.literal = None
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	636	self.lookups = None
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	637	self.translate = False
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	638
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	639	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	640	# First try to treat this variable as a number.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	641	#
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	642	# Note that this could cause an OverflowError here that we're not
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	643	# catching. Since this should only happen at compile time, that's
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	644	# probably OK.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	645	self.literal = float(var)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	646
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	647	# So it's a float... is it an int? If the original value contained a
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	648	# dot or an "e" then it was a float, not an int.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	649	if '.' not in var and 'e' not in var.lower():
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	650	self.literal = int(self.literal)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	651
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	652	# "2." is invalid
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	653	if var.endswith('.'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	654	raise ValueError
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	655
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	656	except ValueError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	657	# A ValueError means that the variable isn't a number.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	658	if var.startswith('_(') and var.endswith(')'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	659	# The result of the lookup should be translated at rendering
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	660	# time.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	661	self.translate = True
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	662	var = var[2:-1]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	663	# If it's wrapped with quotes (single or double), then
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	664	# we're also dealing with a literal.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	665	if var[0] in "\"'" and var[0] == var[-1]:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	666	self.literal = mark_safe(var[1:-1])
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	667	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	668	# Otherwise we'll set self.lookups so that resolve() knows we're
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	669	# dealing with a bonafide variable
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	670	self.lookups = tuple(var.split(VARIABLE_ATTRIBUTE_SEPARATOR))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	671
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	672	def resolve(self, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	673	"""Resolve this variable against a given context."""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	674	if self.lookups is not None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	675	# We're dealing with a variable that needs to be resolved
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	676	value = self._resolve_lookup(context)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	677	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	678	# We're dealing with a literal, so it's already been "resolved"
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	679	value = self.literal
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	680	if self.translate:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	681	return _(value)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	682	return value
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	683
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	684	def __repr__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	685	return "<%s: %r>" % (self.__class__.__name__, self.var)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	686
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	687	def __str__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	688	return self.var
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	689
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	690	def _resolve_lookup(self, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	691	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	692	Performs resolution of a real variable (i.e. not a literal) against the
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	693	given context.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	694
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	695	As indicated by the method's name, this method is an implementation
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	696	detail and shouldn't be called by external code. Use Variable.resolve()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	697	instead.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	698	"""
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	699	current = context
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	700	for bit in self.lookups:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	701	try: # dictionary lookup
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	702	current = current[bit]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	703	except (TypeError, AttributeError, KeyError):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	704	try: # attribute lookup
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	705	current = getattr(current, bit)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	706	if callable(current):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	707	if getattr(current, 'alters_data', False):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	708	current = settings.TEMPLATE_STRING_IF_INVALID
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	709	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	710	try: # method call (assuming no args required)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	711	current = current()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	712	except TypeError: # arguments were required
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	713	# GOTCHA: This will also catch any TypeError
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	714	# raised in the function itself.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	715	current = settings.TEMPLATE_STRING_IF_INVALID # invalid method call
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	716	except Exception, e:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	717	if getattr(e, 'silent_variable_failure', False):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	718	current = settings.TEMPLATE_STRING_IF_INVALID
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	719	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	720	raise
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	721	except (TypeError, AttributeError):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	722	try: # list-index lookup
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	723	current = current[int(bit)]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	724	except (IndexError, # list index out of range
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	725	ValueError, # invalid literal for int()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	726	KeyError, # current is a dict without `int(bit)` key
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	727	TypeError, # unsubscriptable object
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	728	):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	729	raise VariableDoesNotExist("Failed lookup for key [%s] in %r", (bit, current)) # missing attribute
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	730	except Exception, e:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	731	if getattr(e, 'silent_variable_failure', False):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	732	current = settings.TEMPLATE_STRING_IF_INVALID
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	733	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	734	raise
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	735
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	736	return current
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	737
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	738	class Node(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	739	# Set this to True for nodes that must be first in the template (although
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	740	# they can be preceded by text nodes.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	741	must_be_first = False
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	742
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	743	def render(self, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	744	"Return the node rendered as a string"
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	745	pass
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	746
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	747	def __iter__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	748	yield self
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	749
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	750	def get_nodes_by_type(self, nodetype):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	751	"Return a list of all nodes (within this node and its nodelist) of the given type"
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	752	nodes = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	753	if isinstance(self, nodetype):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	754	nodes.append(self)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	755	if hasattr(self, 'nodelist'):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	756	nodes.extend(self.nodelist.get_nodes_by_type(nodetype))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	757	return nodes
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	758
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	759	class NodeList(list):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	760	# Set to True the first time a non-TextNode is inserted by
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	761	# extend_nodelist().
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	762	contains_nontext = False
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	763
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	764	def render(self, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	765	bits = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	766	for node in self:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	767	if isinstance(node, Node):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	768	bits.append(self.render_node(node, context))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	769	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	770	bits.append(node)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	771	return mark_safe(''.join([force_unicode(b) for b in bits]))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	772
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	773	def get_nodes_by_type(self, nodetype):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	774	"Return a list of all nodes of the given type"
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	775	nodes = []
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	776	for node in self:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	777	nodes.extend(node.get_nodes_by_type(nodetype))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	778	return nodes
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	779
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	780	def render_node(self, node, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	781	return node.render(context)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	782
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	783	class TextNode(Node):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	784	def __init__(self, s):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	785	self.s = s
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	786
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	787	def __repr__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	788	return "<Text Node: '%s'>" % self.s[:25]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	789
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	790	def render(self, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	791	return self.s
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	792
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	793	class VariableNode(Node):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	794	def __init__(self, filter_expression):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	795	self.filter_expression = filter_expression
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	796
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	797	def __repr__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	798	return "<Variable Node: %s>" % self.filter_expression
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	799
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	800	def render(self, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	801	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	802	output = force_unicode(self.filter_expression.resolve(context))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	803	except UnicodeDecodeError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	804	# Unicode conversion can fail sometimes for reasons out of our
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	805	# control (e.g. exception rendering). In that case, we fail quietly.
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	806	return ''
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	807	if (context.autoescape and not isinstance(output, SafeData)) or isinstance(output, EscapeData):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	808	return force_unicode(escape(output))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	809	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	810	return force_unicode(output)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	811
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	812	def generic_tag_compiler(params, defaults, name, node_class, parser, token):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	813	"Returns a template.Node subclass."
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	814	bits = token.split_contents()[1:]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	815	bmax = len(params)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	816	def_len = defaults and len(defaults) or 0
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	817	bmin = bmax - def_len
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	818	if(len(bits) < bmin or len(bits) > bmax):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	819	if bmin == bmax:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	820	message = "%s takes %s arguments" % (name, bmin)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	821	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	822	message = "%s takes between %s and %s arguments" % (name, bmin, bmax)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	823	raise TemplateSyntaxError(message)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	824	return node_class(bits)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	825
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	826	class Library(object):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	827	def __init__(self):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	828	self.filters = {}
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	829	self.tags = {}
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	830
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	831	def tag(self, name=None, compile_function=None):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	832	if name == None and compile_function == None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	833	# @register.tag()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	834	return self.tag_function
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	835	elif name != None and compile_function == None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	836	if(callable(name)):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	837	# @register.tag
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	838	return self.tag_function(name)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	839	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	840	# @register.tag('somename') or @register.tag(name='somename')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	841	def dec(func):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	842	return self.tag(name, func)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	843	return dec
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	844	elif name != None and compile_function != None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	845	# register.tag('somename', somefunc)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	846	self.tags[name] = compile_function
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	847	return compile_function
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	848	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	849	raise InvalidTemplateLibrary("Unsupported arguments to Library.tag: (%r, %r)", (name, compile_function))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	850
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	851	def tag_function(self,func):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	852	self.tags[getattr(func, "_decorated_function", func).__name__] = func
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	853	return func
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	854
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	855	def filter(self, name=None, filter_func=None):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	856	if name == None and filter_func == None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	857	# @register.filter()
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	858	return self.filter_function
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	859	elif filter_func == None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	860	if(callable(name)):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	861	# @register.filter
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	862	return self.filter_function(name)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	863	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	864	# @register.filter('somename') or @register.filter(name='somename')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	865	def dec(func):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	866	return self.filter(name, func)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	867	return dec
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	868	elif name != None and filter_func != None:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	869	# register.filter('somename', somefunc)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	870	self.filters[name] = filter_func
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	871	return filter_func
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	872	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	873	raise InvalidTemplateLibrary("Unsupported arguments to Library.filter: (%r, %r)", (name, filter_func))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	874
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	875	def filter_function(self, func):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	876	self.filters[getattr(func, "_decorated_function", func).__name__] = func
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	877	return func
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	878
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	879	def simple_tag(self,func):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	880	params, xx, xxx, defaults = getargspec(func)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	881
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	882	class SimpleNode(Node):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	883	def __init__(self, vars_to_resolve):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	884	self.vars_to_resolve = map(Variable, vars_to_resolve)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	885
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	886	def render(self, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	887	resolved_vars = [var.resolve(context) for var in self.vars_to_resolve]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	888	return func(*resolved_vars)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	889
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	890	compile_func = curry(generic_tag_compiler, params, defaults, getattr(func, "_decorated_function", func).__name__, SimpleNode)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	891	compile_func.__doc__ = func.__doc__
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	892	self.tag(getattr(func, "_decorated_function", func).__name__, compile_func)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	893	return func
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	894
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	895	def inclusion_tag(self, file_name, context_class=Context, takes_context=False):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	896	def dec(func):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	897	params, xx, xxx, defaults = getargspec(func)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	898	if takes_context:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	899	if params[0] == 'context':
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	900	params = params[1:]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	901	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	902	raise TemplateSyntaxError("Any tag function decorated with takes_context=True must have a first argument of 'context'")
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	903
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	904	class InclusionNode(Node):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	905	def __init__(self, vars_to_resolve):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	906	self.vars_to_resolve = map(Variable, vars_to_resolve)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	907
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	908	def render(self, context):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	909	resolved_vars = [var.resolve(context) for var in self.vars_to_resolve]
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	910	if takes_context:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	911	args = [context] + resolved_vars
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	912	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	913	args = resolved_vars
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	914
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	915	dict = func(*args)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	916
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	917	if not getattr(self, 'nodelist', False):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	918	from django.template.loader import get_template, select_template
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	919	if not isinstance(file_name, basestring) and is_iterable(file_name):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	920	t = select_template(file_name)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	921	else:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	922	t = get_template(file_name)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	923	self.nodelist = t.nodelist
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	924	return self.nodelist.render(context_class(dict,
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	925	autoescape=context.autoescape))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	926
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	927	compile_func = curry(generic_tag_compiler, params, defaults, getattr(func, "_decorated_function", func).__name__, InclusionNode)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	928	compile_func.__doc__ = func.__doc__
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	929	self.tag(getattr(func, "_decorated_function", func).__name__, compile_func)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	930	return func
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	931	return dec
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	932
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	933	def get_library(module_name):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	934	lib = libraries.get(module_name, None)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	935	if not lib:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	936	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	937	mod = __import__(module_name, {}, {}, [''])
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	938	except ImportError, e:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	939	raise InvalidTemplateLibrary("Could not load template library from %s, %s" % (module_name, e))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	940	try:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	941	lib = mod.register
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	942	libraries[module_name] = lib
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	943	except AttributeError:
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	944	raise InvalidTemplateLibrary("Template library %s does not have a variable named 'register'" % module_name)
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	945	return lib
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	946
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	947	def add_to_builtins(module_name):
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	948	builtins.append(get_library(module_name))
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	949
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	950	add_to_builtins('django.template.defaulttags')
03e267d67478 Major reorganization of the soc svn repo, to merge into a single App Engine Todd Larsen <tlarsen@google.com> parents: diff changeset	951	add_to_builtins('django.template.defaultfilters')

author	Sverre Rabbelier <srabbelier@gmail.com>
	Sat, 21 Feb 2009 20:15:56 +0000
changeset 1444	b97cfeb423f4
parent 323	ff1a9aa48cfd
permissions	-rw-r--r--