codegen.py 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209
  1. # mako/codegen.py
  2. # Copyright (C) 2006-2012 the Mako authors and contributors <see AUTHORS file>
  3. #
  4. # This module is part of Mako and is released under
  5. # the MIT License: http://www.opensource.org/licenses/mit-license.php
  6. """provides functionality for rendering a parsetree constructing into module
  7. source code."""
  8. import time
  9. import re
  10. from mako.pygen import PythonPrinter
  11. from mako import util, ast, parsetree, filters, exceptions
  12. MAGIC_NUMBER = 8
  13. # names which are hardwired into the
  14. # template and are not accessed via the
  15. # context itself
  16. RESERVED_NAMES = set(['context', 'loop', 'UNDEFINED'])
  17. def compile(node,
  18. uri,
  19. filename=None,
  20. default_filters=None,
  21. buffer_filters=None,
  22. imports=None,
  23. source_encoding=None,
  24. generate_magic_comment=True,
  25. disable_unicode=False,
  26. strict_undefined=False,
  27. enable_loop=True,
  28. reserved_names=()):
  29. """Generate module source code given a parsetree node,
  30. uri, and optional source filename"""
  31. # if on Py2K, push the "source_encoding" string to be
  32. # a bytestring itself, as we will be embedding it into
  33. # the generated source and we don't want to coerce the
  34. # result into a unicode object, in "disable_unicode" mode
  35. if not util.py3k and isinstance(source_encoding, unicode):
  36. source_encoding = source_encoding.encode(source_encoding)
  37. buf = util.FastEncodingBuffer()
  38. printer = PythonPrinter(buf)
  39. _GenerateRenderMethod(printer,
  40. _CompileContext(uri,
  41. filename,
  42. default_filters,
  43. buffer_filters,
  44. imports,
  45. source_encoding,
  46. generate_magic_comment,
  47. disable_unicode,
  48. strict_undefined,
  49. enable_loop,
  50. reserved_names),
  51. node)
  52. return buf.getvalue()
  53. class _CompileContext(object):
  54. def __init__(self,
  55. uri,
  56. filename,
  57. default_filters,
  58. buffer_filters,
  59. imports,
  60. source_encoding,
  61. generate_magic_comment,
  62. disable_unicode,
  63. strict_undefined,
  64. enable_loop,
  65. reserved_names):
  66. self.uri = uri
  67. self.filename = filename
  68. self.default_filters = default_filters
  69. self.buffer_filters = buffer_filters
  70. self.imports = imports
  71. self.source_encoding = source_encoding
  72. self.generate_magic_comment = generate_magic_comment
  73. self.disable_unicode = disable_unicode
  74. self.strict_undefined = strict_undefined
  75. self.enable_loop = enable_loop
  76. self.reserved_names = reserved_names
  77. class _GenerateRenderMethod(object):
  78. """A template visitor object which generates the
  79. full module source for a template.
  80. """
  81. def __init__(self, printer, compiler, node):
  82. self.printer = printer
  83. self.last_source_line = -1
  84. self.compiler = compiler
  85. self.node = node
  86. self.identifier_stack = [None]
  87. self.in_def = isinstance(node, (parsetree.DefTag, parsetree.BlockTag))
  88. if self.in_def:
  89. name = "render_%s" % node.funcname
  90. args = node.get_argument_expressions()
  91. filtered = len(node.filter_args.args) > 0
  92. buffered = eval(node.attributes.get('buffered', 'False'))
  93. cached = eval(node.attributes.get('cached', 'False'))
  94. defs = None
  95. pagetag = None
  96. if node.is_block and not node.is_anonymous:
  97. args += ['**pageargs']
  98. else:
  99. defs = self.write_toplevel()
  100. pagetag = self.compiler.pagetag
  101. name = "render_body"
  102. if pagetag is not None:
  103. args = pagetag.body_decl.get_argument_expressions()
  104. if not pagetag.body_decl.kwargs:
  105. args += ['**pageargs']
  106. cached = eval(pagetag.attributes.get('cached', 'False'))
  107. self.compiler.enable_loop = self.compiler.enable_loop or eval(
  108. pagetag.attributes.get(
  109. 'enable_loop', 'False')
  110. )
  111. else:
  112. args = ['**pageargs']
  113. cached = False
  114. buffered = filtered = False
  115. if args is None:
  116. args = ['context']
  117. else:
  118. args = [a for a in ['context'] + args]
  119. self.write_render_callable(
  120. pagetag or node,
  121. name, args,
  122. buffered, filtered, cached)
  123. if defs is not None:
  124. for node in defs:
  125. _GenerateRenderMethod(printer, compiler, node)
  126. @property
  127. def identifiers(self):
  128. return self.identifier_stack[-1]
  129. def write_toplevel(self):
  130. """Traverse a template structure for module-level directives and
  131. generate the start of module-level code.
  132. """
  133. inherit = []
  134. namespaces = {}
  135. module_code = []
  136. encoding =[None]
  137. self.compiler.pagetag = None
  138. class FindTopLevel(object):
  139. def visitInheritTag(s, node):
  140. inherit.append(node)
  141. def visitNamespaceTag(s, node):
  142. namespaces[node.name] = node
  143. def visitPageTag(s, node):
  144. self.compiler.pagetag = node
  145. def visitCode(s, node):
  146. if node.ismodule:
  147. module_code.append(node)
  148. f = FindTopLevel()
  149. for n in self.node.nodes:
  150. n.accept_visitor(f)
  151. self.compiler.namespaces = namespaces
  152. module_ident = set()
  153. for n in module_code:
  154. module_ident = module_ident.union(n.declared_identifiers())
  155. module_identifiers = _Identifiers(self.compiler)
  156. module_identifiers.declared = module_ident
  157. # module-level names, python code
  158. if self.compiler.generate_magic_comment and \
  159. self.compiler.source_encoding:
  160. self.printer.writeline("# -*- encoding:%s -*-" %
  161. self.compiler.source_encoding)
  162. self.printer.writeline("from mako import runtime, filters, cache")
  163. self.printer.writeline("UNDEFINED = runtime.UNDEFINED")
  164. self.printer.writeline("__M_dict_builtin = dict")
  165. self.printer.writeline("__M_locals_builtin = locals")
  166. self.printer.writeline("_magic_number = %r" % MAGIC_NUMBER)
  167. self.printer.writeline("_modified_time = %r" % time.time())
  168. self.printer.writeline("_enable_loop = %r" % self.compiler.enable_loop)
  169. self.printer.writeline(
  170. "_template_filename = %r" % self.compiler.filename)
  171. self.printer.writeline("_template_uri = %r" % self.compiler.uri)
  172. self.printer.writeline(
  173. "_source_encoding = %r" % self.compiler.source_encoding)
  174. if self.compiler.imports:
  175. buf = ''
  176. for imp in self.compiler.imports:
  177. buf += imp + "\n"
  178. self.printer.writeline(imp)
  179. impcode = ast.PythonCode(
  180. buf,
  181. source='', lineno=0,
  182. pos=0,
  183. filename='template defined imports')
  184. else:
  185. impcode = None
  186. main_identifiers = module_identifiers.branch(self.node)
  187. module_identifiers.topleveldefs = \
  188. module_identifiers.topleveldefs.\
  189. union(main_identifiers.topleveldefs)
  190. module_identifiers.declared.add("UNDEFINED")
  191. if impcode:
  192. module_identifiers.declared.update(impcode.declared_identifiers)
  193. self.compiler.identifiers = module_identifiers
  194. self.printer.writeline("_exports = %r" %
  195. [n.name for n in
  196. main_identifiers.topleveldefs.values()]
  197. )
  198. self.printer.write("\n\n")
  199. if len(module_code):
  200. self.write_module_code(module_code)
  201. if len(inherit):
  202. self.write_namespaces(namespaces)
  203. self.write_inherit(inherit[-1])
  204. elif len(namespaces):
  205. self.write_namespaces(namespaces)
  206. return main_identifiers.topleveldefs.values()
  207. def write_render_callable(self, node, name, args, buffered, filtered,
  208. cached):
  209. """write a top-level render callable.
  210. this could be the main render() method or that of a top-level def."""
  211. if self.in_def:
  212. decorator = node.decorator
  213. if decorator:
  214. self.printer.writeline(
  215. "@runtime._decorate_toplevel(%s)" % decorator)
  216. self.printer.writelines(
  217. "def %s(%s):" % (name, ','.join(args)),
  218. # push new frame, assign current frame to __M_caller
  219. "__M_caller = context.caller_stack._push_frame()",
  220. "try:"
  221. )
  222. if buffered or filtered or cached:
  223. self.printer.writeline("context._push_buffer()")
  224. self.identifier_stack.append(
  225. self.compiler.identifiers.branch(self.node))
  226. if (not self.in_def or self.node.is_block) and '**pageargs' in args:
  227. self.identifier_stack[-1].argument_declared.add('pageargs')
  228. if not self.in_def and (
  229. len(self.identifiers.locally_assigned) > 0 or
  230. len(self.identifiers.argument_declared) > 0
  231. ):
  232. self.printer.writeline("__M_locals = __M_dict_builtin(%s)" %
  233. ','.join([
  234. "%s=%s" % (x, x) for x in
  235. self.identifiers.argument_declared
  236. ]))
  237. self.write_variable_declares(self.identifiers, toplevel=True)
  238. for n in self.node.nodes:
  239. n.accept_visitor(self)
  240. self.write_def_finish(self.node, buffered, filtered, cached)
  241. self.printer.writeline(None)
  242. self.printer.write("\n\n")
  243. if cached:
  244. self.write_cache_decorator(
  245. node, name,
  246. args, buffered,
  247. self.identifiers, toplevel=True)
  248. def write_module_code(self, module_code):
  249. """write module-level template code, i.e. that which
  250. is enclosed in <%! %> tags in the template."""
  251. for n in module_code:
  252. self.write_source_comment(n)
  253. self.printer.write_indented_block(n.text)
  254. def write_inherit(self, node):
  255. """write the module-level inheritance-determination callable."""
  256. self.printer.writelines(
  257. "def _mako_inherit(template, context):",
  258. "_mako_generate_namespaces(context)",
  259. "return runtime._inherit_from(context, %s, _template_uri)" %
  260. (node.parsed_attributes['file']),
  261. None
  262. )
  263. def write_namespaces(self, namespaces):
  264. """write the module-level namespace-generating callable."""
  265. self.printer.writelines(
  266. "def _mako_get_namespace(context, name):",
  267. "try:",
  268. "return context.namespaces[(__name__, name)]",
  269. "except KeyError:",
  270. "_mako_generate_namespaces(context)",
  271. "return context.namespaces[(__name__, name)]",
  272. None,None
  273. )
  274. self.printer.writeline("def _mako_generate_namespaces(context):")
  275. for node in namespaces.values():
  276. if node.attributes.has_key('import'):
  277. self.compiler.has_ns_imports = True
  278. self.write_source_comment(node)
  279. if len(node.nodes):
  280. self.printer.writeline("def make_namespace():")
  281. export = []
  282. identifiers = self.compiler.identifiers.branch(node)
  283. self.in_def = True
  284. class NSDefVisitor(object):
  285. def visitDefTag(s, node):
  286. s.visitDefOrBase(node)
  287. def visitBlockTag(s, node):
  288. s.visitDefOrBase(node)
  289. def visitDefOrBase(s, node):
  290. if node.is_anonymous:
  291. raise exceptions.CompileException(
  292. "Can't put anonymous blocks inside "
  293. "<%namespace>",
  294. **node.exception_kwargs
  295. )
  296. self.write_inline_def(node, identifiers, nested=False)
  297. export.append(node.funcname)
  298. vis = NSDefVisitor()
  299. for n in node.nodes:
  300. n.accept_visitor(vis)
  301. self.printer.writeline("return [%s]" % (','.join(export)))
  302. self.printer.writeline(None)
  303. self.in_def = False
  304. callable_name = "make_namespace()"
  305. else:
  306. callable_name = "None"
  307. if 'file' in node.parsed_attributes:
  308. self.printer.writeline(
  309. "ns = runtime.TemplateNamespace(%r,"
  310. " context._clean_inheritance_tokens(),"
  311. " templateuri=%s, callables=%s, "
  312. " calling_uri=_template_uri)" %
  313. (
  314. node.name,
  315. node.parsed_attributes.get('file', 'None'),
  316. callable_name,
  317. )
  318. )
  319. elif 'module' in node.parsed_attributes:
  320. self.printer.writeline(
  321. "ns = runtime.ModuleNamespace(%r,"
  322. " context._clean_inheritance_tokens(),"
  323. " callables=%s, calling_uri=_template_uri,"
  324. " module=%s)" %
  325. (
  326. node.name,
  327. callable_name,
  328. node.parsed_attributes.get('module', 'None')
  329. )
  330. )
  331. else:
  332. self.printer.writeline(
  333. "ns = runtime.Namespace(%r,"
  334. " context._clean_inheritance_tokens(),"
  335. " callables=%s, calling_uri=_template_uri)" %
  336. (
  337. node.name,
  338. callable_name,
  339. )
  340. )
  341. if eval(node.attributes.get('inheritable', "False")):
  342. self.printer.writeline("context['self'].%s = ns" % (node.name))
  343. self.printer.writeline(
  344. "context.namespaces[(__name__, %s)] = ns" % repr(node.name))
  345. self.printer.write("\n")
  346. if not len(namespaces):
  347. self.printer.writeline("pass")
  348. self.printer.writeline(None)
  349. def write_variable_declares(self, identifiers, toplevel=False, limit=None):
  350. """write variable declarations at the top of a function.
  351. the variable declarations are in the form of callable
  352. definitions for defs and/or name lookup within the
  353. function's context argument. the names declared are based
  354. on the names that are referenced in the function body,
  355. which don't otherwise have any explicit assignment
  356. operation. names that are assigned within the body are
  357. assumed to be locally-scoped variables and are not
  358. separately declared.
  359. for def callable definitions, if the def is a top-level
  360. callable then a 'stub' callable is generated which wraps
  361. the current Context into a closure. if the def is not
  362. top-level, it is fully rendered as a local closure.
  363. """
  364. # collection of all defs available to us in this scope
  365. comp_idents = dict([(c.funcname, c) for c in identifiers.defs])
  366. to_write = set()
  367. # write "context.get()" for all variables we are going to
  368. # need that arent in the namespace yet
  369. to_write = to_write.union(identifiers.undeclared)
  370. # write closure functions for closures that we define
  371. # right here
  372. to_write = to_write.union(
  373. [c.funcname for c in identifiers.closuredefs.values()])
  374. # remove identifiers that are declared in the argument
  375. # signature of the callable
  376. to_write = to_write.difference(identifiers.argument_declared)
  377. # remove identifiers that we are going to assign to.
  378. # in this way we mimic Python's behavior,
  379. # i.e. assignment to a variable within a block
  380. # means that variable is now a "locally declared" var,
  381. # which cannot be referenced beforehand.
  382. to_write = to_write.difference(identifiers.locally_declared)
  383. if self.compiler.enable_loop:
  384. has_loop = "loop" in to_write
  385. to_write.discard("loop")
  386. else:
  387. has_loop = False
  388. # if a limiting set was sent, constraint to those items in that list
  389. # (this is used for the caching decorator)
  390. if limit is not None:
  391. to_write = to_write.intersection(limit)
  392. if toplevel and getattr(self.compiler, 'has_ns_imports', False):
  393. self.printer.writeline("_import_ns = {}")
  394. self.compiler.has_imports = True
  395. for ident, ns in self.compiler.namespaces.iteritems():
  396. if ns.attributes.has_key('import'):
  397. self.printer.writeline(
  398. "_mako_get_namespace(context, %r)."\
  399. "_populate(_import_ns, %r)" %
  400. (
  401. ident,
  402. re.split(r'\s*,\s*', ns.attributes['import'])
  403. ))
  404. if has_loop:
  405. self.printer.writeline(
  406. 'loop = __M_loop = runtime.LoopStack()'
  407. )
  408. for ident in to_write:
  409. if ident in comp_idents:
  410. comp = comp_idents[ident]
  411. if comp.is_block:
  412. if not comp.is_anonymous:
  413. self.write_def_decl(comp, identifiers)
  414. else:
  415. self.write_inline_def(comp, identifiers, nested=True)
  416. else:
  417. if comp.is_root():
  418. self.write_def_decl(comp, identifiers)
  419. else:
  420. self.write_inline_def(comp, identifiers, nested=True)
  421. elif ident in self.compiler.namespaces:
  422. self.printer.writeline(
  423. "%s = _mako_get_namespace(context, %r)" %
  424. (ident, ident)
  425. )
  426. else:
  427. if getattr(self.compiler, 'has_ns_imports', False):
  428. if self.compiler.strict_undefined:
  429. self.printer.writelines(
  430. "%s = _import_ns.get(%r, UNDEFINED)" %
  431. (ident, ident),
  432. "if %s is UNDEFINED:" % ident,
  433. "try:",
  434. "%s = context[%r]" % (ident, ident),
  435. "except KeyError:",
  436. "raise NameError(\"'%s' is not defined\")" %
  437. ident,
  438. None, None
  439. )
  440. else:
  441. self.printer.writeline(
  442. "%s = _import_ns.get(%r, context.get(%r, UNDEFINED))" %
  443. (ident, ident, ident))
  444. else:
  445. if self.compiler.strict_undefined:
  446. self.printer.writelines(
  447. "try:",
  448. "%s = context[%r]" % (ident, ident),
  449. "except KeyError:",
  450. "raise NameError(\"'%s' is not defined\")" %
  451. ident,
  452. None
  453. )
  454. else:
  455. self.printer.writeline(
  456. "%s = context.get(%r, UNDEFINED)" % (ident, ident)
  457. )
  458. self.printer.writeline("__M_writer = context.writer()")
  459. def write_source_comment(self, node):
  460. """write a source comment containing the line number of the
  461. corresponding template line."""
  462. if self.last_source_line != node.lineno:
  463. self.printer.writeline("# SOURCE LINE %d" % node.lineno)
  464. self.last_source_line = node.lineno
  465. def write_def_decl(self, node, identifiers):
  466. """write a locally-available callable referencing a top-level def"""
  467. funcname = node.funcname
  468. namedecls = node.get_argument_expressions()
  469. nameargs = node.get_argument_expressions(include_defaults=False)
  470. if not self.in_def and (
  471. len(self.identifiers.locally_assigned) > 0 or
  472. len(self.identifiers.argument_declared) > 0):
  473. nameargs.insert(0, 'context.locals_(__M_locals)')
  474. else:
  475. nameargs.insert(0, 'context')
  476. self.printer.writeline("def %s(%s):" % (funcname, ",".join(namedecls)))
  477. self.printer.writeline(
  478. "return render_%s(%s)" % (funcname, ",".join(nameargs)))
  479. self.printer.writeline(None)
  480. def write_inline_def(self, node, identifiers, nested):
  481. """write a locally-available def callable inside an enclosing def."""
  482. namedecls = node.get_argument_expressions()
  483. decorator = node.decorator
  484. if decorator:
  485. self.printer.writeline(
  486. "@runtime._decorate_inline(context, %s)" % decorator)
  487. self.printer.writeline(
  488. "def %s(%s):" % (node.funcname, ",".join(namedecls)))
  489. filtered = len(node.filter_args.args) > 0
  490. buffered = eval(node.attributes.get('buffered', 'False'))
  491. cached = eval(node.attributes.get('cached', 'False'))
  492. self.printer.writelines(
  493. # push new frame, assign current frame to __M_caller
  494. "__M_caller = context.caller_stack._push_frame()",
  495. "try:"
  496. )
  497. if buffered or filtered or cached:
  498. self.printer.writelines(
  499. "context._push_buffer()",
  500. )
  501. identifiers = identifiers.branch(node, nested=nested)
  502. self.write_variable_declares(identifiers)
  503. self.identifier_stack.append(identifiers)
  504. for n in node.nodes:
  505. n.accept_visitor(self)
  506. self.identifier_stack.pop()
  507. self.write_def_finish(node, buffered, filtered, cached)
  508. self.printer.writeline(None)
  509. if cached:
  510. self.write_cache_decorator(node, node.funcname,
  511. namedecls, False, identifiers,
  512. inline=True, toplevel=False)
  513. def write_def_finish(self, node, buffered, filtered, cached,
  514. callstack=True):
  515. """write the end section of a rendering function, either outermost or
  516. inline.
  517. this takes into account if the rendering function was filtered,
  518. buffered, etc. and closes the corresponding try: block if any, and
  519. writes code to retrieve captured content, apply filters, send proper
  520. return value."""
  521. if not buffered and not cached and not filtered:
  522. self.printer.writeline("return ''")
  523. if callstack:
  524. self.printer.writelines(
  525. "finally:",
  526. "context.caller_stack._pop_frame()",
  527. None
  528. )
  529. if buffered or filtered or cached:
  530. if buffered or cached:
  531. # in a caching scenario, don't try to get a writer
  532. # from the context after popping; assume the caching
  533. # implemenation might be using a context with no
  534. # extra buffers
  535. self.printer.writelines(
  536. "finally:",
  537. "__M_buf = context._pop_buffer()"
  538. )
  539. else:
  540. self.printer.writelines(
  541. "finally:",
  542. "__M_buf, __M_writer = context._pop_buffer_and_writer()"
  543. )
  544. if callstack:
  545. self.printer.writeline("context.caller_stack._pop_frame()")
  546. s = "__M_buf.getvalue()"
  547. if filtered:
  548. s = self.create_filter_callable(node.filter_args.args, s,
  549. False)
  550. self.printer.writeline(None)
  551. if buffered and not cached:
  552. s = self.create_filter_callable(self.compiler.buffer_filters,
  553. s, False)
  554. if buffered or cached:
  555. self.printer.writeline("return %s" % s)
  556. else:
  557. self.printer.writelines(
  558. "__M_writer(%s)" % s,
  559. "return ''"
  560. )
  561. def write_cache_decorator(self, node_or_pagetag, name,
  562. args, buffered, identifiers,
  563. inline=False, toplevel=False):
  564. """write a post-function decorator to replace a rendering
  565. callable with a cached version of itself."""
  566. self.printer.writeline("__M_%s = %s" % (name, name))
  567. cachekey = node_or_pagetag.parsed_attributes.get('cache_key',
  568. repr(name))
  569. cache_args = {}
  570. if self.compiler.pagetag is not None:
  571. cache_args.update(
  572. (
  573. pa[6:],
  574. self.compiler.pagetag.parsed_attributes[pa]
  575. )
  576. for pa in self.compiler.pagetag.parsed_attributes
  577. if pa.startswith('cache_') and pa != 'cache_key'
  578. )
  579. cache_args.update(
  580. (
  581. pa[6:],
  582. node_or_pagetag.parsed_attributes[pa]
  583. ) for pa in node_or_pagetag.parsed_attributes
  584. if pa.startswith('cache_') and pa != 'cache_key'
  585. )
  586. if 'timeout' in cache_args:
  587. cache_args['timeout'] = int(eval(cache_args['timeout']))
  588. self.printer.writeline("def %s(%s):" % (name, ','.join(args)))
  589. # form "arg1, arg2, arg3=arg3, arg4=arg4", etc.
  590. pass_args = [
  591. '=' in a and "%s=%s" % ((a.split('=')[0],)*2) or a
  592. for a in args
  593. ]
  594. self.write_variable_declares(
  595. identifiers,
  596. toplevel=toplevel,
  597. limit=node_or_pagetag.undeclared_identifiers()
  598. )
  599. if buffered:
  600. s = "context.get('local')."\
  601. "cache._ctx_get_or_create("\
  602. "%s, lambda:__M_%s(%s), context, %s__M_defname=%r)" % \
  603. (cachekey, name, ','.join(pass_args),
  604. ''.join(["%s=%s, " % (k,v)
  605. for k, v in cache_args.items()]),
  606. name
  607. )
  608. # apply buffer_filters
  609. s = self.create_filter_callable(self.compiler.buffer_filters, s,
  610. False)
  611. self.printer.writelines("return " + s,None)
  612. else:
  613. self.printer.writelines(
  614. "__M_writer(context.get('local')."
  615. "cache._ctx_get_or_create("\
  616. "%s, lambda:__M_%s(%s), context, %s__M_defname=%r))" %
  617. (cachekey, name, ','.join(pass_args),
  618. ''.join(["%s=%s, " % (k,v)
  619. for k, v in cache_args.items()]),
  620. name,
  621. ),
  622. "return ''",
  623. None
  624. )
  625. def create_filter_callable(self, args, target, is_expression):
  626. """write a filter-applying expression based on the filters
  627. present in the given filter names, adjusting for the global
  628. 'default' filter aliases as needed."""
  629. def locate_encode(name):
  630. if re.match(r'decode\..+', name):
  631. return "filters." + name
  632. elif self.compiler.disable_unicode:
  633. return filters.NON_UNICODE_ESCAPES.get(name, name)
  634. else:
  635. return filters.DEFAULT_ESCAPES.get(name, name)
  636. if 'n' not in args:
  637. if is_expression:
  638. if self.compiler.pagetag:
  639. args = self.compiler.pagetag.filter_args.args + args
  640. if self.compiler.default_filters:
  641. args = self.compiler.default_filters + args
  642. for e in args:
  643. # if filter given as a function, get just the identifier portion
  644. if e == 'n':
  645. continue
  646. m = re.match(r'(.+?)(\(.*\))', e)
  647. if m:
  648. (ident, fargs) = m.group(1,2)
  649. f = locate_encode(ident)
  650. e = f + fargs
  651. else:
  652. x = e
  653. e = locate_encode(e)
  654. assert e is not None
  655. target = "%s(%s)" % (e, target)
  656. return target
  657. def visitExpression(self, node):
  658. self.write_source_comment(node)
  659. if len(node.escapes) or \
  660. (
  661. self.compiler.pagetag is not None and
  662. len(self.compiler.pagetag.filter_args.args)
  663. ) or \
  664. len(self.compiler.default_filters):
  665. s = self.create_filter_callable(node.escapes_code.args,
  666. "%s" % node.text, True)
  667. self.printer.writeline("__M_writer(%s)" % s)
  668. else:
  669. self.printer.writeline("__M_writer(%s)" % node.text)
  670. def visitControlLine(self, node):
  671. if node.isend:
  672. self.printer.writeline(None)
  673. if node.has_loop_context:
  674. self.printer.writeline('finally:')
  675. self.printer.writeline("loop = __M_loop._exit()")
  676. self.printer.writeline(None)
  677. else:
  678. self.write_source_comment(node)
  679. if self.compiler.enable_loop and node.keyword == 'for':
  680. text = mangle_mako_loop(node, self.printer)
  681. else:
  682. text = node.text
  683. self.printer.writeline(text)
  684. children = node.get_children()
  685. # this covers the three situations where we want to insert a pass:
  686. # 1) a ternary control line with no children,
  687. # 2) a primary control line with nothing but its own ternary
  688. # and end control lines, and
  689. # 3) any control line with no content other than comments
  690. if not children or (
  691. util.all(isinstance(c, (parsetree.Comment,
  692. parsetree.ControlLine))
  693. for c in children) and
  694. util.all((node.is_ternary(c.keyword) or c.isend)
  695. for c in children
  696. if isinstance(c, parsetree.ControlLine))):
  697. self.printer.writeline("pass")
  698. def visitText(self, node):
  699. self.write_source_comment(node)
  700. self.printer.writeline("__M_writer(%s)" % repr(node.content))
  701. def visitTextTag(self, node):
  702. filtered = len(node.filter_args.args) > 0
  703. if filtered:
  704. self.printer.writelines(
  705. "__M_writer = context._push_writer()",
  706. "try:",
  707. )
  708. for n in node.nodes:
  709. n.accept_visitor(self)
  710. if filtered:
  711. self.printer.writelines(
  712. "finally:",
  713. "__M_buf, __M_writer = context._pop_buffer_and_writer()",
  714. "__M_writer(%s)" %
  715. self.create_filter_callable(
  716. node.filter_args.args,
  717. "__M_buf.getvalue()",
  718. False),
  719. None
  720. )
  721. def visitCode(self, node):
  722. if not node.ismodule:
  723. self.write_source_comment(node)
  724. self.printer.write_indented_block(node.text)
  725. if not self.in_def and len(self.identifiers.locally_assigned) > 0:
  726. # if we are the "template" def, fudge locally
  727. # declared/modified variables into the "__M_locals" dictionary,
  728. # which is used for def calls within the same template,
  729. # to simulate "enclosing scope"
  730. self.printer.writeline(
  731. '__M_locals_builtin_stored = __M_locals_builtin()')
  732. self.printer.writeline(
  733. '__M_locals.update(__M_dict_builtin([(__M_key,'
  734. ' __M_locals_builtin_stored[__M_key]) for __M_key in'
  735. ' [%s] if __M_key in __M_locals_builtin_stored]))' %
  736. ','.join([repr(x) for x in node.declared_identifiers()]))
  737. def visitIncludeTag(self, node):
  738. self.write_source_comment(node)
  739. args = node.attributes.get('args')
  740. if args:
  741. self.printer.writeline(
  742. "runtime._include_file(context, %s, _template_uri, %s)" %
  743. (node.parsed_attributes['file'], args))
  744. else:
  745. self.printer.writeline(
  746. "runtime._include_file(context, %s, _template_uri)" %
  747. (node.parsed_attributes['file']))
  748. def visitNamespaceTag(self, node):
  749. pass
  750. def visitDefTag(self, node):
  751. pass
  752. def visitBlockTag(self, node):
  753. if node.is_anonymous:
  754. self.printer.writeline("%s()" % node.funcname)
  755. else:
  756. nameargs = node.get_argument_expressions(include_defaults=False)
  757. nameargs += ['**pageargs']
  758. self.printer.writeline("if 'parent' not in context._data or "
  759. "not hasattr(context._data['parent'], '%s'):"
  760. % node.funcname)
  761. self.printer.writeline(
  762. "context['self'].%s(%s)" % (node.funcname, ",".join(nameargs)))
  763. self.printer.writeline("\n")
  764. def visitCallNamespaceTag(self, node):
  765. # TODO: we can put namespace-specific checks here, such
  766. # as ensure the given namespace will be imported,
  767. # pre-import the namespace, etc.
  768. self.visitCallTag(node)
  769. def visitCallTag(self, node):
  770. self.printer.writeline("def ccall(caller):")
  771. export = ['body']
  772. callable_identifiers = self.identifiers.branch(node, nested=True)
  773. body_identifiers = callable_identifiers.branch(node, nested=False)
  774. # we want the 'caller' passed to ccall to be used
  775. # for the body() function, but for other non-body()
  776. # <%def>s within <%call> we want the current caller
  777. # off the call stack (if any)
  778. body_identifiers.add_declared('caller')
  779. self.identifier_stack.append(body_identifiers)
  780. class DefVisitor(object):
  781. def visitDefTag(s, node):
  782. s.visitDefOrBase(node)
  783. def visitBlockTag(s, node):
  784. s.visitDefOrBase(node)
  785. def visitDefOrBase(s, node):
  786. self.write_inline_def(node, callable_identifiers, nested=False)
  787. if not node.is_anonymous:
  788. export.append(node.funcname)
  789. # remove defs that are within the <%call> from the
  790. # "closuredefs" defined in the body, so they dont render twice
  791. if node.funcname in body_identifiers.closuredefs:
  792. del body_identifiers.closuredefs[node.funcname]
  793. vis = DefVisitor()
  794. for n in node.nodes:
  795. n.accept_visitor(vis)
  796. self.identifier_stack.pop()
  797. bodyargs = node.body_decl.get_argument_expressions()
  798. self.printer.writeline("def body(%s):" % ','.join(bodyargs))
  799. # TODO: figure out best way to specify
  800. # buffering/nonbuffering (at call time would be better)
  801. buffered = False
  802. if buffered:
  803. self.printer.writelines(
  804. "context._push_buffer()",
  805. "try:"
  806. )
  807. self.write_variable_declares(body_identifiers)
  808. self.identifier_stack.append(body_identifiers)
  809. for n in node.nodes:
  810. n.accept_visitor(self)
  811. self.identifier_stack.pop()
  812. self.write_def_finish(node, buffered, False, False, callstack=False)
  813. self.printer.writelines(
  814. None,
  815. "return [%s]" % (','.join(export)),
  816. None
  817. )
  818. self.printer.writelines(
  819. # push on caller for nested call
  820. "context.caller_stack.nextcaller = "
  821. "runtime.Namespace('caller', context, "
  822. "callables=ccall(__M_caller))",
  823. "try:")
  824. self.write_source_comment(node)
  825. self.printer.writelines(
  826. "__M_writer(%s)" % self.create_filter_callable(
  827. [], node.expression, True),
  828. "finally:",
  829. "context.caller_stack.nextcaller = None",
  830. None
  831. )
  832. class _Identifiers(object):
  833. """tracks the status of identifier names as template code is rendered."""
  834. def __init__(self, compiler, node=None, parent=None, nested=False):
  835. if parent is not None:
  836. # if we are the branch created in write_namespaces(),
  837. # we don't share any context from the main body().
  838. if isinstance(node, parsetree.NamespaceTag):
  839. self.declared = set()
  840. self.topleveldefs = util.SetLikeDict()
  841. else:
  842. # things that have already been declared
  843. # in an enclosing namespace (i.e. names we can just use)
  844. self.declared = set(parent.declared).\
  845. union([c.name for c in parent.closuredefs.values()]).\
  846. union(parent.locally_declared).\
  847. union(parent.argument_declared)
  848. # if these identifiers correspond to a "nested"
  849. # scope, it means whatever the parent identifiers
  850. # had as undeclared will have been declared by that parent,
  851. # and therefore we have them in our scope.
  852. if nested:
  853. self.declared = self.declared.union(parent.undeclared)
  854. # top level defs that are available
  855. self.topleveldefs = util.SetLikeDict(**parent.topleveldefs)
  856. else:
  857. self.declared = set()
  858. self.topleveldefs = util.SetLikeDict()
  859. self.compiler = compiler
  860. # things within this level that are referenced before they
  861. # are declared (e.g. assigned to)
  862. self.undeclared = set()
  863. # things that are declared locally. some of these things
  864. # could be in the "undeclared" list as well if they are
  865. # referenced before declared
  866. self.locally_declared = set()
  867. # assignments made in explicit python blocks.
  868. # these will be propagated to
  869. # the context of local def calls.
  870. self.locally_assigned = set()
  871. # things that are declared in the argument
  872. # signature of the def callable
  873. self.argument_declared = set()
  874. # closure defs that are defined in this level
  875. self.closuredefs = util.SetLikeDict()
  876. self.node = node
  877. if node is not None:
  878. node.accept_visitor(self)
  879. illegal_names = self.compiler.reserved_names.intersection(
  880. self.locally_declared)
  881. if illegal_names:
  882. raise exceptions.NameConflictError(
  883. "Reserved words declared in template: %s" %
  884. ", ".join(illegal_names))
  885. def branch(self, node, **kwargs):
  886. """create a new Identifiers for a new Node, with
  887. this Identifiers as the parent."""
  888. return _Identifiers(self.compiler, node, self, **kwargs)
  889. @property
  890. def defs(self):
  891. return set(self.topleveldefs.union(self.closuredefs).values())
  892. def __repr__(self):
  893. return "Identifiers(declared=%r, locally_declared=%r, "\
  894. "undeclared=%r, topleveldefs=%r, closuredefs=%r, "\
  895. "argumentdeclared=%r)" %\
  896. (
  897. list(self.declared),
  898. list(self.locally_declared),
  899. list(self.undeclared),
  900. [c.name for c in self.topleveldefs.values()],
  901. [c.name for c in self.closuredefs.values()],
  902. self.argument_declared)
  903. def check_declared(self, node):
  904. """update the state of this Identifiers with the undeclared
  905. and declared identifiers of the given node."""
  906. for ident in node.undeclared_identifiers():
  907. if ident != 'context' and\
  908. ident not in self.declared.union(self.locally_declared):
  909. self.undeclared.add(ident)
  910. for ident in node.declared_identifiers():
  911. self.locally_declared.add(ident)
  912. def add_declared(self, ident):
  913. self.declared.add(ident)
  914. if ident in self.undeclared:
  915. self.undeclared.remove(ident)
  916. def visitExpression(self, node):
  917. self.check_declared(node)
  918. def visitControlLine(self, node):
  919. self.check_declared(node)
  920. def visitCode(self, node):
  921. if not node.ismodule:
  922. self.check_declared(node)
  923. self.locally_assigned = self.locally_assigned.union(
  924. node.declared_identifiers())
  925. def visitNamespaceTag(self, node):
  926. # only traverse into the sub-elements of a
  927. # <%namespace> tag if we are the branch created in
  928. # write_namespaces()
  929. if self.node is node:
  930. for n in node.nodes:
  931. n.accept_visitor(self)
  932. def _check_name_exists(self, collection, node):
  933. existing = collection.get(node.funcname)
  934. collection[node.funcname] = node
  935. if existing is not None and \
  936. existing is not node and \
  937. (node.is_block or existing.is_block):
  938. raise exceptions.CompileException(
  939. "%%def or %%block named '%s' already "
  940. "exists in this template." %
  941. node.funcname, **node.exception_kwargs)
  942. def visitDefTag(self, node):
  943. if node.is_root() and not node.is_anonymous:
  944. self._check_name_exists(self.topleveldefs, node)
  945. elif node is not self.node:
  946. self._check_name_exists(self.closuredefs, node)
  947. for ident in node.undeclared_identifiers():
  948. if ident != 'context' and\
  949. ident not in self.declared.union(self.locally_declared):
  950. self.undeclared.add(ident)
  951. # visit defs only one level deep
  952. if node is self.node:
  953. for ident in node.declared_identifiers():
  954. self.argument_declared.add(ident)
  955. for n in node.nodes:
  956. n.accept_visitor(self)
  957. def visitBlockTag(self, node):
  958. if node is not self.node and \
  959. not node.is_anonymous:
  960. if isinstance(self.node, parsetree.DefTag):
  961. raise exceptions.CompileException(
  962. "Named block '%s' not allowed inside of def '%s'"
  963. % (node.name, self.node.name), **node.exception_kwargs)
  964. elif isinstance(self.node,
  965. (parsetree.CallTag, parsetree.CallNamespaceTag)):
  966. raise exceptions.CompileException(
  967. "Named block '%s' not allowed inside of <%%call> tag"
  968. % (node.name, ), **node.exception_kwargs)
  969. for ident in node.undeclared_identifiers():
  970. if ident != 'context' and\
  971. ident not in self.declared.union(self.locally_declared):
  972. self.undeclared.add(ident)
  973. if not node.is_anonymous:
  974. self._check_name_exists(self.topleveldefs, node)
  975. self.undeclared.add(node.funcname)
  976. elif node is not self.node:
  977. self._check_name_exists(self.closuredefs, node)
  978. for ident in node.declared_identifiers():
  979. self.argument_declared.add(ident)
  980. for n in node.nodes:
  981. n.accept_visitor(self)
  982. def visitIncludeTag(self, node):
  983. self.check_declared(node)
  984. def visitPageTag(self, node):
  985. for ident in node.declared_identifiers():
  986. self.argument_declared.add(ident)
  987. self.check_declared(node)
  988. def visitCallNamespaceTag(self, node):
  989. self.visitCallTag(node)
  990. def visitCallTag(self, node):
  991. if node is self.node:
  992. for ident in node.undeclared_identifiers():
  993. if ident != 'context' and\
  994. ident not in self.declared.union(self.locally_declared):
  995. self.undeclared.add(ident)
  996. for ident in node.declared_identifiers():
  997. self.argument_declared.add(ident)
  998. for n in node.nodes:
  999. n.accept_visitor(self)
  1000. else:
  1001. for ident in node.undeclared_identifiers():
  1002. if ident != 'context' and\
  1003. ident not in self.declared.union(self.locally_declared):
  1004. self.undeclared.add(ident)
  1005. _FOR_LOOP = re.compile(
  1006. r'^for\s+((?:\(?)\s*[A-Za-z_][A-Za-z_0-9]*'
  1007. r'(?:\s*,\s*(?:[A-Za-z_][A-Za-z0-9_]*),??)*\s*(?:\)?))\s+in\s+(.*):'
  1008. )
  1009. def mangle_mako_loop(node, printer):
  1010. """converts a for loop into a context manager wrapped around a for loop
  1011. when access to the `loop` variable has been detected in the for loop body
  1012. """
  1013. loop_variable = LoopVariable()
  1014. node.accept_visitor(loop_variable)
  1015. if loop_variable.detected:
  1016. node.nodes[-1].has_loop_context = True
  1017. match = _FOR_LOOP.match(node.text)
  1018. if match:
  1019. printer.writelines(
  1020. 'loop = __M_loop._enter(%s)' % match.group(2),
  1021. 'try:'
  1022. #'with __M_loop(%s) as loop:' % match.group(2)
  1023. )
  1024. text = 'for %s in loop:' % match.group(1)
  1025. else:
  1026. raise SyntaxError("Couldn't apply loop context: %s" % node.text)
  1027. else:
  1028. text = node.text
  1029. return text
  1030. class LoopVariable(object):
  1031. """A node visitor which looks for the name 'loop' within undeclared
  1032. identifiers."""
  1033. def __init__(self):
  1034. self.detected = False
  1035. def _loop_reference_detected(self, node):
  1036. if 'loop' in node.undeclared_identifiers():
  1037. self.detected = True
  1038. else:
  1039. for n in node.get_children():
  1040. n.accept_visitor(self)
  1041. def visitControlLine(self, node):
  1042. self._loop_reference_detected(node)
  1043. def visitCode(self, node):
  1044. self._loop_reference_detected(node)
  1045. def visitExpression(self, node):
  1046. self._loop_reference_detected(node)