argo_navis: venv/lib/python2.7/site-packages/jinja2/runtime.py annotate

author	bcclaywell
date	Mon, 12 Oct 2015 17:43:33 -0400
parents
children

rev	line source
0 d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	1 # -- coding: utf-8 --
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	2 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	3 jinja2.runtime
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	4 ~~~~~~~~~~~~~~
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	5
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	6 Runtime helpers.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	7
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	8 :copyright: (c) 2010 by the Jinja Team.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	9 :license: BSD.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	10 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	11 import sys
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	12
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	13 from itertools import chain
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	14 from jinja2.nodes import EvalContext, _context_function_types
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	15 from jinja2.utils import Markup, soft_unicode, escape, missing, concat, \
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	16 internalcode, object_type_repr
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	17 from jinja2.exceptions import UndefinedError, TemplateRuntimeError, \
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	18 TemplateNotFound
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	19 from jinja2._compat import imap, text_type, iteritems, \
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	20 implements_iterator, implements_to_string, string_types, PY2
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	21
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	22
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	23 # these variables are exported to the template runtime
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	24 __all__ = ['LoopContext', 'TemplateReference', 'Macro', 'Markup',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	25 'TemplateRuntimeError', 'missing', 'concat', 'escape',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	26 'markup_join', 'unicode_join', 'to_string', 'identity',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	27 'TemplateNotFound', 'make_logging_undefined']
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	28
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	29 #: the name of the function that is used to convert something into
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	30 #: a string. We can just use the text type here.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	31 to_string = text_type
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	32
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	33 #: the identity function. Useful for certain things in the environment
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	34 identity = lambda x: x
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	35
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	36 _last_iteration = object()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	37
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	38
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	39 def markup_join(seq):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	40 """Concatenation that escapes if necessary and converts to unicode."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	41 buf = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	42 iterator = imap(soft_unicode, seq)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	43 for arg in iterator:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	44 buf.append(arg)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	45 if hasattr(arg, '__html__'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	46 return Markup(u'').join(chain(buf, iterator))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	47 return concat(buf)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	48
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	49
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	50 def unicode_join(seq):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	51 """Simple args to unicode conversion and concatenation."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	52 return concat(imap(text_type, seq))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	53
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	54
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	55 def new_context(environment, template_name, blocks, vars=None,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	56 shared=None, globals=None, locals=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	57 """Internal helper to for context creation."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	58 if vars is None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	59 vars = {}
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	60 if shared:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	61 parent = vars
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	62 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	63 parent = dict(globals or (), **vars)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	64 if locals:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	65 # if the parent is shared a copy should be created because
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	66 # we don't want to modify the dict passed
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	67 if shared:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	68 parent = dict(parent)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	69 for key, value in iteritems(locals):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	70 if key[:2] == 'l_' and value is not missing:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	71 parent[key[2:]] = value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	72 return environment.context_class(environment, parent, template_name,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	73 blocks)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	74
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	75
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	76 class TemplateReference(object):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	77 """The `self` in templates."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	78
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	79 def __init__(self, context):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	80 self.__context = context
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	81
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	82 def __getitem__(self, name):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	83 blocks = self.__context.blocks[name]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	84 return BlockReference(name, self.__context, blocks, 0)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	85
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	86 def __repr__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	87 return '<%s %r>' % (
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	88 self.__class__.__name__,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	89 self.__context.name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	90 )
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	91
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	92
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	93 class Context(object):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	94 """The template context holds the variables of a template. It stores the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	95 values passed to the template and also the names the template exports.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	96 Creating instances is neither supported nor useful as it's created
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	97 automatically at various stages of the template evaluation and should not
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	98 be created by hand.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	99
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	100 The context is immutable. Modifications on :attr:`parent` must not
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	101 happen and modifications on :attr:`vars` are allowed from generated
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	102 template code only. Template filters and global functions marked as
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	103 :func:`contextfunction`\s get the active context passed as first argument
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	104 and are allowed to access the context read-only.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	105
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	106 The template context supports read only dict operations (`get`,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	107 `keys`, `values`, `items`, `iterkeys`, `itervalues`, `iteritems`,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	108 `__getitem__`, `__contains__`). Additionally there is a :meth:`resolve`
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	109 method that doesn't fail with a `KeyError` but returns an
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	110 :class:`Undefined` object for missing variables.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	111 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	112 __slots__ = ('parent', 'vars', 'environment', 'eval_ctx', 'exported_vars',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	113 'name', 'blocks', '__weakref__')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	114
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	115 def __init__(self, environment, parent, name, blocks):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	116 self.parent = parent
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	117 self.vars = {}
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	118 self.environment = environment
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	119 self.eval_ctx = EvalContext(self.environment, name)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	120 self.exported_vars = set()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	121 self.name = name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	122
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	123 # create the initial mapping of blocks. Whenever template inheritance
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	124 # takes place the runtime will update this mapping with the new blocks
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	125 # from the template.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	126 self.blocks = dict((k, [v]) for k, v in iteritems(blocks))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	127
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	128 def super(self, name, current):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	129 """Render a parent block."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	130 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	131 blocks = self.blocks[name]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	132 index = blocks.index(current) + 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	133 blocks[index]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	134 except LookupError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	135 return self.environment.undefined('there is no parent block '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	136 'called %r.' % name,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	137 name='super')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	138 return BlockReference(name, self, blocks, index)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	139
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	140 def get(self, key, default=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	141 """Returns an item from the template context, if it doesn't exist
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	142 `default` is returned.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	143 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	144 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	145 return self[key]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	146 except KeyError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	147 return default
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	148
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	149 def resolve(self, key):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	150 """Looks up a variable like `__getitem__` or `get` but returns an
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	151 :class:`Undefined` object with the name of the name looked up.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	152 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	153 if key in self.vars:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	154 return self.vars[key]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	155 if key in self.parent:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	156 return self.parent[key]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	157 return self.environment.undefined(name=key)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	158
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	159 def get_exported(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	160 """Get a new dict with the exported variables."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	161 return dict((k, self.vars[k]) for k in self.exported_vars)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	162
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	163 def get_all(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	164 """Return a copy of the complete context as dict including the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	165 exported variables.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	166 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	167 return dict(self.parent, **self.vars)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	168
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	169 @internalcode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	170 def call(__self, __obj, args, *kwargs):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	171 """Call the callable with the arguments and keyword arguments
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	172 provided but inject the active context or environment as first
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	173 argument if the callable is a :func:`contextfunction` or
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	174 :func:`environmentfunction`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	175 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	176 if __debug__:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	177 __traceback_hide__ = True # noqa
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	178
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	179 # Allow callable classes to take a context
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	180 fn = __obj.__call__
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	181 for fn_type in ('contextfunction',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	182 'evalcontextfunction',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	183 'environmentfunction'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	184 if hasattr(fn, fn_type):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	185 __obj = fn
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	186 break
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	187
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	188 if isinstance(__obj, _context_function_types):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	189 if getattr(__obj, 'contextfunction', 0):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	190 args = (__self,) + args
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	191 elif getattr(__obj, 'evalcontextfunction', 0):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	192 args = (__self.eval_ctx,) + args
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	193 elif getattr(__obj, 'environmentfunction', 0):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	194 args = (__self.environment,) + args
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	195 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	196 return __obj(args, *kwargs)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	197 except StopIteration:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	198 return __self.environment.undefined('value was undefined because '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	199 'a callable raised a '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	200 'StopIteration exception')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	201
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	202 def derived(self, locals=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	203 """Internal helper function to create a derived context."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	204 context = new_context(self.environment, self.name, {},
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	205 self.parent, True, None, locals)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	206 context.vars.update(self.vars)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	207 context.eval_ctx = self.eval_ctx
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	208 context.blocks.update((k, list(v)) for k, v in iteritems(self.blocks))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	209 return context
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	210
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	211 def _all(meth):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	212 proxy = lambda self: getattr(self.get_all(), meth)()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	213 proxy.__doc__ = getattr(dict, meth).__doc__
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	214 proxy.__name__ = meth
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	215 return proxy
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	216
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	217 keys = _all('keys')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	218 values = _all('values')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	219 items = _all('items')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	220
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	221 # not available on python 3
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	222 if PY2:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	223 iterkeys = _all('iterkeys')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	224 itervalues = _all('itervalues')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	225 iteritems = _all('iteritems')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	226 del _all
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	227
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	228 def __contains__(self, name):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	229 return name in self.vars or name in self.parent
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	230
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	231 def __getitem__(self, key):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	232 """Lookup a variable or raise `KeyError` if the variable is
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	233 undefined.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	234 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	235 item = self.resolve(key)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	236 if isinstance(item, Undefined):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	237 raise KeyError(key)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	238 return item
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	239
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	240 def __repr__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	241 return '<%s %s of %r>' % (
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	242 self.__class__.__name__,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	243 repr(self.get_all()),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	244 self.name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	245 )
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	246
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	247
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	248 # register the context as mapping if possible
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	249 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	250 from collections import Mapping
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	251 Mapping.register(Context)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	252 except ImportError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	253 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	254
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	255
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	256 class BlockReference(object):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	257 """One block on a template reference."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	258
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	259 def __init__(self, name, context, stack, depth):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	260 self.name = name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	261 self._context = context
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	262 self._stack = stack
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	263 self._depth = depth
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	264
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	265 @property
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	266 def super(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	267 """Super the block."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	268 if self._depth + 1 >= len(self._stack):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	269 return self._context.environment. \
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	270 undefined('there is no parent block called %r.' %
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	271 self.name, name='super')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	272 return BlockReference(self.name, self._context, self._stack,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	273 self._depth + 1)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	274
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	275 @internalcode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	276 def __call__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	277 rv = concat(self._stack[self._depth](self._context))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	278 if self._context.eval_ctx.autoescape:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	279 rv = Markup(rv)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	280 return rv
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	281
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	282
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	283 class LoopContext(object):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	284 """A loop context for dynamic iteration."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	285
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	286 def __init__(self, iterable, recurse=None, depth0=0):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	287 self._iterator = iter(iterable)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	288 self._recurse = recurse
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	289 self._after = self._safe_next()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	290 self.index0 = -1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	291 self.depth0 = depth0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	292
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	293 # try to get the length of the iterable early. This must be done
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	294 # here because there are some broken iterators around where there
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	295 # __len__ is the number of iterations left (i'm looking at your
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	296 # listreverseiterator!).
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	297 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	298 self._length = len(iterable)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	299 except (TypeError, AttributeError):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	300 self._length = None
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	301
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	302 def cycle(self, *args):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	303 """Cycles among the arguments with the current loop index."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	304 if not args:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	305 raise TypeError('no items for cycling given')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	306 return args[self.index0 % len(args)]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	307
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	308 first = property(lambda x: x.index0 == 0)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	309 last = property(lambda x: x._after is _last_iteration)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	310 index = property(lambda x: x.index0 + 1)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	311 revindex = property(lambda x: x.length - x.index0)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	312 revindex0 = property(lambda x: x.length - x.index)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	313 depth = property(lambda x: x.depth0 + 1)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	314
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	315 def __len__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	316 return self.length
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	317
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	318 def __iter__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	319 return LoopContextIterator(self)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	320
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	321 def _safe_next(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	322 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	323 return next(self._iterator)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	324 except StopIteration:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	325 return _last_iteration
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	326
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	327 @internalcode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	328 def loop(self, iterable):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	329 if self._recurse is None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	330 raise TypeError('Tried to call non recursive loop. Maybe you '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	331 "forgot the 'recursive' modifier.")
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	332 return self._recurse(iterable, self._recurse, self.depth0 + 1)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	333
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	334 # a nifty trick to enhance the error message if someone tried to call
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	335 # the the loop without or with too many arguments.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	336 __call__ = loop
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	337 del loop
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	338
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	339 @property
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	340 def length(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	341 if self._length is None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	342 # if was not possible to get the length of the iterator when
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	343 # the loop context was created (ie: iterating over a generator)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	344 # we have to convert the iterable into a sequence and use the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	345 # length of that + the number of iterations so far.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	346 iterable = tuple(self._iterator)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	347 self._iterator = iter(iterable)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	348 iterations_done = self.index0 + 2
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	349 self._length = len(iterable) + iterations_done
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	350 return self._length
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	351
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	352 def __repr__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	353 return '<%s %r/%r>' % (
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	354 self.__class__.__name__,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	355 self.index,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	356 self.length
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	357 )
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	358
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	359
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	360 @implements_iterator
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	361 class LoopContextIterator(object):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	362 """The iterator for a loop context."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	363 __slots__ = ('context',)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	364
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	365 def __init__(self, context):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	366 self.context = context
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	367
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	368 def __iter__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	369 return self
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	370
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	371 def __next__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	372 ctx = self.context
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	373 ctx.index0 += 1
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	374 if ctx._after is _last_iteration:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	375 raise StopIteration()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	376 next_elem = ctx._after
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	377 ctx._after = ctx._safe_next()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	378 return next_elem, ctx
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	379
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	380
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	381 class Macro(object):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	382 """Wraps a macro function."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	383
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	384 def __init__(self, environment, func, name, arguments, defaults,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	385 catch_kwargs, catch_varargs, caller):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	386 self._environment = environment
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	387 self._func = func
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	388 self._argument_count = len(arguments)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	389 self.name = name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	390 self.arguments = arguments
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	391 self.defaults = defaults
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	392 self.catch_kwargs = catch_kwargs
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	393 self.catch_varargs = catch_varargs
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	394 self.caller = caller
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	395
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	396 @internalcode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	397 def __call__(self, args, *kwargs):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	398 # try to consume the positional arguments
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	399 arguments = list(args[:self._argument_count])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	400 off = len(arguments)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	401
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	402 # if the number of arguments consumed is not the number of
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	403 # arguments expected we start filling in keyword arguments
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	404 # and defaults.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	405 if off != self._argument_count:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	406 for idx, name in enumerate(self.arguments[len(arguments):]):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	407 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	408 value = kwargs.pop(name)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	409 except KeyError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	410 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	411 value = self.defaults[idx - self._argument_count + off]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	412 except IndexError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	413 value = self._environment.undefined(
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	414 'parameter %r was not provided' % name, name=name)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	415 arguments.append(value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	416
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	417 # it's important that the order of these arguments does not change
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	418 # if not also changed in the compiler's `function_scoping` method.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	419 # the order is caller, keyword arguments, positional arguments!
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	420 if self.caller:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	421 caller = kwargs.pop('caller', None)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	422 if caller is None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	423 caller = self._environment.undefined('No caller defined',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	424 name='caller')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	425 arguments.append(caller)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	426 if self.catch_kwargs:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	427 arguments.append(kwargs)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	428 elif kwargs:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	429 raise TypeError('macro %r takes no keyword argument %r' %
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	430 (self.name, next(iter(kwargs))))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	431 if self.catch_varargs:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	432 arguments.append(args[self._argument_count:])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	433 elif len(args) > self._argument_count:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	434 raise TypeError('macro %r takes not more than %d argument(s)' %
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	435 (self.name, len(self.arguments)))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	436 return self._func(*arguments)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	437
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	438 def __repr__(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	439 return '<%s %s>' % (
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	440 self.__class__.__name__,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	441 self.name is None and 'anonymous' or repr(self.name)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	442 )
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	443
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	444
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	445 @implements_to_string
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	446 class Undefined(object):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	447 """The default undefined type. This undefined type can be printed and
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	448 iterated over, but every other access will raise an :exc:`jinja2.exceptions.UndefinedError`:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	449
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	450 >>> foo = Undefined(name='foo')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	451 >>> str(foo)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	452 ''
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	453 >>> not foo
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	454 True
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	455 >>> foo + 42
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	456 Traceback (most recent call last):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	457 ...
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	458 jinja2.exceptions.UndefinedError: 'foo' is undefined
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	459 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	460 __slots__ = ('_undefined_hint', '_undefined_obj', '_undefined_name',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	461 '_undefined_exception')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	462
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	463 def __init__(self, hint=None, obj=missing, name=None, exc=UndefinedError):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	464 self._undefined_hint = hint
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	465 self._undefined_obj = obj
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	466 self._undefined_name = name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	467 self._undefined_exception = exc
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	468
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	469 @internalcode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	470 def _fail_with_undefined_error(self, args, *kwargs):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	471 """Regular callback function for undefined objects that raises an
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	472 `jinja2.exceptions.UndefinedError` on call.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	473 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	474 if self._undefined_hint is None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	475 if self._undefined_obj is missing:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	476 hint = '%r is undefined' % self._undefined_name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	477 elif not isinstance(self._undefined_name, string_types):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	478 hint = '%s has no element %r' % (
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	479 object_type_repr(self._undefined_obj),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	480 self._undefined_name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	481 )
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	482 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	483 hint = '%r has no attribute %r' % (
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	484 object_type_repr(self._undefined_obj),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	485 self._undefined_name
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	486 )
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	487 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	488 hint = self._undefined_hint
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	489 raise self._undefined_exception(hint)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	490
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	491 @internalcode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	492 def __getattr__(self, name):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	493 if name[:2] == '__':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	494 raise AttributeError(name)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	495 return self._fail_with_undefined_error()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	496
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	497 __add__ = __radd__ = __mul__ = __rmul__ = __div__ = __rdiv__ = \
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	498 __truediv__ = __rtruediv__ = __floordiv__ = __rfloordiv__ = \
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	499 __mod__ = __rmod__ = __pos__ = __neg__ = __call__ = \
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	500 __getitem__ = __lt__ = __le__ = __gt__ = __ge__ = __int__ = \

0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1 # -*- coding: utf-8 -*-

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

2 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

3 jinja2.runtime

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

4 ~~~~~~~~~~~~~~

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

5

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

6 Runtime helpers.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

7

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

9 :license: BSD.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

10 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

11 import sys

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

12

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

13 from itertools import chain

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

14 from jinja2.nodes import EvalContext, _context_function_types

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

15 from jinja2.utils import Markup, soft_unicode, escape, missing, concat, \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

16 internalcode, object_type_repr

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

17 from jinja2.exceptions import UndefinedError, TemplateRuntimeError, \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

18 TemplateNotFound

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

19 from jinja2._compat import imap, text_type, iteritems, \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

20 implements_iterator, implements_to_string, string_types, PY2

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

21

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

22

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

23 # these variables are exported to the template runtime

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

24 __all__ = ['LoopContext', 'TemplateReference', 'Macro', 'Markup',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

25 'TemplateRuntimeError', 'missing', 'concat', 'escape',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

26 'markup_join', 'unicode_join', 'to_string', 'identity',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

27 'TemplateNotFound', 'make_logging_undefined']

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

28

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

29 #: the name of the function that is used to convert something into

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

30 #: a string. We can just use the text type here.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

31 to_string = text_type

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

32

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

33 #: the identity function. Useful for certain things in the environment

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

34 identity = lambda x: x

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

35

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

36 _last_iteration = object()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

37

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

38

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

39 def markup_join(seq):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

40 """Concatenation that escapes if necessary and converts to unicode."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

41 buf = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

42 iterator = imap(soft_unicode, seq)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

43 for arg in iterator:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

44 buf.append(arg)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

45 if hasattr(arg, '__html__'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

46 return Markup(u'').join(chain(buf, iterator))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

47 return concat(buf)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

48

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

49

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

50 def unicode_join(seq):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

51 """Simple args to unicode conversion and concatenation."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

52 return concat(imap(text_type, seq))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

53

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

54

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

55 def new_context(environment, template_name, blocks, vars=None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

56 shared=None, globals=None, locals=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

57 """Internal helper to for context creation."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

58 if vars is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

59 vars = {}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

60 if shared:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

61 parent = vars

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

62 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

63 parent = dict(globals or (), **vars)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

64 if locals:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

65 # if the parent is shared a copy should be created because

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

66 # we don't want to modify the dict passed

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

67 if shared:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

68 parent = dict(parent)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

69 for key, value in iteritems(locals):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

70 if key[:2] == 'l_' and value is not missing:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

71 parent[key[2:]] = value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

72 return environment.context_class(environment, parent, template_name,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

73 blocks)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

74

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

75

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

76 class TemplateReference(object):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

77 """The `self` in templates."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

78

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

79 def __init__(self, context):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

80 self.__context = context

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

81

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

82 def __getitem__(self, name):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

83 blocks = self.__context.blocks[name]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

84 return BlockReference(name, self.__context, blocks, 0)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

85

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

86 def __repr__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

87 return '<%s %r>' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

88 self.__class__.__name__,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

89 self.__context.name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

90 )

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

91

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

92

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

93 class Context(object):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

94 """The template context holds the variables of a template. It stores the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

95 values passed to the template and also the names the template exports.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

96 Creating instances is neither supported nor useful as it's created

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

97 automatically at various stages of the template evaluation and should not

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

98 be created by hand.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

99

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

100 The context is immutable. Modifications on :attr:`parent` **must not**

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

101 happen and modifications on :attr:`vars` are allowed from generated

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

102 template code only. Template filters and global functions marked as

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

103 :func:`contextfunction`\s get the active context passed as first argument

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

104 and are allowed to access the context read-only.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

105

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

106 The template context supports read only dict operations (`get`,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

107 `keys`, `values`, `items`, `iterkeys`, `itervalues`, `iteritems`,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

108 `__getitem__`, `__contains__`). Additionally there is a :meth:`resolve`

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

109 method that doesn't fail with a `KeyError` but returns an

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

110 :class:`Undefined` object for missing variables.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

111 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

112 __slots__ = ('parent', 'vars', 'environment', 'eval_ctx', 'exported_vars',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

113 'name', 'blocks', '__weakref__')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

114

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

115 def __init__(self, environment, parent, name, blocks):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

116 self.parent = parent

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

117 self.vars = {}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

118 self.environment = environment

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

119 self.eval_ctx = EvalContext(self.environment, name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

120 self.exported_vars = set()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

121 self.name = name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

122

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

123 # create the initial mapping of blocks. Whenever template inheritance

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

124 # takes place the runtime will update this mapping with the new blocks

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

125 # from the template.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

126 self.blocks = dict((k, [v]) for k, v in iteritems(blocks))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

127

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

128 def super(self, name, current):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

129 """Render a parent block."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

130 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

131 blocks = self.blocks[name]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

132 index = blocks.index(current) + 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

133 blocks[index]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

134 except LookupError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

135 return self.environment.undefined('there is no parent block '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

136 'called %r.' % name,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

137 name='super')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

138 return BlockReference(name, self, blocks, index)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

139

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

140 def get(self, key, default=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

141 """Returns an item from the template context, if it doesn't exist

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

142 `default` is returned.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

143 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

144 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

145 return self[key]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

146 except KeyError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

147 return default

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

148

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

149 def resolve(self, key):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

150 """Looks up a variable like `__getitem__` or `get` but returns an

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

151 :class:`Undefined` object with the name of the name looked up.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

152 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

153 if key in self.vars:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

154 return self.vars[key]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

155 if key in self.parent:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

156 return self.parent[key]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

157 return self.environment.undefined(name=key)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

158

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

159 def get_exported(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

160 """Get a new dict with the exported variables."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

161 return dict((k, self.vars[k]) for k in self.exported_vars)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

162

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

163 def get_all(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

164 """Return a copy of the complete context as dict including the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

165 exported variables.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

166 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

167 return dict(self.parent, **self.vars)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

168

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

169 @internalcode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

170 def call(__self, __obj, *args, **kwargs):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

171 """Call the callable with the arguments and keyword arguments

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

172 provided but inject the active context or environment as first

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

173 argument if the callable is a :func:`contextfunction` or

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

174 :func:`environmentfunction`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

175 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

176 if __debug__:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

177 __traceback_hide__ = True # noqa

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

178

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

179 # Allow callable classes to take a context

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

180 fn = __obj.__call__

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

181 for fn_type in ('contextfunction',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

182 'evalcontextfunction',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

183 'environmentfunction'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

184 if hasattr(fn, fn_type):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

185 __obj = fn

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

186 break

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

187

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

188 if isinstance(__obj, _context_function_types):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

189 if getattr(__obj, 'contextfunction', 0):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

190 args = (__self,) + args

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

191 elif getattr(__obj, 'evalcontextfunction', 0):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

192 args = (__self.eval_ctx,) + args

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

193 elif getattr(__obj, 'environmentfunction', 0):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

194 args = (__self.environment,) + args

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

195 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

196 return __obj(*args, **kwargs)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

197 except StopIteration:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

198 return __self.environment.undefined('value was undefined because '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

199 'a callable raised a '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

200 'StopIteration exception')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

201

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

202 def derived(self, locals=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

203 """Internal helper function to create a derived context."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

204 context = new_context(self.environment, self.name, {},

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

205 self.parent, True, None, locals)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

206 context.vars.update(self.vars)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

207 context.eval_ctx = self.eval_ctx

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

208 context.blocks.update((k, list(v)) for k, v in iteritems(self.blocks))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

209 return context

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

210

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

211 def _all(meth):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

212 proxy = lambda self: getattr(self.get_all(), meth)()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

213 proxy.__doc__ = getattr(dict, meth).__doc__

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

214 proxy.__name__ = meth

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

215 return proxy

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

216

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

217 keys = _all('keys')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

218 values = _all('values')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

219 items = _all('items')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

220

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

221 # not available on python 3

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

222 if PY2:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

223 iterkeys = _all('iterkeys')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

224 itervalues = _all('itervalues')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

225 iteritems = _all('iteritems')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

226 del _all

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

227

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

228 def __contains__(self, name):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

229 return name in self.vars or name in self.parent

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

230

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

231 def __getitem__(self, key):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

232 """Lookup a variable or raise `KeyError` if the variable is

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

233 undefined.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

234 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

235 item = self.resolve(key)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

236 if isinstance(item, Undefined):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

237 raise KeyError(key)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

238 return item

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

239

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

240 def __repr__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

241 return '<%s %s of %r>' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

242 self.__class__.__name__,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

243 repr(self.get_all()),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

244 self.name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

245 )

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

246

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

247

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

248 # register the context as mapping if possible

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

249 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

250 from collections import Mapping

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

251 Mapping.register(Context)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

252 except ImportError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

253 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

254

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

255

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

256 class BlockReference(object):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

257 """One block on a template reference."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

258

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

259 def __init__(self, name, context, stack, depth):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

260 self.name = name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

261 self._context = context

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

262 self._stack = stack

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

263 self._depth = depth

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

264

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

265 @property

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

266 def super(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

267 """Super the block."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

268 if self._depth + 1 >= len(self._stack):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

269 return self._context.environment. \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

270 undefined('there is no parent block called %r.' %

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

271 self.name, name='super')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

272 return BlockReference(self.name, self._context, self._stack,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

273 self._depth + 1)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

274

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

275 @internalcode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

276 def __call__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

277 rv = concat(self._stack[self._depth](self._context))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

278 if self._context.eval_ctx.autoescape:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

279 rv = Markup(rv)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

280 return rv

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

281

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

282

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

283 class LoopContext(object):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

284 """A loop context for dynamic iteration."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

285

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

286 def __init__(self, iterable, recurse=None, depth0=0):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

287 self._iterator = iter(iterable)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

288 self._recurse = recurse

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

289 self._after = self._safe_next()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

290 self.index0 = -1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

291 self.depth0 = depth0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

292

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

293 # try to get the length of the iterable early. This must be done

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

294 # here because there are some broken iterators around where there

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

295 # __len__ is the number of iterations left (i'm looking at your

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

296 # listreverseiterator!).

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

297 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

298 self._length = len(iterable)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

299 except (TypeError, AttributeError):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

300 self._length = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

301

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

302 def cycle(self, *args):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

303 """Cycles among the arguments with the current loop index."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

304 if not args:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

305 raise TypeError('no items for cycling given')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

306 return args[self.index0 % len(args)]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

307

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

308 first = property(lambda x: x.index0 == 0)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

309 last = property(lambda x: x._after is _last_iteration)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

310 index = property(lambda x: x.index0 + 1)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

311 revindex = property(lambda x: x.length - x.index0)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

312 revindex0 = property(lambda x: x.length - x.index)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

313 depth = property(lambda x: x.depth0 + 1)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

314

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

315 def __len__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

316 return self.length

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

317

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

318 def __iter__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

319 return LoopContextIterator(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

320

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

321 def _safe_next(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

322 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

323 return next(self._iterator)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

324 except StopIteration:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

325 return _last_iteration

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

326

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

327 @internalcode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

328 def loop(self, iterable):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

329 if self._recurse is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

330 raise TypeError('Tried to call non recursive loop. Maybe you '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

331 "forgot the 'recursive' modifier.")

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

332 return self._recurse(iterable, self._recurse, self.depth0 + 1)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

333

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

334 # a nifty trick to enhance the error message if someone tried to call

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

335 # the the loop without or with too many arguments.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

336 __call__ = loop

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

337 del loop

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

338

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

339 @property

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

340 def length(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

341 if self._length is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

342 # if was not possible to get the length of the iterator when

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

343 # the loop context was created (ie: iterating over a generator)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

344 # we have to convert the iterable into a sequence and use the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

345 # length of that + the number of iterations so far.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

346 iterable = tuple(self._iterator)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

347 self._iterator = iter(iterable)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

348 iterations_done = self.index0 + 2

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

349 self._length = len(iterable) + iterations_done

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

350 return self._length

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

351

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

352 def __repr__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

353 return '<%s %r/%r>' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

354 self.__class__.__name__,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

355 self.index,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

356 self.length

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

357 )

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

358

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

359

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

360 @implements_iterator

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

361 class LoopContextIterator(object):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

362 """The iterator for a loop context."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

363 __slots__ = ('context',)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

364

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

365 def __init__(self, context):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

366 self.context = context

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

367

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

368 def __iter__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

369 return self

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

370

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

371 def __next__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

372 ctx = self.context

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

373 ctx.index0 += 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

374 if ctx._after is _last_iteration:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

375 raise StopIteration()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

376 next_elem = ctx._after

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

377 ctx._after = ctx._safe_next()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

378 return next_elem, ctx

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

379

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

380

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

381 class Macro(object):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

382 """Wraps a macro function."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

383

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

384 def __init__(self, environment, func, name, arguments, defaults,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

385 catch_kwargs, catch_varargs, caller):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

386 self._environment = environment

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

387 self._func = func

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

388 self._argument_count = len(arguments)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

389 self.name = name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

390 self.arguments = arguments

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

391 self.defaults = defaults

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

392 self.catch_kwargs = catch_kwargs

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

393 self.catch_varargs = catch_varargs

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

394 self.caller = caller

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

395

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

396 @internalcode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

397 def __call__(self, *args, **kwargs):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

398 # try to consume the positional arguments

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

399 arguments = list(args[:self._argument_count])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

400 off = len(arguments)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

401

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

402 # if the number of arguments consumed is not the number of

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

403 # arguments expected we start filling in keyword arguments

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

404 # and defaults.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

405 if off != self._argument_count:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

406 for idx, name in enumerate(self.arguments[len(arguments):]):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

407 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

408 value = kwargs.pop(name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

409 except KeyError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

410 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

411 value = self.defaults[idx - self._argument_count + off]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

412 except IndexError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

413 value = self._environment.undefined(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

414 'parameter %r was not provided' % name, name=name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

415 arguments.append(value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

416

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

417 # it's important that the order of these arguments does not change

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

418 # if not also changed in the compiler's `function_scoping` method.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

419 # the order is caller, keyword arguments, positional arguments!

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

420 if self.caller:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

421 caller = kwargs.pop('caller', None)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

422 if caller is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

423 caller = self._environment.undefined('No caller defined',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

424 name='caller')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

425 arguments.append(caller)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

426 if self.catch_kwargs:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

427 arguments.append(kwargs)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

428 elif kwargs:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

429 raise TypeError('macro %r takes no keyword argument %r' %

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

430 (self.name, next(iter(kwargs))))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

431 if self.catch_varargs:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

432 arguments.append(args[self._argument_count:])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

433 elif len(args) > self._argument_count:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

434 raise TypeError('macro %r takes not more than %d argument(s)' %

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

435 (self.name, len(self.arguments)))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

436 return self._func(*arguments)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

437

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

438 def __repr__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

439 return '<%s %s>' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

440 self.__class__.__name__,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

441 self.name is None and 'anonymous' or repr(self.name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

442 )

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

443

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

444

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

445 @implements_to_string

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

446 class Undefined(object):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

447 """The default undefined type. This undefined type can be printed and

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

448 iterated over, but every other access will raise an :exc:`jinja2.exceptions.UndefinedError`:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

449

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

450 >>> foo = Undefined(name='foo')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

451 >>> str(foo)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

452 ''

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

453 >>> not foo

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

454 True

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

455 >>> foo + 42

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

456 Traceback (most recent call last):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

457 ...

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

458 jinja2.exceptions.UndefinedError: 'foo' is undefined

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

459 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

460 __slots__ = ('_undefined_hint', '_undefined_obj', '_undefined_name',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

461 '_undefined_exception')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

462

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

463 def __init__(self, hint=None, obj=missing, name=None, exc=UndefinedError):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

464 self._undefined_hint = hint

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

465 self._undefined_obj = obj

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

466 self._undefined_name = name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

467 self._undefined_exception = exc

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

468

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

469 @internalcode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

470 def _fail_with_undefined_error(self, *args, **kwargs):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

471 """Regular callback function for undefined objects that raises an

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

472 `jinja2.exceptions.UndefinedError` on call.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

473 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

474 if self._undefined_hint is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

475 if self._undefined_obj is missing:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

476 hint = '%r is undefined' % self._undefined_name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

477 elif not isinstance(self._undefined_name, string_types):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

478 hint = '%s has no element %r' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

479 object_type_repr(self._undefined_obj),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

480 self._undefined_name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

481 )

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

482 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

483 hint = '%r has no attribute %r' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

484 object_type_repr(self._undefined_obj),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

485 self._undefined_name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

486 )

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

487 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

488 hint = self._undefined_hint

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

489 raise self._undefined_exception(hint)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

490

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

491 @internalcode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

492 def __getattr__(self, name):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

493 if name[:2] == '__':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

494 raise AttributeError(name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

495 return self._fail_with_undefined_error()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

496

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

497 __add__ = __radd__ = __mul__ = __rmul__ = __div__ = __rdiv__ = \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

498 __truediv__ = __rtruediv__ = __floordiv__ = __rfloordiv__ = \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

499 __mod__ = __rmod__ = __pos__ = __neg__ = __call__ = \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

500 __getitem__ = __lt__ = __le__ = __gt__ = __ge__ = __int__ = \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

501 __float__ = __complex__ = __pow__ = __rpow__ = \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

502 _fail_with_undefined_error

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

503

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

504 def __eq__(self, other):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

505 return type(self) is type(other)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

506

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

507 def __ne__(self, other):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

508 return not self.__eq__(other)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

509

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

510 def __hash__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

511 return id(type(self))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

512

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

513 def __str__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

514 return u''

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

515

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

516 def __len__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

517 return 0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

518

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

519 def __iter__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

520 if 0:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

521 yield None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

522

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

523 def __nonzero__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

524 return False

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

525 __bool__ = __nonzero__

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

526

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

527 def __repr__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

528 return 'Undefined'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

529

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

530

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

531 def make_logging_undefined(logger=None, base=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

532 """Given a logger object this returns a new undefined class that will

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

533 log certain failures. It will log iterations and printing. If no

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

534 logger is given a default logger is created.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

535

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

536 Example::

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

537

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

538 logger = logging.getLogger(__name__)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

539 LoggingUndefined = make_logging_undefined(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

540 logger=logger,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

541 base=Undefined

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

542 )

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

543

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

544 .. versionadded:: 2.8

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

545

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

546 :param logger: the logger to use. If not provided, a default logger

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

547 is created.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

548 :param base: the base class to add logging functionality to. This

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

549 defaults to :class:`Undefined`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

550 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

551 if logger is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

552 import logging

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

553 logger = logging.getLogger(__name__)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

554 logger.addHandler(logging.StreamHandler(sys.stderr))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

555 if base is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

556 base = Undefined

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

557

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

558 def _log_message(undef):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

559 if undef._undefined_hint is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

560 if undef._undefined_obj is missing:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

561 hint = '%s is undefined' % undef._undefined_name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

562 elif not isinstance(undef._undefined_name, string_types):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

563 hint = '%s has no element %s' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

564 object_type_repr(undef._undefined_obj),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

565 undef._undefined_name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

566 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

567 hint = '%s has no attribute %s' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

568 object_type_repr(undef._undefined_obj),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

569 undef._undefined_name)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

570 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

571 hint = undef._undefined_hint

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

572 logger.warning('Template variable warning: %s', hint)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

573

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

574 class LoggingUndefined(base):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

575

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

576 def _fail_with_undefined_error(self, *args, **kwargs):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

577 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

578 return base._fail_with_undefined_error(self, *args, **kwargs)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

579 except self._undefined_exception as e:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

580 logger.error('Template variable error: %s', str(e))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

581 raise e

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

582

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

583 def __str__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

584 rv = base.__str__(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

585 _log_message(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

586 return rv

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

587

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

588 def __iter__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

589 rv = base.__iter__(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

590 _log_message(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

591 return rv

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

592

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

593 if PY2:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

594 def __nonzero__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

595 rv = base.__nonzero__(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

596 _log_message(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

597 return rv

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

598

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

599 def __unicode__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

600 rv = base.__unicode__(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

601 _log_message(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

602 return rv

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

603 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

604 def __bool__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

605 rv = base.__bool__(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

606 _log_message(self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

607 return rv

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

608

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

609 return LoggingUndefined

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

610

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

611

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

612 @implements_to_string

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

613 class DebugUndefined(Undefined):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

614 """An undefined that returns the debug info when printed.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

615

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

616 >>> foo = DebugUndefined(name='foo')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

617 >>> str(foo)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

618 '{{ foo }}'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

619 >>> not foo

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

620 True

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

621 >>> foo + 42

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

622 Traceback (most recent call last):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

623 ...

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

624 jinja2.exceptions.UndefinedError: 'foo' is undefined

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

625 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

626 __slots__ = ()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

627

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

628 def __str__(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

629 if self._undefined_hint is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

630 if self._undefined_obj is missing:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

631 return u'{{ %s }}' % self._undefined_name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

632 return '{{ no such element: %s[%r] }}' % (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

633 object_type_repr(self._undefined_obj),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

634 self._undefined_name

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

635 )

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

636 return u'{{ undefined value printed: %s }}' % self._undefined_hint

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

637

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

638

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

639 @implements_to_string

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

640 class StrictUndefined(Undefined):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

641 """An undefined that barks on print and iteration as well as boolean

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

642 tests and all kinds of comparisons. In other words: you can do nothing

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

643 with it except checking if it's defined using the `defined` test.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

644

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

645 >>> foo = StrictUndefined(name='foo')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

646 >>> str(foo)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

647 Traceback (most recent call last):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

648 ...

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

649 jinja2.exceptions.UndefinedError: 'foo' is undefined

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

650 >>> not foo

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

651 Traceback (most recent call last):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

652 ...

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

653 jinja2.exceptions.UndefinedError: 'foo' is undefined

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

654 >>> foo + 42

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

655 Traceback (most recent call last):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

656 ...

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

657 jinja2.exceptions.UndefinedError: 'foo' is undefined

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

658 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

659 __slots__ = ()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

660 __iter__ = __str__ = __len__ = __nonzero__ = __eq__ = \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

661 __ne__ = __bool__ = __hash__ = \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

662 Undefined._fail_with_undefined_error

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

663

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

664

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

665 # remove remaining slots attributes, after the metaclass did the magic they

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

666 # are unneeded and irritating as they contain wrong data for the subclasses.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

667 del Undefined.__slots__, DebugUndefined.__slots__, StrictUndefined.__slots__

Mercurial > repos > bcclaywell > argo_navis

annotate venv/lib/python2.7/site-packages/jinja2/runtime.py @ 0:d67268158946 draft