compiler.py 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640
  1. # -*- coding: utf-8 -*-
  2. """
  3. jinja2.compiler
  4. ~~~~~~~~~~~~~~~
  5. Compiles nodes into python code.
  6. :copyright: (c) 2010 by the Jinja Team.
  7. :license: BSD, see LICENSE for more details.
  8. """
  9. from itertools import chain
  10. from copy import deepcopy
  11. from keyword import iskeyword as is_python_keyword
  12. from jinja2 import nodes
  13. from jinja2.nodes import EvalContext
  14. from jinja2.visitor import NodeVisitor
  15. from jinja2.exceptions import TemplateAssertionError
  16. from jinja2.utils import Markup, concat, escape
  17. from jinja2._compat import range_type, next, text_type, string_types, \
  18. iteritems, NativeStringIO, imap
  19. operators = {
  20. 'eq': '==',
  21. 'ne': '!=',
  22. 'gt': '>',
  23. 'gteq': '>=',
  24. 'lt': '<',
  25. 'lteq': '<=',
  26. 'in': 'in',
  27. 'notin': 'not in'
  28. }
  29. # what method to iterate over items do we want to use for dict iteration
  30. # in generated code? on 2.x let's go with iteritems, on 3.x with items
  31. if hasattr(dict, 'iteritems'):
  32. dict_item_iter = 'iteritems'
  33. else:
  34. dict_item_iter = 'items'
  35. # does if 0: dummy(x) get us x into the scope?
  36. def unoptimize_before_dead_code():
  37. x = 42
  38. def f():
  39. if 0: dummy(x)
  40. return f
  41. # The getattr is necessary for pypy which does not set this attribute if
  42. # no closure is on the function
  43. unoptimize_before_dead_code = bool(
  44. getattr(unoptimize_before_dead_code(), '__closure__', None))
  45. def generate(node, environment, name, filename, stream=None,
  46. defer_init=False):
  47. """Generate the python source for a node tree."""
  48. if not isinstance(node, nodes.Template):
  49. raise TypeError('Can\'t compile non template nodes')
  50. generator = CodeGenerator(environment, name, filename, stream, defer_init)
  51. generator.visit(node)
  52. if stream is None:
  53. return generator.stream.getvalue()
  54. def has_safe_repr(value):
  55. """Does the node have a safe representation?"""
  56. if value is None or value is NotImplemented or value is Ellipsis:
  57. return True
  58. if isinstance(value, (bool, int, float, complex, range_type,
  59. Markup) + string_types):
  60. return True
  61. if isinstance(value, (tuple, list, set, frozenset)):
  62. for item in value:
  63. if not has_safe_repr(item):
  64. return False
  65. return True
  66. elif isinstance(value, dict):
  67. for key, value in iteritems(value):
  68. if not has_safe_repr(key):
  69. return False
  70. if not has_safe_repr(value):
  71. return False
  72. return True
  73. return False
  74. def find_undeclared(nodes, names):
  75. """Check if the names passed are accessed undeclared. The return value
  76. is a set of all the undeclared names from the sequence of names found.
  77. """
  78. visitor = UndeclaredNameVisitor(names)
  79. try:
  80. for node in nodes:
  81. visitor.visit(node)
  82. except VisitorExit:
  83. pass
  84. return visitor.undeclared
  85. class Identifiers(object):
  86. """Tracks the status of identifiers in frames."""
  87. def __init__(self):
  88. # variables that are known to be declared (probably from outer
  89. # frames or because they are special for the frame)
  90. self.declared = set()
  91. # undeclared variables from outer scopes
  92. self.outer_undeclared = set()
  93. # names that are accessed without being explicitly declared by
  94. # this one or any of the outer scopes. Names can appear both in
  95. # declared and undeclared.
  96. self.undeclared = set()
  97. # names that are declared locally
  98. self.declared_locally = set()
  99. # names that are declared by parameters
  100. self.declared_parameter = set()
  101. def add_special(self, name):
  102. """Register a special name like `loop`."""
  103. self.undeclared.discard(name)
  104. self.declared.add(name)
  105. def is_declared(self, name):
  106. """Check if a name is declared in this or an outer scope."""
  107. if name in self.declared_locally or name in self.declared_parameter:
  108. return True
  109. return name in self.declared
  110. def copy(self):
  111. return deepcopy(self)
  112. class Frame(object):
  113. """Holds compile time information for us."""
  114. def __init__(self, eval_ctx, parent=None):
  115. self.eval_ctx = eval_ctx
  116. self.identifiers = Identifiers()
  117. # a toplevel frame is the root + soft frames such as if conditions.
  118. self.toplevel = False
  119. # the root frame is basically just the outermost frame, so no if
  120. # conditions. This information is used to optimize inheritance
  121. # situations.
  122. self.rootlevel = False
  123. # in some dynamic inheritance situations the compiler needs to add
  124. # write tests around output statements.
  125. self.require_output_check = parent and parent.require_output_check
  126. # inside some tags we are using a buffer rather than yield statements.
  127. # this for example affects {% filter %} or {% macro %}. If a frame
  128. # is buffered this variable points to the name of the list used as
  129. # buffer.
  130. self.buffer = None
  131. # the name of the block we're in, otherwise None.
  132. self.block = parent and parent.block or None
  133. # a set of actually assigned names
  134. self.assigned_names = set()
  135. # the parent of this frame
  136. self.parent = parent
  137. if parent is not None:
  138. self.identifiers.declared.update(
  139. parent.identifiers.declared |
  140. parent.identifiers.declared_parameter |
  141. parent.assigned_names
  142. )
  143. self.identifiers.outer_undeclared.update(
  144. parent.identifiers.undeclared -
  145. self.identifiers.declared
  146. )
  147. self.buffer = parent.buffer
  148. def copy(self):
  149. """Create a copy of the current one."""
  150. rv = object.__new__(self.__class__)
  151. rv.__dict__.update(self.__dict__)
  152. rv.identifiers = object.__new__(self.identifiers.__class__)
  153. rv.identifiers.__dict__.update(self.identifiers.__dict__)
  154. return rv
  155. def inspect(self, nodes):
  156. """Walk the node and check for identifiers. If the scope is hard (eg:
  157. enforce on a python level) overrides from outer scopes are tracked
  158. differently.
  159. """
  160. visitor = FrameIdentifierVisitor(self.identifiers)
  161. for node in nodes:
  162. visitor.visit(node)
  163. def find_shadowed(self, extra=()):
  164. """Find all the shadowed names. extra is an iterable of variables
  165. that may be defined with `add_special` which may occour scoped.
  166. """
  167. i = self.identifiers
  168. return (i.declared | i.outer_undeclared) & \
  169. (i.declared_locally | i.declared_parameter) | \
  170. set(x for x in extra if i.is_declared(x))
  171. def inner(self):
  172. """Return an inner frame."""
  173. return Frame(self.eval_ctx, self)
  174. def soft(self):
  175. """Return a soft frame. A soft frame may not be modified as
  176. standalone thing as it shares the resources with the frame it
  177. was created of, but it's not a rootlevel frame any longer.
  178. """
  179. rv = self.copy()
  180. rv.rootlevel = False
  181. return rv
  182. __copy__ = copy
  183. class VisitorExit(RuntimeError):
  184. """Exception used by the `UndeclaredNameVisitor` to signal a stop."""
  185. class DependencyFinderVisitor(NodeVisitor):
  186. """A visitor that collects filter and test calls."""
  187. def __init__(self):
  188. self.filters = set()
  189. self.tests = set()
  190. def visit_Filter(self, node):
  191. self.generic_visit(node)
  192. self.filters.add(node.name)
  193. def visit_Test(self, node):
  194. self.generic_visit(node)
  195. self.tests.add(node.name)
  196. def visit_Block(self, node):
  197. """Stop visiting at blocks."""
  198. class UndeclaredNameVisitor(NodeVisitor):
  199. """A visitor that checks if a name is accessed without being
  200. declared. This is different from the frame visitor as it will
  201. not stop at closure frames.
  202. """
  203. def __init__(self, names):
  204. self.names = set(names)
  205. self.undeclared = set()
  206. def visit_Name(self, node):
  207. if node.ctx == 'load' and node.name in self.names:
  208. self.undeclared.add(node.name)
  209. if self.undeclared == self.names:
  210. raise VisitorExit()
  211. else:
  212. self.names.discard(node.name)
  213. def visit_Block(self, node):
  214. """Stop visiting a blocks."""
  215. class FrameIdentifierVisitor(NodeVisitor):
  216. """A visitor for `Frame.inspect`."""
  217. def __init__(self, identifiers):
  218. self.identifiers = identifiers
  219. def visit_Name(self, node):
  220. """All assignments to names go through this function."""
  221. if node.ctx == 'store':
  222. self.identifiers.declared_locally.add(node.name)
  223. elif node.ctx == 'param':
  224. self.identifiers.declared_parameter.add(node.name)
  225. elif node.ctx == 'load' and not \
  226. self.identifiers.is_declared(node.name):
  227. self.identifiers.undeclared.add(node.name)
  228. def visit_If(self, node):
  229. self.visit(node.test)
  230. real_identifiers = self.identifiers
  231. old_names = real_identifiers.declared_locally | \
  232. real_identifiers.declared_parameter
  233. def inner_visit(nodes):
  234. if not nodes:
  235. return set()
  236. self.identifiers = real_identifiers.copy()
  237. for subnode in nodes:
  238. self.visit(subnode)
  239. rv = self.identifiers.declared_locally - old_names
  240. # we have to remember the undeclared variables of this branch
  241. # because we will have to pull them.
  242. real_identifiers.undeclared.update(self.identifiers.undeclared)
  243. self.identifiers = real_identifiers
  244. return rv
  245. body = inner_visit(node.body)
  246. else_ = inner_visit(node.else_ or ())
  247. # the differences between the two branches are also pulled as
  248. # undeclared variables
  249. real_identifiers.undeclared.update(body.symmetric_difference(else_) -
  250. real_identifiers.declared)
  251. # remember those that are declared.
  252. real_identifiers.declared_locally.update(body | else_)
  253. def visit_Macro(self, node):
  254. self.identifiers.declared_locally.add(node.name)
  255. def visit_Import(self, node):
  256. self.generic_visit(node)
  257. self.identifiers.declared_locally.add(node.target)
  258. def visit_FromImport(self, node):
  259. self.generic_visit(node)
  260. for name in node.names:
  261. if isinstance(name, tuple):
  262. self.identifiers.declared_locally.add(name[1])
  263. else:
  264. self.identifiers.declared_locally.add(name)
  265. def visit_Assign(self, node):
  266. """Visit assignments in the correct order."""
  267. self.visit(node.node)
  268. self.visit(node.target)
  269. def visit_For(self, node):
  270. """Visiting stops at for blocks. However the block sequence
  271. is visited as part of the outer scope.
  272. """
  273. self.visit(node.iter)
  274. def visit_CallBlock(self, node):
  275. self.visit(node.call)
  276. def visit_FilterBlock(self, node):
  277. self.visit(node.filter)
  278. def visit_Scope(self, node):
  279. """Stop visiting at scopes."""
  280. def visit_Block(self, node):
  281. """Stop visiting at blocks."""
  282. class CompilerExit(Exception):
  283. """Raised if the compiler encountered a situation where it just
  284. doesn't make sense to further process the code. Any block that
  285. raises such an exception is not further processed.
  286. """
  287. class CodeGenerator(NodeVisitor):
  288. def __init__(self, environment, name, filename, stream=None,
  289. defer_init=False):
  290. if stream is None:
  291. stream = NativeStringIO()
  292. self.environment = environment
  293. self.name = name
  294. self.filename = filename
  295. self.stream = stream
  296. self.created_block_context = False
  297. self.defer_init = defer_init
  298. # aliases for imports
  299. self.import_aliases = {}
  300. # a registry for all blocks. Because blocks are moved out
  301. # into the global python scope they are registered here
  302. self.blocks = {}
  303. # the number of extends statements so far
  304. self.extends_so_far = 0
  305. # some templates have a rootlevel extends. In this case we
  306. # can safely assume that we're a child template and do some
  307. # more optimizations.
  308. self.has_known_extends = False
  309. # the current line number
  310. self.code_lineno = 1
  311. # registry of all filters and tests (global, not block local)
  312. self.tests = {}
  313. self.filters = {}
  314. # the debug information
  315. self.debug_info = []
  316. self._write_debug_info = None
  317. # the number of new lines before the next write()
  318. self._new_lines = 0
  319. # the line number of the last written statement
  320. self._last_line = 0
  321. # true if nothing was written so far.
  322. self._first_write = True
  323. # used by the `temporary_identifier` method to get new
  324. # unique, temporary identifier
  325. self._last_identifier = 0
  326. # the current indentation
  327. self._indentation = 0
  328. # -- Various compilation helpers
  329. def fail(self, msg, lineno):
  330. """Fail with a :exc:`TemplateAssertionError`."""
  331. raise TemplateAssertionError(msg, lineno, self.name, self.filename)
  332. def temporary_identifier(self):
  333. """Get a new unique identifier."""
  334. self._last_identifier += 1
  335. return 't_%d' % self._last_identifier
  336. def buffer(self, frame):
  337. """Enable buffering for the frame from that point onwards."""
  338. frame.buffer = self.temporary_identifier()
  339. self.writeline('%s = []' % frame.buffer)
  340. def return_buffer_contents(self, frame):
  341. """Return the buffer contents of the frame."""
  342. if frame.eval_ctx.volatile:
  343. self.writeline('if context.eval_ctx.autoescape:')
  344. self.indent()
  345. self.writeline('return Markup(concat(%s))' % frame.buffer)
  346. self.outdent()
  347. self.writeline('else:')
  348. self.indent()
  349. self.writeline('return concat(%s)' % frame.buffer)
  350. self.outdent()
  351. elif frame.eval_ctx.autoescape:
  352. self.writeline('return Markup(concat(%s))' % frame.buffer)
  353. else:
  354. self.writeline('return concat(%s)' % frame.buffer)
  355. def indent(self):
  356. """Indent by one."""
  357. self._indentation += 1
  358. def outdent(self, step=1):
  359. """Outdent by step."""
  360. self._indentation -= step
  361. def start_write(self, frame, node=None):
  362. """Yield or write into the frame buffer."""
  363. if frame.buffer is None:
  364. self.writeline('yield ', node)
  365. else:
  366. self.writeline('%s.append(' % frame.buffer, node)
  367. def end_write(self, frame):
  368. """End the writing process started by `start_write`."""
  369. if frame.buffer is not None:
  370. self.write(')')
  371. def simple_write(self, s, frame, node=None):
  372. """Simple shortcut for start_write + write + end_write."""
  373. self.start_write(frame, node)
  374. self.write(s)
  375. self.end_write(frame)
  376. def blockvisit(self, nodes, frame):
  377. """Visit a list of nodes as block in a frame. If the current frame
  378. is no buffer a dummy ``if 0: yield None`` is written automatically
  379. unless the force_generator parameter is set to False.
  380. """
  381. if frame.buffer is None:
  382. self.writeline('if 0: yield None')
  383. else:
  384. self.writeline('pass')
  385. try:
  386. for node in nodes:
  387. self.visit(node, frame)
  388. except CompilerExit:
  389. pass
  390. def write(self, x):
  391. """Write a string into the output stream."""
  392. if self._new_lines:
  393. if not self._first_write:
  394. self.stream.write('\n' * self._new_lines)
  395. self.code_lineno += self._new_lines
  396. if self._write_debug_info is not None:
  397. self.debug_info.append((self._write_debug_info,
  398. self.code_lineno))
  399. self._write_debug_info = None
  400. self._first_write = False
  401. self.stream.write(' ' * self._indentation)
  402. self._new_lines = 0
  403. self.stream.write(x)
  404. def writeline(self, x, node=None, extra=0):
  405. """Combination of newline and write."""
  406. self.newline(node, extra)
  407. self.write(x)
  408. def newline(self, node=None, extra=0):
  409. """Add one or more newlines before the next write."""
  410. self._new_lines = max(self._new_lines, 1 + extra)
  411. if node is not None and node.lineno != self._last_line:
  412. self._write_debug_info = node.lineno
  413. self._last_line = node.lineno
  414. def signature(self, node, frame, extra_kwargs=None):
  415. """Writes a function call to the stream for the current node.
  416. A leading comma is added automatically. The extra keyword
  417. arguments may not include python keywords otherwise a syntax
  418. error could occour. The extra keyword arguments should be given
  419. as python dict.
  420. """
  421. # if any of the given keyword arguments is a python keyword
  422. # we have to make sure that no invalid call is created.
  423. kwarg_workaround = False
  424. for kwarg in chain((x.key for x in node.kwargs), extra_kwargs or ()):
  425. if is_python_keyword(kwarg):
  426. kwarg_workaround = True
  427. break
  428. for arg in node.args:
  429. self.write(', ')
  430. self.visit(arg, frame)
  431. if not kwarg_workaround:
  432. for kwarg in node.kwargs:
  433. self.write(', ')
  434. self.visit(kwarg, frame)
  435. if extra_kwargs is not None:
  436. for key, value in iteritems(extra_kwargs):
  437. self.write(', %s=%s' % (key, value))
  438. if node.dyn_args:
  439. self.write(', *')
  440. self.visit(node.dyn_args, frame)
  441. if kwarg_workaround:
  442. if node.dyn_kwargs is not None:
  443. self.write(', **dict({')
  444. else:
  445. self.write(', **{')
  446. for kwarg in node.kwargs:
  447. self.write('%r: ' % kwarg.key)
  448. self.visit(kwarg.value, frame)
  449. self.write(', ')
  450. if extra_kwargs is not None:
  451. for key, value in iteritems(extra_kwargs):
  452. self.write('%r: %s, ' % (key, value))
  453. if node.dyn_kwargs is not None:
  454. self.write('}, **')
  455. self.visit(node.dyn_kwargs, frame)
  456. self.write(')')
  457. else:
  458. self.write('}')
  459. elif node.dyn_kwargs is not None:
  460. self.write(', **')
  461. self.visit(node.dyn_kwargs, frame)
  462. def pull_locals(self, frame):
  463. """Pull all the references identifiers into the local scope."""
  464. for name in frame.identifiers.undeclared:
  465. self.writeline('l_%s = context.resolve(%r)' % (name, name))
  466. def pull_dependencies(self, nodes):
  467. """Pull all the dependencies."""
  468. visitor = DependencyFinderVisitor()
  469. for node in nodes:
  470. visitor.visit(node)
  471. for dependency in 'filters', 'tests':
  472. mapping = getattr(self, dependency)
  473. for name in getattr(visitor, dependency):
  474. if name not in mapping:
  475. mapping[name] = self.temporary_identifier()
  476. self.writeline('%s = environment.%s[%r]' %
  477. (mapping[name], dependency, name))
  478. def unoptimize_scope(self, frame):
  479. """Disable Python optimizations for the frame."""
  480. # XXX: this is not that nice but it has no real overhead. It
  481. # mainly works because python finds the locals before dead code
  482. # is removed. If that breaks we have to add a dummy function
  483. # that just accepts the arguments and does nothing.
  484. if frame.identifiers.declared:
  485. self.writeline('%sdummy(%s)' % (
  486. unoptimize_before_dead_code and 'if 0: ' or '',
  487. ', '.join('l_' + name for name in frame.identifiers.declared)
  488. ))
  489. def push_scope(self, frame, extra_vars=()):
  490. """This function returns all the shadowed variables in a dict
  491. in the form name: alias and will write the required assignments
  492. into the current scope. No indentation takes place.
  493. This also predefines locally declared variables from the loop
  494. body because under some circumstances it may be the case that
  495. `extra_vars` is passed to `Frame.find_shadowed`.
  496. """
  497. aliases = {}
  498. for name in frame.find_shadowed(extra_vars):
  499. aliases[name] = ident = self.temporary_identifier()
  500. self.writeline('%s = l_%s' % (ident, name))
  501. to_declare = set()
  502. for name in frame.identifiers.declared_locally:
  503. if name not in aliases:
  504. to_declare.add('l_' + name)
  505. if to_declare:
  506. self.writeline(' = '.join(to_declare) + ' = missing')
  507. return aliases
  508. def pop_scope(self, aliases, frame):
  509. """Restore all aliases and delete unused variables."""
  510. for name, alias in iteritems(aliases):
  511. self.writeline('l_%s = %s' % (name, alias))
  512. to_delete = set()
  513. for name in frame.identifiers.declared_locally:
  514. if name not in aliases:
  515. to_delete.add('l_' + name)
  516. if to_delete:
  517. # we cannot use the del statement here because enclosed
  518. # scopes can trigger a SyntaxError:
  519. # a = 42; b = lambda: a; del a
  520. self.writeline(' = '.join(to_delete) + ' = missing')
  521. def function_scoping(self, node, frame, children=None,
  522. find_special=True):
  523. """In Jinja a few statements require the help of anonymous
  524. functions. Those are currently macros and call blocks and in
  525. the future also recursive loops. As there is currently
  526. technical limitation that doesn't allow reading and writing a
  527. variable in a scope where the initial value is coming from an
  528. outer scope, this function tries to fall back with a common
  529. error message. Additionally the frame passed is modified so
  530. that the argumetns are collected and callers are looked up.
  531. This will return the modified frame.
  532. """
  533. # we have to iterate twice over it, make sure that works
  534. if children is None:
  535. children = node.iter_child_nodes()
  536. children = list(children)
  537. func_frame = frame.inner()
  538. func_frame.inspect(children)
  539. # variables that are undeclared (accessed before declaration) and
  540. # declared locally *and* part of an outside scope raise a template
  541. # assertion error. Reason: we can't generate reasonable code from
  542. # it without aliasing all the variables.
  543. # this could be fixed in Python 3 where we have the nonlocal
  544. # keyword or if we switch to bytecode generation
  545. overridden_closure_vars = (
  546. func_frame.identifiers.undeclared &
  547. func_frame.identifiers.declared &
  548. (func_frame.identifiers.declared_locally |
  549. func_frame.identifiers.declared_parameter)
  550. )
  551. if overridden_closure_vars:
  552. self.fail('It\'s not possible to set and access variables '
  553. 'derived from an outer scope! (affects: %s)' %
  554. ', '.join(sorted(overridden_closure_vars)), node.lineno)
  555. # remove variables from a closure from the frame's undeclared
  556. # identifiers.
  557. func_frame.identifiers.undeclared -= (
  558. func_frame.identifiers.undeclared &
  559. func_frame.identifiers.declared
  560. )
  561. # no special variables for this scope, abort early
  562. if not find_special:
  563. return func_frame
  564. func_frame.accesses_kwargs = False
  565. func_frame.accesses_varargs = False
  566. func_frame.accesses_caller = False
  567. func_frame.arguments = args = ['l_' + x.name for x in node.args]
  568. undeclared = find_undeclared(children, ('caller', 'kwargs', 'varargs'))
  569. if 'caller' in undeclared:
  570. func_frame.accesses_caller = True
  571. func_frame.identifiers.add_special('caller')
  572. args.append('l_caller')
  573. if 'kwargs' in undeclared:
  574. func_frame.accesses_kwargs = True
  575. func_frame.identifiers.add_special('kwargs')
  576. args.append('l_kwargs')
  577. if 'varargs' in undeclared:
  578. func_frame.accesses_varargs = True
  579. func_frame.identifiers.add_special('varargs')
  580. args.append('l_varargs')
  581. return func_frame
  582. def macro_body(self, node, frame, children=None):
  583. """Dump the function def of a macro or call block."""
  584. frame = self.function_scoping(node, frame, children)
  585. # macros are delayed, they never require output checks
  586. frame.require_output_check = False
  587. args = frame.arguments
  588. # XXX: this is an ugly fix for the loop nesting bug
  589. # (tests.test_old_bugs.test_loop_call_bug). This works around
  590. # a identifier nesting problem we have in general. It's just more
  591. # likely to happen in loops which is why we work around it. The
  592. # real solution would be "nonlocal" all the identifiers that are
  593. # leaking into a new python frame and might be used both unassigned
  594. # and assigned.
  595. if 'loop' in frame.identifiers.declared:
  596. args = args + ['l_loop=l_loop']
  597. self.writeline('def macro(%s):' % ', '.join(args), node)
  598. self.indent()
  599. self.buffer(frame)
  600. self.pull_locals(frame)
  601. self.blockvisit(node.body, frame)
  602. self.return_buffer_contents(frame)
  603. self.outdent()
  604. return frame
  605. def macro_def(self, node, frame):
  606. """Dump the macro definition for the def created by macro_body."""
  607. arg_tuple = ', '.join(repr(x.name) for x in node.args)
  608. name = getattr(node, 'name', None)
  609. if len(node.args) == 1:
  610. arg_tuple += ','
  611. self.write('Macro(environment, macro, %r, (%s), (' %
  612. (name, arg_tuple))
  613. for arg in node.defaults:
  614. self.visit(arg, frame)
  615. self.write(', ')
  616. self.write('), %r, %r, %r)' % (
  617. bool(frame.accesses_kwargs),
  618. bool(frame.accesses_varargs),
  619. bool(frame.accesses_caller)
  620. ))
  621. def position(self, node):
  622. """Return a human readable position for the node."""
  623. rv = 'line %d' % node.lineno
  624. if self.name is not None:
  625. rv += ' in ' + repr(self.name)
  626. return rv
  627. # -- Statement Visitors
  628. def visit_Template(self, node, frame=None):
  629. assert frame is None, 'no root frame allowed'
  630. eval_ctx = EvalContext(self.environment, self.name)
  631. from jinja2.runtime import __all__ as exported
  632. self.writeline('from __future__ import division')
  633. self.writeline('from jinja2.runtime import ' + ', '.join(exported))
  634. if not unoptimize_before_dead_code:
  635. self.writeline('dummy = lambda *x: None')
  636. # if we want a deferred initialization we cannot move the
  637. # environment into a local name
  638. envenv = not self.defer_init and ', environment=environment' or ''
  639. # do we have an extends tag at all? If not, we can save some
  640. # overhead by just not processing any inheritance code.
  641. have_extends = node.find(nodes.Extends) is not None
  642. # find all blocks
  643. for block in node.find_all(nodes.Block):
  644. if block.name in self.blocks:
  645. self.fail('block %r defined twice' % block.name, block.lineno)
  646. self.blocks[block.name] = block
  647. # find all imports and import them
  648. for import_ in node.find_all(nodes.ImportedName):
  649. if import_.importname not in self.import_aliases:
  650. imp = import_.importname
  651. self.import_aliases[imp] = alias = self.temporary_identifier()
  652. if '.' in imp:
  653. module, obj = imp.rsplit('.', 1)
  654. self.writeline('from %s import %s as %s' %
  655. (module, obj, alias))
  656. else:
  657. self.writeline('import %s as %s' % (imp, alias))
  658. # add the load name
  659. self.writeline('name = %r' % self.name)
  660. # generate the root render function.
  661. self.writeline('def root(context%s):' % envenv, extra=1)
  662. # process the root
  663. frame = Frame(eval_ctx)
  664. frame.inspect(node.body)
  665. frame.toplevel = frame.rootlevel = True
  666. frame.require_output_check = have_extends and not self.has_known_extends
  667. self.indent()
  668. if have_extends:
  669. self.writeline('parent_template = None')
  670. if 'self' in find_undeclared(node.body, ('self',)):
  671. frame.identifiers.add_special('self')
  672. self.writeline('l_self = TemplateReference(context)')
  673. self.pull_locals(frame)
  674. self.pull_dependencies(node.body)
  675. self.blockvisit(node.body, frame)
  676. self.outdent()
  677. # make sure that the parent root is called.
  678. if have_extends:
  679. if not self.has_known_extends:
  680. self.indent()
  681. self.writeline('if parent_template is not None:')
  682. self.indent()
  683. self.writeline('for event in parent_template.'
  684. 'root_render_func(context):')
  685. self.indent()
  686. self.writeline('yield event')
  687. self.outdent(2 + (not self.has_known_extends))
  688. # at this point we now have the blocks collected and can visit them too.
  689. for name, block in iteritems(self.blocks):
  690. block_frame = Frame(eval_ctx)
  691. block_frame.inspect(block.body)
  692. block_frame.block = name
  693. self.writeline('def block_%s(context%s):' % (name, envenv),
  694. block, 1)
  695. self.indent()
  696. undeclared = find_undeclared(block.body, ('self', 'super'))
  697. if 'self' in undeclared:
  698. block_frame.identifiers.add_special('self')
  699. self.writeline('l_self = TemplateReference(context)')
  700. if 'super' in undeclared:
  701. block_frame.identifiers.add_special('super')
  702. self.writeline('l_super = context.super(%r, '
  703. 'block_%s)' % (name, name))
  704. self.pull_locals(block_frame)
  705. self.pull_dependencies(block.body)
  706. self.blockvisit(block.body, block_frame)
  707. self.outdent()
  708. self.writeline('blocks = {%s}' % ', '.join('%r: block_%s' % (x, x)
  709. for x in self.blocks),
  710. extra=1)
  711. # add a function that returns the debug info
  712. self.writeline('debug_info = %r' % '&'.join('%s=%s' % x for x
  713. in self.debug_info))
  714. def visit_Block(self, node, frame):
  715. """Call a block and register it for the template."""
  716. level = 1
  717. if frame.toplevel:
  718. # if we know that we are a child template, there is no need to
  719. # check if we are one
  720. if self.has_known_extends:
  721. return
  722. if self.extends_so_far > 0:
  723. self.writeline('if parent_template is None:')
  724. self.indent()
  725. level += 1
  726. context = node.scoped and 'context.derived(locals())' or 'context'
  727. self.writeline('for event in context.blocks[%r][0](%s):' % (
  728. node.name, context), node)
  729. self.indent()
  730. self.simple_write('event', frame)
  731. self.outdent(level)
  732. def visit_Extends(self, node, frame):
  733. """Calls the extender."""
  734. if not frame.toplevel:
  735. self.fail('cannot use extend from a non top-level scope',
  736. node.lineno)
  737. # if the number of extends statements in general is zero so
  738. # far, we don't have to add a check if something extended
  739. # the template before this one.
  740. if self.extends_so_far > 0:
  741. # if we have a known extends we just add a template runtime
  742. # error into the generated code. We could catch that at compile
  743. # time too, but i welcome it not to confuse users by throwing the
  744. # same error at different times just "because we can".
  745. if not self.has_known_extends:
  746. self.writeline('if parent_template is not None:')
  747. self.indent()
  748. self.writeline('raise TemplateRuntimeError(%r)' %
  749. 'extended multiple times')
  750. # if we have a known extends already we don't need that code here
  751. # as we know that the template execution will end here.
  752. if self.has_known_extends:
  753. raise CompilerExit()
  754. else:
  755. self.outdent()
  756. self.writeline('parent_template = environment.get_template(', node)
  757. self.visit(node.template, frame)
  758. self.write(', %r)' % self.name)
  759. self.writeline('for name, parent_block in parent_template.'
  760. 'blocks.%s():' % dict_item_iter)
  761. self.indent()
  762. self.writeline('context.blocks.setdefault(name, []).'
  763. 'append(parent_block)')
  764. self.outdent()
  765. # if this extends statement was in the root level we can take
  766. # advantage of that information and simplify the generated code
  767. # in the top level from this point onwards
  768. if frame.rootlevel:
  769. self.has_known_extends = True
  770. # and now we have one more
  771. self.extends_so_far += 1
  772. def visit_Include(self, node, frame):
  773. """Handles includes."""
  774. if node.with_context:
  775. self.unoptimize_scope(frame)
  776. if node.ignore_missing:
  777. self.writeline('try:')
  778. self.indent()
  779. func_name = 'get_or_select_template'
  780. if isinstance(node.template, nodes.Const):
  781. if isinstance(node.template.value, string_types):
  782. func_name = 'get_template'
  783. elif isinstance(node.template.value, (tuple, list)):
  784. func_name = 'select_template'
  785. elif isinstance(node.template, (nodes.Tuple, nodes.List)):
  786. func_name = 'select_template'
  787. self.writeline('template = environment.%s(' % func_name, node)
  788. self.visit(node.template, frame)
  789. self.write(', %r)' % self.name)
  790. if node.ignore_missing:
  791. self.outdent()
  792. self.writeline('except TemplateNotFound:')
  793. self.indent()
  794. self.writeline('pass')
  795. self.outdent()
  796. self.writeline('else:')
  797. self.indent()
  798. if node.with_context:
  799. self.writeline('for event in template.root_render_func('
  800. 'template.new_context(context.parent, True, '
  801. 'locals())):')
  802. else:
  803. self.writeline('for event in template.module._body_stream:')
  804. self.indent()
  805. self.simple_write('event', frame)
  806. self.outdent()
  807. if node.ignore_missing:
  808. self.outdent()
  809. def visit_Import(self, node, frame):
  810. """Visit regular imports."""
  811. if node.with_context:
  812. self.unoptimize_scope(frame)
  813. self.writeline('l_%s = ' % node.target, node)
  814. if frame.toplevel:
  815. self.write('context.vars[%r] = ' % node.target)
  816. self.write('environment.get_template(')
  817. self.visit(node.template, frame)
  818. self.write(', %r).' % self.name)
  819. if node.with_context:
  820. self.write('make_module(context.parent, True, locals())')
  821. else:
  822. self.write('module')
  823. if frame.toplevel and not node.target.startswith('_'):
  824. self.writeline('context.exported_vars.discard(%r)' % node.target)
  825. frame.assigned_names.add(node.target)
  826. def visit_FromImport(self, node, frame):
  827. """Visit named imports."""
  828. self.newline(node)
  829. self.write('included_template = environment.get_template(')
  830. self.visit(node.template, frame)
  831. self.write(', %r).' % self.name)
  832. if node.with_context:
  833. self.write('make_module(context.parent, True)')
  834. else:
  835. self.write('module')
  836. var_names = []
  837. discarded_names = []
  838. for name in node.names:
  839. if isinstance(name, tuple):
  840. name, alias = name
  841. else:
  842. alias = name
  843. self.writeline('l_%s = getattr(included_template, '
  844. '%r, missing)' % (alias, name))
  845. self.writeline('if l_%s is missing:' % alias)
  846. self.indent()
  847. self.writeline('l_%s = environment.undefined(%r %% '
  848. 'included_template.__name__, '
  849. 'name=%r)' %
  850. (alias, 'the template %%r (imported on %s) does '
  851. 'not export the requested name %s' % (
  852. self.position(node),
  853. repr(name)
  854. ), name))
  855. self.outdent()
  856. if frame.toplevel:
  857. var_names.append(alias)
  858. if not alias.startswith('_'):
  859. discarded_names.append(alias)
  860. frame.assigned_names.add(alias)
  861. if var_names:
  862. if len(var_names) == 1:
  863. name = var_names[0]
  864. self.writeline('context.vars[%r] = l_%s' % (name, name))
  865. else:
  866. self.writeline('context.vars.update({%s})' % ', '.join(
  867. '%r: l_%s' % (name, name) for name in var_names
  868. ))
  869. if discarded_names:
  870. if len(discarded_names) == 1:
  871. self.writeline('context.exported_vars.discard(%r)' %
  872. discarded_names[0])
  873. else:
  874. self.writeline('context.exported_vars.difference_'
  875. 'update((%s))' % ', '.join(imap(repr, discarded_names)))
  876. def visit_For(self, node, frame):
  877. # when calculating the nodes for the inner frame we have to exclude
  878. # the iterator contents from it
  879. children = node.iter_child_nodes(exclude=('iter',))
  880. if node.recursive:
  881. loop_frame = self.function_scoping(node, frame, children,
  882. find_special=False)
  883. else:
  884. loop_frame = frame.inner()
  885. loop_frame.inspect(children)
  886. # try to figure out if we have an extended loop. An extended loop
  887. # is necessary if the loop is in recursive mode if the special loop
  888. # variable is accessed in the body.
  889. extended_loop = node.recursive or 'loop' in \
  890. find_undeclared(node.iter_child_nodes(
  891. only=('body',)), ('loop',))
  892. # if we don't have an recursive loop we have to find the shadowed
  893. # variables at that point. Because loops can be nested but the loop
  894. # variable is a special one we have to enforce aliasing for it.
  895. if not node.recursive:
  896. aliases = self.push_scope(loop_frame, ('loop',))
  897. # otherwise we set up a buffer and add a function def
  898. else:
  899. self.writeline('def loop(reciter, loop_render_func, depth=0):', node)
  900. self.indent()
  901. self.buffer(loop_frame)
  902. aliases = {}
  903. # make sure the loop variable is a special one and raise a template
  904. # assertion error if a loop tries to write to loop
  905. if extended_loop:
  906. self.writeline('l_loop = missing')
  907. loop_frame.identifiers.add_special('loop')
  908. for name in node.find_all(nodes.Name):
  909. if name.ctx == 'store' and name.name == 'loop':
  910. self.fail('Can\'t assign to special loop variable '
  911. 'in for-loop target', name.lineno)
  912. self.pull_locals(loop_frame)
  913. if node.else_:
  914. iteration_indicator = self.temporary_identifier()
  915. self.writeline('%s = 1' % iteration_indicator)
  916. # Create a fake parent loop if the else or test section of a
  917. # loop is accessing the special loop variable and no parent loop
  918. # exists.
  919. if 'loop' not in aliases and 'loop' in find_undeclared(
  920. node.iter_child_nodes(only=('else_', 'test')), ('loop',)):
  921. self.writeline("l_loop = environment.undefined(%r, name='loop')" %
  922. ("'loop' is undefined. the filter section of a loop as well "
  923. "as the else block don't have access to the special 'loop'"
  924. " variable of the current loop. Because there is no parent "
  925. "loop it's undefined. Happened in loop on %s" %
  926. self.position(node)))
  927. self.writeline('for ', node)
  928. self.visit(node.target, loop_frame)
  929. self.write(extended_loop and ', l_loop in LoopContext(' or ' in ')
  930. # if we have an extened loop and a node test, we filter in the
  931. # "outer frame".
  932. if extended_loop and node.test is not None:
  933. self.write('(')
  934. self.visit(node.target, loop_frame)
  935. self.write(' for ')
  936. self.visit(node.target, loop_frame)
  937. self.write(' in ')
  938. if node.recursive:
  939. self.write('reciter')
  940. else:
  941. self.visit(node.iter, loop_frame)
  942. self.write(' if (')
  943. test_frame = loop_frame.copy()
  944. self.visit(node.test, test_frame)
  945. self.write('))')
  946. elif node.recursive:
  947. self.write('reciter')
  948. else:
  949. self.visit(node.iter, loop_frame)
  950. if node.recursive:
  951. self.write(', loop_render_func, depth):')
  952. else:
  953. self.write(extended_loop and '):' or ':')
  954. # tests in not extended loops become a continue
  955. if not extended_loop and node.test is not None:
  956. self.indent()
  957. self.writeline('if not ')
  958. self.visit(node.test, loop_frame)
  959. self.write(':')
  960. self.indent()
  961. self.writeline('continue')
  962. self.outdent(2)
  963. self.indent()
  964. self.blockvisit(node.body, loop_frame)
  965. if node.else_:
  966. self.writeline('%s = 0' % iteration_indicator)
  967. self.outdent()
  968. if node.else_:
  969. self.writeline('if %s:' % iteration_indicator)
  970. self.indent()
  971. self.blockvisit(node.else_, loop_frame)
  972. self.outdent()
  973. # reset the aliases if there are any.
  974. if not node.recursive:
  975. self.pop_scope(aliases, loop_frame)
  976. # if the node was recursive we have to return the buffer contents
  977. # and start the iteration code
  978. if node.recursive:
  979. self.return_buffer_contents(loop_frame)
  980. self.outdent()
  981. self.start_write(frame, node)
  982. self.write('loop(')
  983. self.visit(node.iter, frame)
  984. self.write(', loop)')
  985. self.end_write(frame)
  986. def visit_If(self, node, frame):
  987. if_frame = frame.soft()
  988. self.writeline('if ', node)
  989. self.visit(node.test, if_frame)
  990. self.write(':')
  991. self.indent()
  992. self.blockvisit(node.body, if_frame)
  993. self.outdent()
  994. if node.else_:
  995. self.writeline('else:')
  996. self.indent()
  997. self.blockvisit(node.else_, if_frame)
  998. self.outdent()
  999. def visit_Macro(self, node, frame):
  1000. macro_frame = self.macro_body(node, frame)
  1001. self.newline()
  1002. if frame.toplevel:
  1003. if not node.name.startswith('_'):
  1004. self.write('context.exported_vars.add(%r)' % node.name)
  1005. self.writeline('context.vars[%r] = ' % node.name)
  1006. self.write('l_%s = ' % node.name)
  1007. self.macro_def(node, macro_frame)
  1008. frame.assigned_names.add(node.name)
  1009. def visit_CallBlock(self, node, frame):
  1010. children = node.iter_child_nodes(exclude=('call',))
  1011. call_frame = self.macro_body(node, frame, children)
  1012. self.writeline('caller = ')
  1013. self.macro_def(node, call_frame)
  1014. self.start_write(frame, node)
  1015. self.visit_Call(node.call, call_frame, forward_caller=True)
  1016. self.end_write(frame)
  1017. def visit_FilterBlock(self, node, frame):
  1018. filter_frame = frame.inner()
  1019. filter_frame.inspect(node.iter_child_nodes())
  1020. aliases = self.push_scope(filter_frame)
  1021. self.pull_locals(filter_frame)
  1022. self.buffer(filter_frame)
  1023. self.blockvisit(node.body, filter_frame)
  1024. self.start_write(frame, node)
  1025. self.visit_Filter(node.filter, filter_frame)
  1026. self.end_write(frame)
  1027. self.pop_scope(aliases, filter_frame)
  1028. def visit_ExprStmt(self, node, frame):
  1029. self.newline(node)
  1030. self.visit(node.node, frame)
  1031. def visit_Output(self, node, frame):
  1032. # if we have a known extends statement, we don't output anything
  1033. # if we are in a require_output_check section
  1034. if self.has_known_extends and frame.require_output_check:
  1035. return
  1036. if self.environment.finalize:
  1037. finalize = lambda x: text_type(self.environment.finalize(x))
  1038. else:
  1039. finalize = text_type
  1040. # if we are inside a frame that requires output checking, we do so
  1041. outdent_later = False
  1042. if frame.require_output_check:
  1043. self.writeline('if parent_template is None:')
  1044. self.indent()
  1045. outdent_later = True
  1046. # try to evaluate as many chunks as possible into a static
  1047. # string at compile time.
  1048. body = []
  1049. for child in node.nodes:
  1050. try:
  1051. const = child.as_const(frame.eval_ctx)
  1052. except nodes.Impossible:
  1053. body.append(child)
  1054. continue
  1055. # the frame can't be volatile here, becaus otherwise the
  1056. # as_const() function would raise an Impossible exception
  1057. # at that point.
  1058. try:
  1059. if frame.eval_ctx.autoescape:
  1060. if hasattr(const, '__html__'):
  1061. const = const.__html__()
  1062. else:
  1063. const = escape(const)
  1064. const = finalize(const)
  1065. except Exception:
  1066. # if something goes wrong here we evaluate the node
  1067. # at runtime for easier debugging
  1068. body.append(child)
  1069. continue
  1070. if body and isinstance(body[-1], list):
  1071. body[-1].append(const)
  1072. else:
  1073. body.append([const])
  1074. # if we have less than 3 nodes or a buffer we yield or extend/append
  1075. if len(body) < 3 or frame.buffer is not None:
  1076. if frame.buffer is not None:
  1077. # for one item we append, for more we extend
  1078. if len(body) == 1:
  1079. self.writeline('%s.append(' % frame.buffer)
  1080. else:
  1081. self.writeline('%s.extend((' % frame.buffer)
  1082. self.indent()
  1083. for item in body:
  1084. if isinstance(item, list):
  1085. val = repr(concat(item))
  1086. if frame.buffer is None:
  1087. self.writeline('yield ' + val)
  1088. else:
  1089. self.writeline(val + ', ')
  1090. else:
  1091. if frame.buffer is None:
  1092. self.writeline('yield ', item)
  1093. else:
  1094. self.newline(item)
  1095. close = 1
  1096. if frame.eval_ctx.volatile:
  1097. self.write('(context.eval_ctx.autoescape and'
  1098. ' escape or to_string)(')
  1099. elif frame.eval_ctx.autoescape:
  1100. self.write('escape(')
  1101. else:
  1102. self.write('to_string(')
  1103. if self.environment.finalize is not None:
  1104. self.write('environment.finalize(')
  1105. close += 1
  1106. self.visit(item, frame)
  1107. self.write(')' * close)
  1108. if frame.buffer is not None:
  1109. self.write(', ')
  1110. if frame.buffer is not None:
  1111. # close the open parentheses
  1112. self.outdent()
  1113. self.writeline(len(body) == 1 and ')' or '))')
  1114. # otherwise we create a format string as this is faster in that case
  1115. else:
  1116. format = []
  1117. arguments = []
  1118. for item in body:
  1119. if isinstance(item, list):
  1120. format.append(concat(item).replace('%', '%%'))
  1121. else:
  1122. format.append('%s')
  1123. arguments.append(item)
  1124. self.writeline('yield ')
  1125. self.write(repr(concat(format)) + ' % (')
  1126. idx = -1
  1127. self.indent()
  1128. for argument in arguments:
  1129. self.newline(argument)
  1130. close = 0
  1131. if frame.eval_ctx.volatile:
  1132. self.write('(context.eval_ctx.autoescape and'
  1133. ' escape or to_string)(')
  1134. close += 1
  1135. elif frame.eval_ctx.autoescape:
  1136. self.write('escape(')
  1137. close += 1
  1138. if self.environment.finalize is not None:
  1139. self.write('environment.finalize(')
  1140. close += 1
  1141. self.visit(argument, frame)
  1142. self.write(')' * close + ', ')
  1143. self.outdent()
  1144. self.writeline(')')
  1145. if outdent_later:
  1146. self.outdent()
  1147. def visit_Assign(self, node, frame):
  1148. self.newline(node)
  1149. # toplevel assignments however go into the local namespace and
  1150. # the current template's context. We create a copy of the frame
  1151. # here and add a set so that the Name visitor can add the assigned
  1152. # names here.
  1153. if frame.toplevel:
  1154. assignment_frame = frame.copy()
  1155. assignment_frame.toplevel_assignments = set()
  1156. else:
  1157. assignment_frame = frame
  1158. self.visit(node.target, assignment_frame)
  1159. self.write(' = ')
  1160. self.visit(node.node, frame)
  1161. # make sure toplevel assignments are added to the context.
  1162. if frame.toplevel:
  1163. public_names = [x for x in assignment_frame.toplevel_assignments
  1164. if not x.startswith('_')]
  1165. if len(assignment_frame.toplevel_assignments) == 1:
  1166. name = next(iter(assignment_frame.toplevel_assignments))
  1167. self.writeline('context.vars[%r] = l_%s' % (name, name))
  1168. else:
  1169. self.writeline('context.vars.update({')
  1170. for idx, name in enumerate(assignment_frame.toplevel_assignments):
  1171. if idx:
  1172. self.write(', ')
  1173. self.write('%r: l_%s' % (name, name))
  1174. self.write('})')
  1175. if public_names:
  1176. if len(public_names) == 1:
  1177. self.writeline('context.exported_vars.add(%r)' %
  1178. public_names[0])
  1179. else:
  1180. self.writeline('context.exported_vars.update((%s))' %
  1181. ', '.join(imap(repr, public_names)))
  1182. # -- Expression Visitors
  1183. def visit_Name(self, node, frame):
  1184. if node.ctx == 'store' and frame.toplevel:
  1185. frame.toplevel_assignments.add(node.name)
  1186. self.write('l_' + node.name)
  1187. frame.assigned_names.add(node.name)
  1188. def visit_Const(self, node, frame):
  1189. val = node.value
  1190. if isinstance(val, float):
  1191. self.write(str(val))
  1192. else:
  1193. self.write(repr(val))
  1194. def visit_TemplateData(self, node, frame):
  1195. try:
  1196. self.write(repr(node.as_const(frame.eval_ctx)))
  1197. except nodes.Impossible:
  1198. self.write('(context.eval_ctx.autoescape and Markup or identity)(%r)'
  1199. % node.data)
  1200. def visit_Tuple(self, node, frame):
  1201. self.write('(')
  1202. idx = -1
  1203. for idx, item in enumerate(node.items):
  1204. if idx:
  1205. self.write(', ')
  1206. self.visit(item, frame)
  1207. self.write(idx == 0 and ',)' or ')')
  1208. def visit_List(self, node, frame):
  1209. self.write('[')
  1210. for idx, item in enumerate(node.items):
  1211. if idx:
  1212. self.write(', ')
  1213. self.visit(item, frame)
  1214. self.write(']')
  1215. def visit_Dict(self, node, frame):
  1216. self.write('{')
  1217. for idx, item in enumerate(node.items):
  1218. if idx:
  1219. self.write(', ')
  1220. self.visit(item.key, frame)
  1221. self.write(': ')
  1222. self.visit(item.value, frame)
  1223. self.write('}')
  1224. def binop(operator, interceptable=True):
  1225. def visitor(self, node, frame):
  1226. if self.environment.sandboxed and \
  1227. operator in self.environment.intercepted_binops:
  1228. self.write('environment.call_binop(context, %r, ' % operator)
  1229. self.visit(node.left, frame)
  1230. self.write(', ')
  1231. self.visit(node.right, frame)
  1232. else:
  1233. self.write('(')
  1234. self.visit(node.left, frame)
  1235. self.write(' %s ' % operator)
  1236. self.visit(node.right, frame)
  1237. self.write(')')
  1238. return visitor
  1239. def uaop(operator, interceptable=True):
  1240. def visitor(self, node, frame):
  1241. if self.environment.sandboxed and \
  1242. operator in self.environment.intercepted_unops:
  1243. self.write('environment.call_unop(context, %r, ' % operator)
  1244. self.visit(node.node, frame)
  1245. else:
  1246. self.write('(' + operator)
  1247. self.visit(node.node, frame)
  1248. self.write(')')
  1249. return visitor
  1250. visit_Add = binop('+')
  1251. visit_Sub = binop('-')
  1252. visit_Mul = binop('*')
  1253. visit_Div = binop('/')
  1254. visit_FloorDiv = binop('//')
  1255. visit_Pow = binop('**')
  1256. visit_Mod = binop('%')
  1257. visit_And = binop('and', interceptable=False)
  1258. visit_Or = binop('or', interceptable=False)
  1259. visit_Pos = uaop('+')
  1260. visit_Neg = uaop('-')
  1261. visit_Not = uaop('not ', interceptable=False)
  1262. del binop, uaop
  1263. def visit_Concat(self, node, frame):
  1264. if frame.eval_ctx.volatile:
  1265. func_name = '(context.eval_ctx.volatile and' \
  1266. ' markup_join or unicode_join)'
  1267. elif frame.eval_ctx.autoescape:
  1268. func_name = 'markup_join'
  1269. else:
  1270. func_name = 'unicode_join'
  1271. self.write('%s((' % func_name)
  1272. for arg in node.nodes:
  1273. self.visit(arg, frame)
  1274. self.write(', ')
  1275. self.write('))')
  1276. def visit_Compare(self, node, frame):
  1277. self.visit(node.expr, frame)
  1278. for op in node.ops:
  1279. self.visit(op, frame)
  1280. def visit_Operand(self, node, frame):
  1281. self.write(' %s ' % operators[node.op])
  1282. self.visit(node.expr, frame)
  1283. def visit_Getattr(self, node, frame):
  1284. self.write('environment.getattr(')
  1285. self.visit(node.node, frame)
  1286. self.write(', %r)' % node.attr)
  1287. def visit_Getitem(self, node, frame):
  1288. # slices bypass the environment getitem method.
  1289. if isinstance(node.arg, nodes.Slice):
  1290. self.visit(node.node, frame)
  1291. self.write('[')
  1292. self.visit(node.arg, frame)
  1293. self.write(']')
  1294. else:
  1295. self.write('environment.getitem(')
  1296. self.visit(node.node, frame)
  1297. self.write(', ')
  1298. self.visit(node.arg, frame)
  1299. self.write(')')
  1300. def visit_Slice(self, node, frame):
  1301. if node.start is not None:
  1302. self.visit(node.start, frame)
  1303. self.write(':')
  1304. if node.stop is not None:
  1305. self.visit(node.stop, frame)
  1306. if node.step is not None:
  1307. self.write(':')
  1308. self.visit(node.step, frame)
  1309. def visit_Filter(self, node, frame):
  1310. self.write(self.filters[node.name] + '(')
  1311. func = self.environment.filters.get(node.name)
  1312. if func is None:
  1313. self.fail('no filter named %r' % node.name, node.lineno)
  1314. if getattr(func, 'contextfilter', False):
  1315. self.write('context, ')
  1316. elif getattr(func, 'evalcontextfilter', False):
  1317. self.write('context.eval_ctx, ')
  1318. elif getattr(func, 'environmentfilter', False):
  1319. self.write('environment, ')
  1320. # if the filter node is None we are inside a filter block
  1321. # and want to write to the current buffer
  1322. if node.node is not None:
  1323. self.visit(node.node, frame)
  1324. elif frame.eval_ctx.volatile:
  1325. self.write('(context.eval_ctx.autoescape and'
  1326. ' Markup(concat(%s)) or concat(%s))' %
  1327. (frame.buffer, frame.buffer))
  1328. elif frame.eval_ctx.autoescape:
  1329. self.write('Markup(concat(%s))' % frame.buffer)
  1330. else:
  1331. self.write('concat(%s)' % frame.buffer)
  1332. self.signature(node, frame)
  1333. self.write(')')
  1334. def visit_Test(self, node, frame):
  1335. self.write(self.tests[node.name] + '(')
  1336. if node.name not in self.environment.tests:
  1337. self.fail('no test named %r' % node.name, node.lineno)
  1338. self.visit(node.node, frame)
  1339. self.signature(node, frame)
  1340. self.write(')')
  1341. def visit_CondExpr(self, node, frame):
  1342. def write_expr2():
  1343. if node.expr2 is not None:
  1344. return self.visit(node.expr2, frame)
  1345. self.write('environment.undefined(%r)' % ('the inline if-'
  1346. 'expression on %s evaluated to false and '
  1347. 'no else section was defined.' % self.position(node)))
  1348. self.write('(')
  1349. self.visit(node.expr1, frame)
  1350. self.write(' if ')
  1351. self.visit(node.test, frame)
  1352. self.write(' else ')
  1353. write_expr2()
  1354. self.write(')')
  1355. def visit_Call(self, node, frame, forward_caller=False):
  1356. if self.environment.sandboxed:
  1357. self.write('environment.call(context, ')
  1358. else:
  1359. self.write('context.call(')
  1360. self.visit(node.node, frame)
  1361. extra_kwargs = forward_caller and {'caller': 'caller'} or None
  1362. self.signature(node, frame, extra_kwargs)
  1363. self.write(')')
  1364. def visit_Keyword(self, node, frame):
  1365. self.write(node.key + '=')
  1366. self.visit(node.value, frame)
  1367. # -- Unused nodes for extensions
  1368. def visit_MarkSafe(self, node, frame):
  1369. self.write('Markup(')
  1370. self.visit(node.expr, frame)
  1371. self.write(')')
  1372. def visit_MarkSafeIfAutoescape(self, node, frame):
  1373. self.write('(context.eval_ctx.autoescape and Markup or identity)(')
  1374. self.visit(node.expr, frame)
  1375. self.write(')')
  1376. def visit_EnvironmentAttribute(self, node, frame):
  1377. self.write('environment.' + node.name)
  1378. def visit_ExtensionAttribute(self, node, frame):
  1379. self.write('environment.extensions[%r].%s' % (node.identifier, node.name))
  1380. def visit_ImportedName(self, node, frame):
  1381. self.write(self.import_aliases[node.importname])
  1382. def visit_InternalName(self, node, frame):
  1383. self.write(node.name)
  1384. def visit_ContextReference(self, node, frame):
  1385. self.write('context')
  1386. def visit_Continue(self, node, frame):
  1387. self.writeline('continue', node)
  1388. def visit_Break(self, node, frame):
  1389. self.writeline('break', node)
  1390. def visit_Scope(self, node, frame):
  1391. scope_frame = frame.inner()
  1392. scope_frame.inspect(node.iter_child_nodes())
  1393. aliases = self.push_scope(scope_frame)
  1394. self.pull_locals(scope_frame)
  1395. self.blockvisit(node.body, scope_frame)
  1396. self.pop_scope(aliases, scope_frame)
  1397. def visit_EvalContextModifier(self, node, frame):
  1398. for keyword in node.options:
  1399. self.writeline('context.eval_ctx.%s = ' % keyword.key)
  1400. self.visit(keyword.value, frame)
  1401. try:
  1402. val = keyword.value.as_const(frame.eval_ctx)
  1403. except nodes.Impossible:
  1404. frame.eval_ctx.volatile = True
  1405. else:
  1406. setattr(frame.eval_ctx, keyword.key, val)
  1407. def visit_ScopedEvalContextModifier(self, node, frame):
  1408. old_ctx_name = self.temporary_identifier()
  1409. safed_ctx = frame.eval_ctx.save()
  1410. self.writeline('%s = context.eval_ctx.save()' % old_ctx_name)
  1411. self.visit_EvalContextModifier(node, frame)
  1412. for child in node.body:
  1413. self.visit(child, frame)
  1414. frame.eval_ctx.revert(safed_ctx)
  1415. self.writeline('context.eval_ctx.revert(%s)' % old_ctx_name)