You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1955 lines
70KB

  1. """Compiles nodes from the parser into Python code."""
  2. import typing as t
  3. from contextlib import contextmanager
  4. from functools import update_wrapper
  5. from io import StringIO
  6. from itertools import chain
  7. from keyword import iskeyword as is_python_keyword
  8. from markupsafe import escape
  9. from markupsafe import Markup
  10. from . import nodes
  11. from .exceptions import TemplateAssertionError
  12. from .idtracking import Symbols
  13. from .idtracking import VAR_LOAD_ALIAS
  14. from .idtracking import VAR_LOAD_PARAMETER
  15. from .idtracking import VAR_LOAD_RESOLVE
  16. from .idtracking import VAR_LOAD_UNDEFINED
  17. from .nodes import EvalContext
  18. from .optimizer import Optimizer
  19. from .utils import _PassArg
  20. from .utils import concat
  21. from .visitor import NodeVisitor
  22. if t.TYPE_CHECKING:
  23. import typing_extensions as te
  24. from .environment import Environment
  25. F = t.TypeVar("F", bound=t.Callable[..., t.Any])
  26. operators = {
  27. "eq": "==",
  28. "ne": "!=",
  29. "gt": ">",
  30. "gteq": ">=",
  31. "lt": "<",
  32. "lteq": "<=",
  33. "in": "in",
  34. "notin": "not in",
  35. }
  36. def optimizeconst(f: F) -> F:
  37. def new_func(
  38. self: "CodeGenerator", node: nodes.Expr, frame: "Frame", **kwargs: t.Any
  39. ) -> t.Any:
  40. # Only optimize if the frame is not volatile
  41. if self.optimizer is not None and not frame.eval_ctx.volatile:
  42. new_node = self.optimizer.visit(node, frame.eval_ctx)
  43. if new_node != node:
  44. return self.visit(new_node, frame)
  45. return f(self, node, frame, **kwargs)
  46. return update_wrapper(t.cast(F, new_func), f)
  47. def _make_binop(op: str) -> t.Callable[["CodeGenerator", nodes.BinExpr, "Frame"], None]:
  48. @optimizeconst
  49. def visitor(self: "CodeGenerator", node: nodes.BinExpr, frame: Frame) -> None:
  50. if (
  51. self.environment.sandboxed
  52. and op in self.environment.intercepted_binops # type: ignore
  53. ):
  54. self.write(f"environment.call_binop(context, {op!r}, ")
  55. self.visit(node.left, frame)
  56. self.write(", ")
  57. self.visit(node.right, frame)
  58. else:
  59. self.write("(")
  60. self.visit(node.left, frame)
  61. self.write(f" {op} ")
  62. self.visit(node.right, frame)
  63. self.write(")")
  64. return visitor
  65. def _make_unop(
  66. op: str,
  67. ) -> t.Callable[["CodeGenerator", nodes.UnaryExpr, "Frame"], None]:
  68. @optimizeconst
  69. def visitor(self: "CodeGenerator", node: nodes.UnaryExpr, frame: Frame) -> None:
  70. if (
  71. self.environment.sandboxed
  72. and op in self.environment.intercepted_unops # type: ignore
  73. ):
  74. self.write(f"environment.call_unop(context, {op!r}, ")
  75. self.visit(node.node, frame)
  76. else:
  77. self.write("(" + op)
  78. self.visit(node.node, frame)
  79. self.write(")")
  80. return visitor
  81. def generate(
  82. node: nodes.Template,
  83. environment: "Environment",
  84. name: t.Optional[str],
  85. filename: t.Optional[str],
  86. stream: t.Optional[t.TextIO] = None,
  87. defer_init: bool = False,
  88. optimized: bool = True,
  89. ) -> t.Optional[str]:
  90. """Generate the python source for a node tree."""
  91. if not isinstance(node, nodes.Template):
  92. raise TypeError("Can't compile non template nodes")
  93. generator = environment.code_generator_class(
  94. environment, name, filename, stream, defer_init, optimized
  95. )
  96. generator.visit(node)
  97. if stream is None:
  98. return generator.stream.getvalue() # type: ignore
  99. return None
  100. def has_safe_repr(value: t.Any) -> bool:
  101. """Does the node have a safe representation?"""
  102. if value is None or value is NotImplemented or value is Ellipsis:
  103. return True
  104. if type(value) in {bool, int, float, complex, range, str, Markup}:
  105. return True
  106. if type(value) in {tuple, list, set, frozenset}:
  107. return all(has_safe_repr(v) for v in value)
  108. if type(value) is dict:
  109. return all(has_safe_repr(k) and has_safe_repr(v) for k, v in value.items())
  110. return False
  111. def find_undeclared(
  112. nodes: t.Iterable[nodes.Node], names: t.Iterable[str]
  113. ) -> t.Set[str]:
  114. """Check if the names passed are accessed undeclared. The return value
  115. is a set of all the undeclared names from the sequence of names found.
  116. """
  117. visitor = UndeclaredNameVisitor(names)
  118. try:
  119. for node in nodes:
  120. visitor.visit(node)
  121. except VisitorExit:
  122. pass
  123. return visitor.undeclared
  124. class MacroRef:
  125. def __init__(self, node: t.Union[nodes.Macro, nodes.CallBlock]) -> None:
  126. self.node = node
  127. self.accesses_caller = False
  128. self.accesses_kwargs = False
  129. self.accesses_varargs = False
  130. class Frame:
  131. """Holds compile time information for us."""
  132. def __init__(
  133. self,
  134. eval_ctx: EvalContext,
  135. parent: t.Optional["Frame"] = None,
  136. level: t.Optional[int] = None,
  137. ) -> None:
  138. self.eval_ctx = eval_ctx
  139. # the parent of this frame
  140. self.parent = parent
  141. if parent is None:
  142. self.symbols = Symbols(level=level)
  143. # in some dynamic inheritance situations the compiler needs to add
  144. # write tests around output statements.
  145. self.require_output_check = False
  146. # inside some tags we are using a buffer rather than yield statements.
  147. # this for example affects {% filter %} or {% macro %}. If a frame
  148. # is buffered this variable points to the name of the list used as
  149. # buffer.
  150. self.buffer: t.Optional[str] = None
  151. # the name of the block we're in, otherwise None.
  152. self.block: t.Optional[str] = None
  153. else:
  154. self.symbols = Symbols(parent.symbols, level=level)
  155. self.require_output_check = parent.require_output_check
  156. self.buffer = parent.buffer
  157. self.block = parent.block
  158. # a toplevel frame is the root + soft frames such as if conditions.
  159. self.toplevel = False
  160. # the root frame is basically just the outermost frame, so no if
  161. # conditions. This information is used to optimize inheritance
  162. # situations.
  163. self.rootlevel = False
  164. # variables set inside of loops and blocks should not affect outer frames,
  165. # but they still needs to be kept track of as part of the active context.
  166. self.loop_frame = False
  167. self.block_frame = False
  168. # track whether the frame is being used in an if-statement or conditional
  169. # expression as it determines which errors should be raised during runtime
  170. # or compile time.
  171. self.soft_frame = False
  172. def copy(self) -> "Frame":
  173. """Create a copy of the current one."""
  174. rv = t.cast(Frame, object.__new__(self.__class__))
  175. rv.__dict__.update(self.__dict__)
  176. rv.symbols = self.symbols.copy()
  177. return rv
  178. def inner(self, isolated: bool = False) -> "Frame":
  179. """Return an inner frame."""
  180. if isolated:
  181. return Frame(self.eval_ctx, level=self.symbols.level + 1)
  182. return Frame(self.eval_ctx, self)
  183. def soft(self) -> "Frame":
  184. """Return a soft frame. A soft frame may not be modified as
  185. standalone thing as it shares the resources with the frame it
  186. was created of, but it's not a rootlevel frame any longer.
  187. This is only used to implement if-statements and conditional
  188. expressions.
  189. """
  190. rv = self.copy()
  191. rv.rootlevel = False
  192. rv.soft_frame = True
  193. return rv
  194. __copy__ = copy
  195. class VisitorExit(RuntimeError):
  196. """Exception used by the `UndeclaredNameVisitor` to signal a stop."""
  197. class DependencyFinderVisitor(NodeVisitor):
  198. """A visitor that collects filter and test calls."""
  199. def __init__(self) -> None:
  200. self.filters: t.Set[str] = set()
  201. self.tests: t.Set[str] = set()
  202. def visit_Filter(self, node: nodes.Filter) -> None:
  203. self.generic_visit(node)
  204. self.filters.add(node.name)
  205. def visit_Test(self, node: nodes.Test) -> None:
  206. self.generic_visit(node)
  207. self.tests.add(node.name)
  208. def visit_Block(self, node: nodes.Block) -> None:
  209. """Stop visiting at blocks."""
  210. class UndeclaredNameVisitor(NodeVisitor):
  211. """A visitor that checks if a name is accessed without being
  212. declared. This is different from the frame visitor as it will
  213. not stop at closure frames.
  214. """
  215. def __init__(self, names: t.Iterable[str]) -> None:
  216. self.names = set(names)
  217. self.undeclared: t.Set[str] = set()
  218. def visit_Name(self, node: nodes.Name) -> None:
  219. if node.ctx == "load" and node.name in self.names:
  220. self.undeclared.add(node.name)
  221. if self.undeclared == self.names:
  222. raise VisitorExit()
  223. else:
  224. self.names.discard(node.name)
  225. def visit_Block(self, node: nodes.Block) -> None:
  226. """Stop visiting a blocks."""
  227. class CompilerExit(Exception):
  228. """Raised if the compiler encountered a situation where it just
  229. doesn't make sense to further process the code. Any block that
  230. raises such an exception is not further processed.
  231. """
  232. class CodeGenerator(NodeVisitor):
  233. def __init__(
  234. self,
  235. environment: "Environment",
  236. name: t.Optional[str],
  237. filename: t.Optional[str],
  238. stream: t.Optional[t.TextIO] = None,
  239. defer_init: bool = False,
  240. optimized: bool = True,
  241. ) -> None:
  242. if stream is None:
  243. stream = StringIO()
  244. self.environment = environment
  245. self.name = name
  246. self.filename = filename
  247. self.stream = stream
  248. self.created_block_context = False
  249. self.defer_init = defer_init
  250. self.optimizer: t.Optional[Optimizer] = None
  251. if optimized:
  252. self.optimizer = Optimizer(environment)
  253. # aliases for imports
  254. self.import_aliases: t.Dict[str, str] = {}
  255. # a registry for all blocks. Because blocks are moved out
  256. # into the global python scope they are registered here
  257. self.blocks: t.Dict[str, nodes.Block] = {}
  258. # the number of extends statements so far
  259. self.extends_so_far = 0
  260. # some templates have a rootlevel extends. In this case we
  261. # can safely assume that we're a child template and do some
  262. # more optimizations.
  263. self.has_known_extends = False
  264. # the current line number
  265. self.code_lineno = 1
  266. # registry of all filters and tests (global, not block local)
  267. self.tests: t.Dict[str, str] = {}
  268. self.filters: t.Dict[str, str] = {}
  269. # the debug information
  270. self.debug_info: t.List[t.Tuple[int, int]] = []
  271. self._write_debug_info: t.Optional[int] = None
  272. # the number of new lines before the next write()
  273. self._new_lines = 0
  274. # the line number of the last written statement
  275. self._last_line = 0
  276. # true if nothing was written so far.
  277. self._first_write = True
  278. # used by the `temporary_identifier` method to get new
  279. # unique, temporary identifier
  280. self._last_identifier = 0
  281. # the current indentation
  282. self._indentation = 0
  283. # Tracks toplevel assignments
  284. self._assign_stack: t.List[t.Set[str]] = []
  285. # Tracks parameter definition blocks
  286. self._param_def_block: t.List[t.Set[str]] = []
  287. # Tracks the current context.
  288. self._context_reference_stack = ["context"]
  289. @property
  290. def optimized(self) -> bool:
  291. return self.optimizer is not None
  292. # -- Various compilation helpers
  293. def fail(self, msg: str, lineno: int) -> "te.NoReturn":
  294. """Fail with a :exc:`TemplateAssertionError`."""
  295. raise TemplateAssertionError(msg, lineno, self.name, self.filename)
  296. def temporary_identifier(self) -> str:
  297. """Get a new unique identifier."""
  298. self._last_identifier += 1
  299. return f"t_{self._last_identifier}"
  300. def buffer(self, frame: Frame) -> None:
  301. """Enable buffering for the frame from that point onwards."""
  302. frame.buffer = self.temporary_identifier()
  303. self.writeline(f"{frame.buffer} = []")
  304. def return_buffer_contents(
  305. self, frame: Frame, force_unescaped: bool = False
  306. ) -> None:
  307. """Return the buffer contents of the frame."""
  308. if not force_unescaped:
  309. if frame.eval_ctx.volatile:
  310. self.writeline("if context.eval_ctx.autoescape:")
  311. self.indent()
  312. self.writeline(f"return Markup(concat({frame.buffer}))")
  313. self.outdent()
  314. self.writeline("else:")
  315. self.indent()
  316. self.writeline(f"return concat({frame.buffer})")
  317. self.outdent()
  318. return
  319. elif frame.eval_ctx.autoescape:
  320. self.writeline(f"return Markup(concat({frame.buffer}))")
  321. return
  322. self.writeline(f"return concat({frame.buffer})")
  323. def indent(self) -> None:
  324. """Indent by one."""
  325. self._indentation += 1
  326. def outdent(self, step: int = 1) -> None:
  327. """Outdent by step."""
  328. self._indentation -= step
  329. def start_write(self, frame: Frame, node: t.Optional[nodes.Node] = None) -> None:
  330. """Yield or write into the frame buffer."""
  331. if frame.buffer is None:
  332. self.writeline("yield ", node)
  333. else:
  334. self.writeline(f"{frame.buffer}.append(", node)
  335. def end_write(self, frame: Frame) -> None:
  336. """End the writing process started by `start_write`."""
  337. if frame.buffer is not None:
  338. self.write(")")
  339. def simple_write(
  340. self, s: str, frame: Frame, node: t.Optional[nodes.Node] = None
  341. ) -> None:
  342. """Simple shortcut for start_write + write + end_write."""
  343. self.start_write(frame, node)
  344. self.write(s)
  345. self.end_write(frame)
  346. def blockvisit(self, nodes: t.Iterable[nodes.Node], frame: Frame) -> None:
  347. """Visit a list of nodes as block in a frame. If the current frame
  348. is no buffer a dummy ``if 0: yield None`` is written automatically.
  349. """
  350. try:
  351. self.writeline("pass")
  352. for node in nodes:
  353. self.visit(node, frame)
  354. except CompilerExit:
  355. pass
  356. def write(self, x: str) -> None:
  357. """Write a string into the output stream."""
  358. if self._new_lines:
  359. if not self._first_write:
  360. self.stream.write("\n" * self._new_lines)
  361. self.code_lineno += self._new_lines
  362. if self._write_debug_info is not None:
  363. self.debug_info.append((self._write_debug_info, self.code_lineno))
  364. self._write_debug_info = None
  365. self._first_write = False
  366. self.stream.write(" " * self._indentation)
  367. self._new_lines = 0
  368. self.stream.write(x)
  369. def writeline(
  370. self, x: str, node: t.Optional[nodes.Node] = None, extra: int = 0
  371. ) -> None:
  372. """Combination of newline and write."""
  373. self.newline(node, extra)
  374. self.write(x)
  375. def newline(self, node: t.Optional[nodes.Node] = None, extra: int = 0) -> None:
  376. """Add one or more newlines before the next write."""
  377. self._new_lines = max(self._new_lines, 1 + extra)
  378. if node is not None and node.lineno != self._last_line:
  379. self._write_debug_info = node.lineno
  380. self._last_line = node.lineno
  381. def signature(
  382. self,
  383. node: t.Union[nodes.Call, nodes.Filter, nodes.Test],
  384. frame: Frame,
  385. extra_kwargs: t.Optional[t.Mapping[str, t.Any]] = None,
  386. ) -> None:
  387. """Writes a function call to the stream for the current node.
  388. A leading comma is added automatically. The extra keyword
  389. arguments may not include python keywords otherwise a syntax
  390. error could occur. The extra keyword arguments should be given
  391. as python dict.
  392. """
  393. # if any of the given keyword arguments is a python keyword
  394. # we have to make sure that no invalid call is created.
  395. kwarg_workaround = any(
  396. is_python_keyword(t.cast(str, k))
  397. for k in chain((x.key for x in node.kwargs), extra_kwargs or ())
  398. )
  399. for arg in node.args:
  400. self.write(", ")
  401. self.visit(arg, frame)
  402. if not kwarg_workaround:
  403. for kwarg in node.kwargs:
  404. self.write(", ")
  405. self.visit(kwarg, frame)
  406. if extra_kwargs is not None:
  407. for key, value in extra_kwargs.items():
  408. self.write(f", {key}={value}")
  409. if node.dyn_args:
  410. self.write(", *")
  411. self.visit(node.dyn_args, frame)
  412. if kwarg_workaround:
  413. if node.dyn_kwargs is not None:
  414. self.write(", **dict({")
  415. else:
  416. self.write(", **{")
  417. for kwarg in node.kwargs:
  418. self.write(f"{kwarg.key!r}: ")
  419. self.visit(kwarg.value, frame)
  420. self.write(", ")
  421. if extra_kwargs is not None:
  422. for key, value in extra_kwargs.items():
  423. self.write(f"{key!r}: {value}, ")
  424. if node.dyn_kwargs is not None:
  425. self.write("}, **")
  426. self.visit(node.dyn_kwargs, frame)
  427. self.write(")")
  428. else:
  429. self.write("}")
  430. elif node.dyn_kwargs is not None:
  431. self.write(", **")
  432. self.visit(node.dyn_kwargs, frame)
  433. def pull_dependencies(self, nodes: t.Iterable[nodes.Node]) -> None:
  434. """Find all filter and test names used in the template and
  435. assign them to variables in the compiled namespace. Checking
  436. that the names are registered with the environment is done when
  437. compiling the Filter and Test nodes. If the node is in an If or
  438. CondExpr node, the check is done at runtime instead.
  439. .. versionchanged:: 3.0
  440. Filters and tests in If and CondExpr nodes are checked at
  441. runtime instead of compile time.
  442. """
  443. visitor = DependencyFinderVisitor()
  444. for node in nodes:
  445. visitor.visit(node)
  446. for id_map, names, dependency in (self.filters, visitor.filters, "filters"), (
  447. self.tests,
  448. visitor.tests,
  449. "tests",
  450. ):
  451. for name in names:
  452. if name not in id_map:
  453. id_map[name] = self.temporary_identifier()
  454. # add check during runtime that dependencies used inside of executed
  455. # blocks are defined, as this step may be skipped during compile time
  456. self.writeline("try:")
  457. self.indent()
  458. self.writeline(f"{id_map[name]} = environment.{dependency}[{name!r}]")
  459. self.outdent()
  460. self.writeline("except KeyError:")
  461. self.indent()
  462. self.writeline("@internalcode")
  463. self.writeline(f"def {id_map[name]}(*unused):")
  464. self.indent()
  465. self.writeline(
  466. f'raise TemplateRuntimeError("No {dependency[:-1]}'
  467. f' named {name!r} found.")'
  468. )
  469. self.outdent()
  470. self.outdent()
  471. def enter_frame(self, frame: Frame) -> None:
  472. undefs = []
  473. for target, (action, param) in frame.symbols.loads.items():
  474. if action == VAR_LOAD_PARAMETER:
  475. pass
  476. elif action == VAR_LOAD_RESOLVE:
  477. self.writeline(f"{target} = {self.get_resolve_func()}({param!r})")
  478. elif action == VAR_LOAD_ALIAS:
  479. self.writeline(f"{target} = {param}")
  480. elif action == VAR_LOAD_UNDEFINED:
  481. undefs.append(target)
  482. else:
  483. raise NotImplementedError("unknown load instruction")
  484. if undefs:
  485. self.writeline(f"{' = '.join(undefs)} = missing")
  486. def leave_frame(self, frame: Frame, with_python_scope: bool = False) -> None:
  487. if not with_python_scope:
  488. undefs = []
  489. for target in frame.symbols.loads:
  490. undefs.append(target)
  491. if undefs:
  492. self.writeline(f"{' = '.join(undefs)} = missing")
  493. def choose_async(self, async_value: str = "async ", sync_value: str = "") -> str:
  494. return async_value if self.environment.is_async else sync_value
  495. def func(self, name: str) -> str:
  496. return f"{self.choose_async()}def {name}"
  497. def macro_body(
  498. self, node: t.Union[nodes.Macro, nodes.CallBlock], frame: Frame
  499. ) -> t.Tuple[Frame, MacroRef]:
  500. """Dump the function def of a macro or call block."""
  501. frame = frame.inner()
  502. frame.symbols.analyze_node(node)
  503. macro_ref = MacroRef(node)
  504. explicit_caller = None
  505. skip_special_params = set()
  506. args = []
  507. for idx, arg in enumerate(node.args):
  508. if arg.name == "caller":
  509. explicit_caller = idx
  510. if arg.name in ("kwargs", "varargs"):
  511. skip_special_params.add(arg.name)
  512. args.append(frame.symbols.ref(arg.name))
  513. undeclared = find_undeclared(node.body, ("caller", "kwargs", "varargs"))
  514. if "caller" in undeclared:
  515. # In older Jinja versions there was a bug that allowed caller
  516. # to retain the special behavior even if it was mentioned in
  517. # the argument list. However thankfully this was only really
  518. # working if it was the last argument. So we are explicitly
  519. # checking this now and error out if it is anywhere else in
  520. # the argument list.
  521. if explicit_caller is not None:
  522. try:
  523. node.defaults[explicit_caller - len(node.args)]
  524. except IndexError:
  525. self.fail(
  526. "When defining macros or call blocks the "
  527. 'special "caller" argument must be omitted '
  528. "or be given a default.",
  529. node.lineno,
  530. )
  531. else:
  532. args.append(frame.symbols.declare_parameter("caller"))
  533. macro_ref.accesses_caller = True
  534. if "kwargs" in undeclared and "kwargs" not in skip_special_params:
  535. args.append(frame.symbols.declare_parameter("kwargs"))
  536. macro_ref.accesses_kwargs = True
  537. if "varargs" in undeclared and "varargs" not in skip_special_params:
  538. args.append(frame.symbols.declare_parameter("varargs"))
  539. macro_ref.accesses_varargs = True
  540. # macros are delayed, they never require output checks
  541. frame.require_output_check = False
  542. frame.symbols.analyze_node(node)
  543. self.writeline(f"{self.func('macro')}({', '.join(args)}):", node)
  544. self.indent()
  545. self.buffer(frame)
  546. self.enter_frame(frame)
  547. self.push_parameter_definitions(frame)
  548. for idx, arg in enumerate(node.args):
  549. ref = frame.symbols.ref(arg.name)
  550. self.writeline(f"if {ref} is missing:")
  551. self.indent()
  552. try:
  553. default = node.defaults[idx - len(node.args)]
  554. except IndexError:
  555. self.writeline(
  556. f'{ref} = undefined("parameter {arg.name!r} was not provided",'
  557. f" name={arg.name!r})"
  558. )
  559. else:
  560. self.writeline(f"{ref} = ")
  561. self.visit(default, frame)
  562. self.mark_parameter_stored(ref)
  563. self.outdent()
  564. self.pop_parameter_definitions()
  565. self.blockvisit(node.body, frame)
  566. self.return_buffer_contents(frame, force_unescaped=True)
  567. self.leave_frame(frame, with_python_scope=True)
  568. self.outdent()
  569. return frame, macro_ref
  570. def macro_def(self, macro_ref: MacroRef, frame: Frame) -> None:
  571. """Dump the macro definition for the def created by macro_body."""
  572. arg_tuple = ", ".join(repr(x.name) for x in macro_ref.node.args)
  573. name = getattr(macro_ref.node, "name", None)
  574. if len(macro_ref.node.args) == 1:
  575. arg_tuple += ","
  576. self.write(
  577. f"Macro(environment, macro, {name!r}, ({arg_tuple}),"
  578. f" {macro_ref.accesses_kwargs!r}, {macro_ref.accesses_varargs!r},"
  579. f" {macro_ref.accesses_caller!r}, context.eval_ctx.autoescape)"
  580. )
  581. def position(self, node: nodes.Node) -> str:
  582. """Return a human readable position for the node."""
  583. rv = f"line {node.lineno}"
  584. if self.name is not None:
  585. rv = f"{rv} in {self.name!r}"
  586. return rv
  587. def dump_local_context(self, frame: Frame) -> str:
  588. items_kv = ", ".join(
  589. f"{name!r}: {target}"
  590. for name, target in frame.symbols.dump_stores().items()
  591. )
  592. return f"{{{items_kv}}}"
  593. def write_commons(self) -> None:
  594. """Writes a common preamble that is used by root and block functions.
  595. Primarily this sets up common local helpers and enforces a generator
  596. through a dead branch.
  597. """
  598. self.writeline("resolve = context.resolve_or_missing")
  599. self.writeline("undefined = environment.undefined")
  600. # always use the standard Undefined class for the implicit else of
  601. # conditional expressions
  602. self.writeline("cond_expr_undefined = Undefined")
  603. self.writeline("if 0: yield None")
  604. def push_parameter_definitions(self, frame: Frame) -> None:
  605. """Pushes all parameter targets from the given frame into a local
  606. stack that permits tracking of yet to be assigned parameters. In
  607. particular this enables the optimization from `visit_Name` to skip
  608. undefined expressions for parameters in macros as macros can reference
  609. otherwise unbound parameters.
  610. """
  611. self._param_def_block.append(frame.symbols.dump_param_targets())
  612. def pop_parameter_definitions(self) -> None:
  613. """Pops the current parameter definitions set."""
  614. self._param_def_block.pop()
  615. def mark_parameter_stored(self, target: str) -> None:
  616. """Marks a parameter in the current parameter definitions as stored.
  617. This will skip the enforced undefined checks.
  618. """
  619. if self._param_def_block:
  620. self._param_def_block[-1].discard(target)
  621. def push_context_reference(self, target: str) -> None:
  622. self._context_reference_stack.append(target)
  623. def pop_context_reference(self) -> None:
  624. self._context_reference_stack.pop()
  625. def get_context_ref(self) -> str:
  626. return self._context_reference_stack[-1]
  627. def get_resolve_func(self) -> str:
  628. target = self._context_reference_stack[-1]
  629. if target == "context":
  630. return "resolve"
  631. return f"{target}.resolve"
  632. def derive_context(self, frame: Frame) -> str:
  633. return f"{self.get_context_ref()}.derived({self.dump_local_context(frame)})"
  634. def parameter_is_undeclared(self, target: str) -> bool:
  635. """Checks if a given target is an undeclared parameter."""
  636. if not self._param_def_block:
  637. return False
  638. return target in self._param_def_block[-1]
  639. def push_assign_tracking(self) -> None:
  640. """Pushes a new layer for assignment tracking."""
  641. self._assign_stack.append(set())
  642. def pop_assign_tracking(self, frame: Frame) -> None:
  643. """Pops the topmost level for assignment tracking and updates the
  644. context variables if necessary.
  645. """
  646. vars = self._assign_stack.pop()
  647. if (
  648. not frame.block_frame
  649. and not frame.loop_frame
  650. and not frame.toplevel
  651. or not vars
  652. ):
  653. return
  654. public_names = [x for x in vars if x[:1] != "_"]
  655. if len(vars) == 1:
  656. name = next(iter(vars))
  657. ref = frame.symbols.ref(name)
  658. if frame.loop_frame:
  659. self.writeline(f"_loop_vars[{name!r}] = {ref}")
  660. return
  661. if frame.block_frame:
  662. self.writeline(f"_block_vars[{name!r}] = {ref}")
  663. return
  664. self.writeline(f"context.vars[{name!r}] = {ref}")
  665. else:
  666. if frame.loop_frame:
  667. self.writeline("_loop_vars.update({")
  668. elif frame.block_frame:
  669. self.writeline("_block_vars.update({")
  670. else:
  671. self.writeline("context.vars.update({")
  672. for idx, name in enumerate(vars):
  673. if idx:
  674. self.write(", ")
  675. ref = frame.symbols.ref(name)
  676. self.write(f"{name!r}: {ref}")
  677. self.write("})")
  678. if not frame.block_frame and not frame.loop_frame and public_names:
  679. if len(public_names) == 1:
  680. self.writeline(f"context.exported_vars.add({public_names[0]!r})")
  681. else:
  682. names_str = ", ".join(map(repr, public_names))
  683. self.writeline(f"context.exported_vars.update(({names_str}))")
  684. # -- Statement Visitors
  685. def visit_Template(
  686. self, node: nodes.Template, frame: t.Optional[Frame] = None
  687. ) -> None:
  688. assert frame is None, "no root frame allowed"
  689. eval_ctx = EvalContext(self.environment, self.name)
  690. from .runtime import exported, async_exported
  691. if self.environment.is_async:
  692. exported_names = sorted(exported + async_exported)
  693. else:
  694. exported_names = sorted(exported)
  695. self.writeline("from __future__ import generator_stop") # Python < 3.7
  696. self.writeline("from jinja2.runtime import " + ", ".join(exported_names))
  697. # if we want a deferred initialization we cannot move the
  698. # environment into a local name
  699. envenv = "" if self.defer_init else ", environment=environment"
  700. # do we have an extends tag at all? If not, we can save some
  701. # overhead by just not processing any inheritance code.
  702. have_extends = node.find(nodes.Extends) is not None
  703. # find all blocks
  704. for block in node.find_all(nodes.Block):
  705. if block.name in self.blocks:
  706. self.fail(f"block {block.name!r} defined twice", block.lineno)
  707. self.blocks[block.name] = block
  708. # find all imports and import them
  709. for import_ in node.find_all(nodes.ImportedName):
  710. if import_.importname not in self.import_aliases:
  711. imp = import_.importname
  712. self.import_aliases[imp] = alias = self.temporary_identifier()
  713. if "." in imp:
  714. module, obj = imp.rsplit(".", 1)
  715. self.writeline(f"from {module} import {obj} as {alias}")
  716. else:
  717. self.writeline(f"import {imp} as {alias}")
  718. # add the load name
  719. self.writeline(f"name = {self.name!r}")
  720. # generate the root render function.
  721. self.writeline(
  722. f"{self.func('root')}(context, missing=missing{envenv}):", extra=1
  723. )
  724. self.indent()
  725. self.write_commons()
  726. # process the root
  727. frame = Frame(eval_ctx)
  728. if "self" in find_undeclared(node.body, ("self",)):
  729. ref = frame.symbols.declare_parameter("self")
  730. self.writeline(f"{ref} = TemplateReference(context)")
  731. frame.symbols.analyze_node(node)
  732. frame.toplevel = frame.rootlevel = True
  733. frame.require_output_check = have_extends and not self.has_known_extends
  734. if have_extends:
  735. self.writeline("parent_template = None")
  736. self.enter_frame(frame)
  737. self.pull_dependencies(node.body)
  738. self.blockvisit(node.body, frame)
  739. self.leave_frame(frame, with_python_scope=True)
  740. self.outdent()
  741. # make sure that the parent root is called.
  742. if have_extends:
  743. if not self.has_known_extends:
  744. self.indent()
  745. self.writeline("if parent_template is not None:")
  746. self.indent()
  747. if not self.environment.is_async:
  748. self.writeline("yield from parent_template.root_render_func(context)")
  749. else:
  750. self.writeline(
  751. "async for event in parent_template.root_render_func(context):"
  752. )
  753. self.indent()
  754. self.writeline("yield event")
  755. self.outdent()
  756. self.outdent(1 + (not self.has_known_extends))
  757. # at this point we now have the blocks collected and can visit them too.
  758. for name, block in self.blocks.items():
  759. self.writeline(
  760. f"{self.func('block_' + name)}(context, missing=missing{envenv}):",
  761. block,
  762. 1,
  763. )
  764. self.indent()
  765. self.write_commons()
  766. # It's important that we do not make this frame a child of the
  767. # toplevel template. This would cause a variety of
  768. # interesting issues with identifier tracking.
  769. block_frame = Frame(eval_ctx)
  770. block_frame.block_frame = True
  771. undeclared = find_undeclared(block.body, ("self", "super"))
  772. if "self" in undeclared:
  773. ref = block_frame.symbols.declare_parameter("self")
  774. self.writeline(f"{ref} = TemplateReference(context)")
  775. if "super" in undeclared:
  776. ref = block_frame.symbols.declare_parameter("super")
  777. self.writeline(f"{ref} = context.super({name!r}, block_{name})")
  778. block_frame.symbols.analyze_node(block)
  779. block_frame.block = name
  780. self.writeline("_block_vars = {}")
  781. self.enter_frame(block_frame)
  782. self.pull_dependencies(block.body)
  783. self.blockvisit(block.body, block_frame)
  784. self.leave_frame(block_frame, with_python_scope=True)
  785. self.outdent()
  786. blocks_kv_str = ", ".join(f"{x!r}: block_{x}" for x in self.blocks)
  787. self.writeline(f"blocks = {{{blocks_kv_str}}}", extra=1)
  788. debug_kv_str = "&".join(f"{k}={v}" for k, v in self.debug_info)
  789. self.writeline(f"debug_info = {debug_kv_str!r}")
  790. def visit_Block(self, node: nodes.Block, frame: Frame) -> None:
  791. """Call a block and register it for the template."""
  792. level = 0
  793. if frame.toplevel:
  794. # if we know that we are a child template, there is no need to
  795. # check if we are one
  796. if self.has_known_extends:
  797. return
  798. if self.extends_so_far > 0:
  799. self.writeline("if parent_template is None:")
  800. self.indent()
  801. level += 1
  802. if node.scoped:
  803. context = self.derive_context(frame)
  804. else:
  805. context = self.get_context_ref()
  806. if node.required:
  807. self.writeline(f"if len(context.blocks[{node.name!r}]) <= 1:", node)
  808. self.indent()
  809. self.writeline(
  810. f'raise TemplateRuntimeError("Required block {node.name!r} not found")',
  811. node,
  812. )
  813. self.outdent()
  814. if not self.environment.is_async and frame.buffer is None:
  815. self.writeline(
  816. f"yield from context.blocks[{node.name!r}][0]({context})", node
  817. )
  818. else:
  819. self.writeline(
  820. f"{self.choose_async()}for event in"
  821. f" context.blocks[{node.name!r}][0]({context}):",
  822. node,
  823. )
  824. self.indent()
  825. self.simple_write("event", frame)
  826. self.outdent()
  827. self.outdent(level)
  828. def visit_Extends(self, node: nodes.Extends, frame: Frame) -> None:
  829. """Calls the extender."""
  830. if not frame.toplevel:
  831. self.fail("cannot use extend from a non top-level scope", node.lineno)
  832. # if the number of extends statements in general is zero so
  833. # far, we don't have to add a check if something extended
  834. # the template before this one.
  835. if self.extends_so_far > 0:
  836. # if we have a known extends we just add a template runtime
  837. # error into the generated code. We could catch that at compile
  838. # time too, but i welcome it not to confuse users by throwing the
  839. # same error at different times just "because we can".
  840. if not self.has_known_extends:
  841. self.writeline("if parent_template is not None:")
  842. self.indent()
  843. self.writeline('raise TemplateRuntimeError("extended multiple times")')
  844. # if we have a known extends already we don't need that code here
  845. # as we know that the template execution will end here.
  846. if self.has_known_extends:
  847. raise CompilerExit()
  848. else:
  849. self.outdent()
  850. self.writeline("parent_template = environment.get_template(", node)
  851. self.visit(node.template, frame)
  852. self.write(f", {self.name!r})")
  853. self.writeline("for name, parent_block in parent_template.blocks.items():")
  854. self.indent()
  855. self.writeline("context.blocks.setdefault(name, []).append(parent_block)")
  856. self.outdent()
  857. # if this extends statement was in the root level we can take
  858. # advantage of that information and simplify the generated code
  859. # in the top level from this point onwards
  860. if frame.rootlevel:
  861. self.has_known_extends = True
  862. # and now we have one more
  863. self.extends_so_far += 1
  864. def visit_Include(self, node: nodes.Include, frame: Frame) -> None:
  865. """Handles includes."""
  866. if node.ignore_missing:
  867. self.writeline("try:")
  868. self.indent()
  869. func_name = "get_or_select_template"
  870. if isinstance(node.template, nodes.Const):
  871. if isinstance(node.template.value, str):
  872. func_name = "get_template"
  873. elif isinstance(node.template.value, (tuple, list)):
  874. func_name = "select_template"
  875. elif isinstance(node.template, (nodes.Tuple, nodes.List)):
  876. func_name = "select_template"
  877. self.writeline(f"template = environment.{func_name}(", node)
  878. self.visit(node.template, frame)
  879. self.write(f", {self.name!r})")
  880. if node.ignore_missing:
  881. self.outdent()
  882. self.writeline("except TemplateNotFound:")
  883. self.indent()
  884. self.writeline("pass")
  885. self.outdent()
  886. self.writeline("else:")
  887. self.indent()
  888. skip_event_yield = False
  889. if node.with_context:
  890. self.writeline(
  891. f"{self.choose_async()}for event in template.root_render_func("
  892. "template.new_context(context.get_all(), True,"
  893. f" {self.dump_local_context(frame)})):"
  894. )
  895. elif self.environment.is_async:
  896. self.writeline(
  897. "for event in (await template._get_default_module_async())"
  898. "._body_stream:"
  899. )
  900. else:
  901. self.writeline("yield from template._get_default_module()._body_stream")
  902. skip_event_yield = True
  903. if not skip_event_yield:
  904. self.indent()
  905. self.simple_write("event", frame)
  906. self.outdent()
  907. if node.ignore_missing:
  908. self.outdent()
  909. def _import_common(
  910. self, node: t.Union[nodes.Import, nodes.FromImport], frame: Frame
  911. ) -> None:
  912. self.write(f"{self.choose_async('await ')}environment.get_template(")
  913. self.visit(node.template, frame)
  914. self.write(f", {self.name!r}).")
  915. if node.with_context:
  916. f_name = f"make_module{self.choose_async('_async')}"
  917. self.write(
  918. f"{f_name}(context.get_all(), True, {self.dump_local_context(frame)})"
  919. )
  920. elif self.environment.is_async:
  921. self.write("_get_default_module_async()")
  922. else:
  923. self.write("_get_default_module(context)")
  924. def visit_Import(self, node: nodes.Import, frame: Frame) -> None:
  925. """Visit regular imports."""
  926. self.writeline(f"{frame.symbols.ref(node.target)} = ", node)
  927. if frame.toplevel:
  928. self.write(f"context.vars[{node.target!r}] = ")
  929. self._import_common(node, frame)
  930. if frame.toplevel and not node.target.startswith("_"):
  931. self.writeline(f"context.exported_vars.discard({node.target!r})")
  932. def visit_FromImport(self, node: nodes.FromImport, frame: Frame) -> None:
  933. """Visit named imports."""
  934. self.newline(node)
  935. self.write("included_template = ")
  936. self._import_common(node, frame)
  937. var_names = []
  938. discarded_names = []
  939. for name in node.names:
  940. if isinstance(name, tuple):
  941. name, alias = name
  942. else:
  943. alias = name
  944. self.writeline(
  945. f"{frame.symbols.ref(alias)} ="
  946. f" getattr(included_template, {name!r}, missing)"
  947. )
  948. self.writeline(f"if {frame.symbols.ref(alias)} is missing:")
  949. self.indent()
  950. message = (
  951. "the template {included_template.__name__!r}"
  952. f" (imported on {self.position(node)})"
  953. f" does not export the requested name {name!r}"
  954. )
  955. self.writeline(
  956. f"{frame.symbols.ref(alias)} = undefined(f{message!r}, name={name!r})"
  957. )
  958. self.outdent()
  959. if frame.toplevel:
  960. var_names.append(alias)
  961. if not alias.startswith("_"):
  962. discarded_names.append(alias)
  963. if var_names:
  964. if len(var_names) == 1:
  965. name = var_names[0]
  966. self.writeline(f"context.vars[{name!r}] = {frame.symbols.ref(name)}")
  967. else:
  968. names_kv = ", ".join(
  969. f"{name!r}: {frame.symbols.ref(name)}" for name in var_names
  970. )
  971. self.writeline(f"context.vars.update({{{names_kv}}})")
  972. if discarded_names:
  973. if len(discarded_names) == 1:
  974. self.writeline(f"context.exported_vars.discard({discarded_names[0]!r})")
  975. else:
  976. names_str = ", ".join(map(repr, discarded_names))
  977. self.writeline(
  978. f"context.exported_vars.difference_update(({names_str}))"
  979. )
  980. def visit_For(self, node: nodes.For, frame: Frame) -> None:
  981. loop_frame = frame.inner()
  982. loop_frame.loop_frame = True
  983. test_frame = frame.inner()
  984. else_frame = frame.inner()
  985. # try to figure out if we have an extended loop. An extended loop
  986. # is necessary if the loop is in recursive mode if the special loop
  987. # variable is accessed in the body if the body is a scoped block.
  988. extended_loop = (
  989. node.recursive
  990. or "loop"
  991. in find_undeclared(node.iter_child_nodes(only=("body",)), ("loop",))
  992. or any(block.scoped for block in node.find_all(nodes.Block))
  993. )
  994. loop_ref = None
  995. if extended_loop:
  996. loop_ref = loop_frame.symbols.declare_parameter("loop")
  997. loop_frame.symbols.analyze_node(node, for_branch="body")
  998. if node.else_:
  999. else_frame.symbols.analyze_node(node, for_branch="else")
  1000. if node.test:
  1001. loop_filter_func = self.temporary_identifier()
  1002. test_frame.symbols.analyze_node(node, for_branch="test")
  1003. self.writeline(f"{self.func(loop_filter_func)}(fiter):", node.test)
  1004. self.indent()
  1005. self.enter_frame(test_frame)
  1006. self.writeline(self.choose_async("async for ", "for "))
  1007. self.visit(node.target, loop_frame)
  1008. self.write(" in ")
  1009. self.write(self.choose_async("auto_aiter(fiter)", "fiter"))
  1010. self.write(":")
  1011. self.indent()
  1012. self.writeline("if ", node.test)
  1013. self.visit(node.test, test_frame)
  1014. self.write(":")
  1015. self.indent()
  1016. self.writeline("yield ")
  1017. self.visit(node.target, loop_frame)
  1018. self.outdent(3)
  1019. self.leave_frame(test_frame, with_python_scope=True)
  1020. # if we don't have an recursive loop we have to find the shadowed
  1021. # variables at that point. Because loops can be nested but the loop
  1022. # variable is a special one we have to enforce aliasing for it.
  1023. if node.recursive:
  1024. self.writeline(
  1025. f"{self.func('loop')}(reciter, loop_render_func, depth=0):", node
  1026. )
  1027. self.indent()
  1028. self.buffer(loop_frame)
  1029. # Use the same buffer for the else frame
  1030. else_frame.buffer = loop_frame.buffer
  1031. # make sure the loop variable is a special one and raise a template
  1032. # assertion error if a loop tries to write to loop
  1033. if extended_loop:
  1034. self.writeline(f"{loop_ref} = missing")
  1035. for name in node.find_all(nodes.Name):
  1036. if name.ctx == "store" and name.name == "loop":
  1037. self.fail(
  1038. "Can't assign to special loop variable in for-loop target",
  1039. name.lineno,
  1040. )
  1041. if node.else_:
  1042. iteration_indicator = self.temporary_identifier()
  1043. self.writeline(f"{iteration_indicator} = 1")
  1044. self.writeline(self.choose_async("async for ", "for "), node)
  1045. self.visit(node.target, loop_frame)
  1046. if extended_loop:
  1047. self.write(f", {loop_ref} in {self.choose_async('Async')}LoopContext(")
  1048. else:
  1049. self.write(" in ")
  1050. if node.test:
  1051. self.write(f"{loop_filter_func}(")
  1052. if node.recursive:
  1053. self.write("reciter")
  1054. else:
  1055. if self.environment.is_async and not extended_loop:
  1056. self.write("auto_aiter(")
  1057. self.visit(node.iter, frame)
  1058. if self.environment.is_async and not extended_loop:
  1059. self.write(")")
  1060. if node.test:
  1061. self.write(")")
  1062. if node.recursive:
  1063. self.write(", undefined, loop_render_func, depth):")
  1064. else:
  1065. self.write(", undefined):" if extended_loop else ":")
  1066. self.indent()
  1067. self.enter_frame(loop_frame)
  1068. self.writeline("_loop_vars = {}")
  1069. self.blockvisit(node.body, loop_frame)
  1070. if node.else_:
  1071. self.writeline(f"{iteration_indicator} = 0")
  1072. self.outdent()
  1073. self.leave_frame(
  1074. loop_frame, with_python_scope=node.recursive and not node.else_
  1075. )
  1076. if node.else_:
  1077. self.writeline(f"if {iteration_indicator}:")
  1078. self.indent()
  1079. self.enter_frame(else_frame)
  1080. self.blockvisit(node.else_, else_frame)
  1081. self.leave_frame(else_frame)
  1082. self.outdent()
  1083. # if the node was recursive we have to return the buffer contents
  1084. # and start the iteration code
  1085. if node.recursive:
  1086. self.return_buffer_contents(loop_frame)
  1087. self.outdent()
  1088. self.start_write(frame, node)
  1089. self.write(f"{self.choose_async('await ')}loop(")
  1090. if self.environment.is_async:
  1091. self.write("auto_aiter(")
  1092. self.visit(node.iter, frame)
  1093. if self.environment.is_async:
  1094. self.write(")")
  1095. self.write(", loop)")
  1096. self.end_write(frame)
  1097. def visit_If(self, node: nodes.If, frame: Frame) -> None:
  1098. if_frame = frame.soft()
  1099. self.writeline("if ", node)
  1100. self.visit(node.test, if_frame)
  1101. self.write(":")
  1102. self.indent()
  1103. self.blockvisit(node.body, if_frame)
  1104. self.outdent()
  1105. for elif_ in node.elif_:
  1106. self.writeline("elif ", elif_)
  1107. self.visit(elif_.test, if_frame)
  1108. self.write(":")
  1109. self.indent()
  1110. self.blockvisit(elif_.body, if_frame)
  1111. self.outdent()
  1112. if node.else_:
  1113. self.writeline("else:")
  1114. self.indent()
  1115. self.blockvisit(node.else_, if_frame)
  1116. self.outdent()
  1117. def visit_Macro(self, node: nodes.Macro, frame: Frame) -> None:
  1118. macro_frame, macro_ref = self.macro_body(node, frame)
  1119. self.newline()
  1120. if frame.toplevel:
  1121. if not node.name.startswith("_"):
  1122. self.write(f"context.exported_vars.add({node.name!r})")
  1123. self.writeline(f"context.vars[{node.name!r}] = ")
  1124. self.write(f"{frame.symbols.ref(node.name)} = ")
  1125. self.macro_def(macro_ref, macro_frame)
  1126. def visit_CallBlock(self, node: nodes.CallBlock, frame: Frame) -> None:
  1127. call_frame, macro_ref = self.macro_body(node, frame)
  1128. self.writeline("caller = ")
  1129. self.macro_def(macro_ref, call_frame)
  1130. self.start_write(frame, node)
  1131. self.visit_Call(node.call, frame, forward_caller=True)
  1132. self.end_write(frame)
  1133. def visit_FilterBlock(self, node: nodes.FilterBlock, frame: Frame) -> None:
  1134. filter_frame = frame.inner()
  1135. filter_frame.symbols.analyze_node(node)
  1136. self.enter_frame(filter_frame)
  1137. self.buffer(filter_frame)
  1138. self.blockvisit(node.body, filter_frame)
  1139. self.start_write(frame, node)
  1140. self.visit_Filter(node.filter, filter_frame)
  1141. self.end_write(frame)
  1142. self.leave_frame(filter_frame)
  1143. def visit_With(self, node: nodes.With, frame: Frame) -> None:
  1144. with_frame = frame.inner()
  1145. with_frame.symbols.analyze_node(node)
  1146. self.enter_frame(with_frame)
  1147. for target, expr in zip(node.targets, node.values):
  1148. self.newline()
  1149. self.visit(target, with_frame)
  1150. self.write(" = ")
  1151. self.visit(expr, frame)
  1152. self.blockvisit(node.body, with_frame)
  1153. self.leave_frame(with_frame)
  1154. def visit_ExprStmt(self, node: nodes.ExprStmt, frame: Frame) -> None:
  1155. self.newline(node)
  1156. self.visit(node.node, frame)
  1157. class _FinalizeInfo(t.NamedTuple):
  1158. const: t.Optional[t.Callable[..., str]]
  1159. src: t.Optional[str]
  1160. @staticmethod
  1161. def _default_finalize(value: t.Any) -> t.Any:
  1162. """The default finalize function if the environment isn't
  1163. configured with one. Or, if the environment has one, this is
  1164. called on that function's output for constants.
  1165. """
  1166. return str(value)
  1167. _finalize: t.Optional[_FinalizeInfo] = None
  1168. def _make_finalize(self) -> _FinalizeInfo:
  1169. """Build the finalize function to be used on constants and at
  1170. runtime. Cached so it's only created once for all output nodes.
  1171. Returns a ``namedtuple`` with the following attributes:
  1172. ``const``
  1173. A function to finalize constant data at compile time.
  1174. ``src``
  1175. Source code to output around nodes to be evaluated at
  1176. runtime.
  1177. """
  1178. if self._finalize is not None:
  1179. return self._finalize
  1180. finalize: t.Optional[t.Callable[..., t.Any]]
  1181. finalize = default = self._default_finalize
  1182. src = None
  1183. if self.environment.finalize:
  1184. src = "environment.finalize("
  1185. env_finalize = self.environment.finalize
  1186. pass_arg = {
  1187. _PassArg.context: "context",
  1188. _PassArg.eval_context: "context.eval_ctx",
  1189. _PassArg.environment: "environment",
  1190. }.get(
  1191. _PassArg.from_obj(env_finalize) # type: ignore
  1192. )
  1193. finalize = None
  1194. if pass_arg is None:
  1195. def finalize(value: t.Any) -> t.Any:
  1196. return default(env_finalize(value))
  1197. else:
  1198. src = f"{src}{pass_arg}, "
  1199. if pass_arg == "environment":
  1200. def finalize(value: t.Any) -> t.Any:
  1201. return default(env_finalize(self.environment, value))
  1202. self._finalize = self._FinalizeInfo(finalize, src)
  1203. return self._finalize
  1204. def _output_const_repr(self, group: t.Iterable[t.Any]) -> str:
  1205. """Given a group of constant values converted from ``Output``
  1206. child nodes, produce a string to write to the template module
  1207. source.
  1208. """
  1209. return repr(concat(group))
  1210. def _output_child_to_const(
  1211. self, node: nodes.Expr, frame: Frame, finalize: _FinalizeInfo
  1212. ) -> str:
  1213. """Try to optimize a child of an ``Output`` node by trying to
  1214. convert it to constant, finalized data at compile time.
  1215. If :exc:`Impossible` is raised, the node is not constant and
  1216. will be evaluated at runtime. Any other exception will also be
  1217. evaluated at runtime for easier debugging.
  1218. """
  1219. const = node.as_const(frame.eval_ctx)
  1220. if frame.eval_ctx.autoescape:
  1221. const = escape(const)
  1222. # Template data doesn't go through finalize.
  1223. if isinstance(node, nodes.TemplateData):
  1224. return str(const)
  1225. return finalize.const(const) # type: ignore
  1226. def _output_child_pre(
  1227. self, node: nodes.Expr, frame: Frame, finalize: _FinalizeInfo
  1228. ) -> None:
  1229. """Output extra source code before visiting a child of an
  1230. ``Output`` node.
  1231. """
  1232. if frame.eval_ctx.volatile:
  1233. self.write("(escape if context.eval_ctx.autoescape else str)(")
  1234. elif frame.eval_ctx.autoescape:
  1235. self.write("escape(")
  1236. else:
  1237. self.write("str(")
  1238. if finalize.src is not None:
  1239. self.write(finalize.src)
  1240. def _output_child_post(
  1241. self, node: nodes.Expr, frame: Frame, finalize: _FinalizeInfo
  1242. ) -> None:
  1243. """Output extra source code after visiting a child of an
  1244. ``Output`` node.
  1245. """
  1246. self.write(")")
  1247. if finalize.src is not None:
  1248. self.write(")")
  1249. def visit_Output(self, node: nodes.Output, frame: Frame) -> None:
  1250. # If an extends is active, don't render outside a block.
  1251. if frame.require_output_check:
  1252. # A top-level extends is known to exist at compile time.
  1253. if self.has_known_extends:
  1254. return
  1255. self.writeline("if parent_template is None:")
  1256. self.indent()
  1257. finalize = self._make_finalize()
  1258. body: t.List[t.Union[t.List[t.Any], nodes.Expr]] = []
  1259. # Evaluate constants at compile time if possible. Each item in
  1260. # body will be either a list of static data or a node to be
  1261. # evaluated at runtime.
  1262. for child in node.nodes:
  1263. try:
  1264. if not (
  1265. # If the finalize function requires runtime context,
  1266. # constants can't be evaluated at compile time.
  1267. finalize.const
  1268. # Unless it's basic template data that won't be
  1269. # finalized anyway.
  1270. or isinstance(child, nodes.TemplateData)
  1271. ):
  1272. raise nodes.Impossible()
  1273. const = self._output_child_to_const(child, frame, finalize)
  1274. except (nodes.Impossible, Exception):
  1275. # The node was not constant and needs to be evaluated at
  1276. # runtime. Or another error was raised, which is easier
  1277. # to debug at runtime.
  1278. body.append(child)
  1279. continue
  1280. if body and isinstance(body[-1], list):
  1281. body[-1].append(const)
  1282. else:
  1283. body.append([const])
  1284. if frame.buffer is not None:
  1285. if len(body) == 1:
  1286. self.writeline(f"{frame.buffer}.append(")
  1287. else:
  1288. self.writeline(f"{frame.buffer}.extend((")
  1289. self.indent()
  1290. for item in body:
  1291. if isinstance(item, list):
  1292. # A group of constant data to join and output.
  1293. val = self._output_const_repr(item)
  1294. if frame.buffer is None:
  1295. self.writeline("yield " + val)
  1296. else:
  1297. self.writeline(val + ",")
  1298. else:
  1299. if frame.buffer is None:
  1300. self.writeline("yield ", item)
  1301. else:
  1302. self.newline(item)
  1303. # A node to be evaluated at runtime.
  1304. self._output_child_pre(item, frame, finalize)
  1305. self.visit(item, frame)
  1306. self._output_child_post(item, frame, finalize)
  1307. if frame.buffer is not None:
  1308. self.write(",")
  1309. if frame.buffer is not None:
  1310. self.outdent()
  1311. self.writeline(")" if len(body) == 1 else "))")
  1312. if frame.require_output_check:
  1313. self.outdent()
  1314. def visit_Assign(self, node: nodes.Assign, frame: Frame) -> None:
  1315. self.push_assign_tracking()
  1316. self.newline(node)
  1317. self.visit(node.target, frame)
  1318. self.write(" = ")
  1319. self.visit(node.node, frame)
  1320. self.pop_assign_tracking(frame)
  1321. def visit_AssignBlock(self, node: nodes.AssignBlock, frame: Frame) -> None:
  1322. self.push_assign_tracking()
  1323. block_frame = frame.inner()
  1324. # This is a special case. Since a set block always captures we
  1325. # will disable output checks. This way one can use set blocks
  1326. # toplevel even in extended templates.
  1327. block_frame.require_output_check = False
  1328. block_frame.symbols.analyze_node(node)
  1329. self.enter_frame(block_frame)
  1330. self.buffer(block_frame)
  1331. self.blockvisit(node.body, block_frame)
  1332. self.newline(node)
  1333. self.visit(node.target, frame)
  1334. self.write(" = (Markup if context.eval_ctx.autoescape else identity)(")
  1335. if node.filter is not None:
  1336. self.visit_Filter(node.filter, block_frame)
  1337. else:
  1338. self.write(f"concat({block_frame.buffer})")
  1339. self.write(")")
  1340. self.pop_assign_tracking(frame)
  1341. self.leave_frame(block_frame)
  1342. # -- Expression Visitors
  1343. def visit_Name(self, node: nodes.Name, frame: Frame) -> None:
  1344. if node.ctx == "store" and (
  1345. frame.toplevel or frame.loop_frame or frame.block_frame
  1346. ):
  1347. if self._assign_stack:
  1348. self._assign_stack[-1].add(node.name)
  1349. ref = frame.symbols.ref(node.name)
  1350. # If we are looking up a variable we might have to deal with the
  1351. # case where it's undefined. We can skip that case if the load
  1352. # instruction indicates a parameter which are always defined.
  1353. if node.ctx == "load":
  1354. load = frame.symbols.find_load(ref)
  1355. if not (
  1356. load is not None
  1357. and load[0] == VAR_LOAD_PARAMETER
  1358. and not self.parameter_is_undeclared(ref)
  1359. ):
  1360. self.write(
  1361. f"(undefined(name={node.name!r}) if {ref} is missing else {ref})"
  1362. )
  1363. return
  1364. self.write(ref)
  1365. def visit_NSRef(self, node: nodes.NSRef, frame: Frame) -> None:
  1366. # NSRefs can only be used to store values; since they use the normal
  1367. # `foo.bar` notation they will be parsed as a normal attribute access
  1368. # when used anywhere but in a `set` context
  1369. ref = frame.symbols.ref(node.name)
  1370. self.writeline(f"if not isinstance({ref}, Namespace):")
  1371. self.indent()
  1372. self.writeline(
  1373. "raise TemplateRuntimeError"
  1374. '("cannot assign attribute on non-namespace object")'
  1375. )
  1376. self.outdent()
  1377. self.writeline(f"{ref}[{node.attr!r}]")
  1378. def visit_Const(self, node: nodes.Const, frame: Frame) -> None:
  1379. val = node.as_const(frame.eval_ctx)
  1380. if isinstance(val, float):
  1381. self.write(str(val))
  1382. else:
  1383. self.write(repr(val))
  1384. def visit_TemplateData(self, node: nodes.TemplateData, frame: Frame) -> None:
  1385. try:
  1386. self.write(repr(node.as_const(frame.eval_ctx)))
  1387. except nodes.Impossible:
  1388. self.write(
  1389. f"(Markup if context.eval_ctx.autoescape else identity)({node.data!r})"
  1390. )
  1391. def visit_Tuple(self, node: nodes.Tuple, frame: Frame) -> None:
  1392. self.write("(")
  1393. idx = -1
  1394. for idx, item in enumerate(node.items):
  1395. if idx:
  1396. self.write(", ")
  1397. self.visit(item, frame)
  1398. self.write(",)" if idx == 0 else ")")
  1399. def visit_List(self, node: nodes.List, frame: Frame) -> None:
  1400. self.write("[")
  1401. for idx, item in enumerate(node.items):
  1402. if idx:
  1403. self.write(", ")
  1404. self.visit(item, frame)
  1405. self.write("]")
  1406. def visit_Dict(self, node: nodes.Dict, frame: Frame) -> None:
  1407. self.write("{")
  1408. for idx, item in enumerate(node.items):
  1409. if idx:
  1410. self.write(", ")
  1411. self.visit(item.key, frame)
  1412. self.write(": ")
  1413. self.visit(item.value, frame)
  1414. self.write("}")
  1415. visit_Add = _make_binop("+")
  1416. visit_Sub = _make_binop("-")
  1417. visit_Mul = _make_binop("*")
  1418. visit_Div = _make_binop("/")
  1419. visit_FloorDiv = _make_binop("//")
  1420. visit_Pow = _make_binop("**")
  1421. visit_Mod = _make_binop("%")
  1422. visit_And = _make_binop("and")
  1423. visit_Or = _make_binop("or")
  1424. visit_Pos = _make_unop("+")
  1425. visit_Neg = _make_unop("-")
  1426. visit_Not = _make_unop("not ")
  1427. @optimizeconst
  1428. def visit_Concat(self, node: nodes.Concat, frame: Frame) -> None:
  1429. if frame.eval_ctx.volatile:
  1430. func_name = "(markup_join if context.eval_ctx.volatile else str_join)"
  1431. elif frame.eval_ctx.autoescape:
  1432. func_name = "markup_join"
  1433. else:
  1434. func_name = "str_join"
  1435. self.write(f"{func_name}((")
  1436. for arg in node.nodes:
  1437. self.visit(arg, frame)
  1438. self.write(", ")
  1439. self.write("))")
  1440. @optimizeconst
  1441. def visit_Compare(self, node: nodes.Compare, frame: Frame) -> None:
  1442. self.write("(")
  1443. self.visit(node.expr, frame)
  1444. for op in node.ops:
  1445. self.visit(op, frame)
  1446. self.write(")")
  1447. def visit_Operand(self, node: nodes.Operand, frame: Frame) -> None:
  1448. self.write(f" {operators[node.op]} ")
  1449. self.visit(node.expr, frame)
  1450. @optimizeconst
  1451. def visit_Getattr(self, node: nodes.Getattr, frame: Frame) -> None:
  1452. if self.environment.is_async:
  1453. self.write("(await auto_await(")
  1454. self.write("environment.getattr(")
  1455. self.visit(node.node, frame)
  1456. self.write(f", {node.attr!r})")
  1457. if self.environment.is_async:
  1458. self.write("))")
  1459. @optimizeconst
  1460. def visit_Getitem(self, node: nodes.Getitem, frame: Frame) -> None:
  1461. # slices bypass the environment getitem method.
  1462. if isinstance(node.arg, nodes.Slice):
  1463. self.visit(node.node, frame)
  1464. self.write("[")
  1465. self.visit(node.arg, frame)
  1466. self.write("]")
  1467. else:
  1468. if self.environment.is_async:
  1469. self.write("(await auto_await(")
  1470. self.write("environment.getitem(")
  1471. self.visit(node.node, frame)
  1472. self.write(", ")
  1473. self.visit(node.arg, frame)
  1474. self.write(")")
  1475. if self.environment.is_async:
  1476. self.write("))")
  1477. def visit_Slice(self, node: nodes.Slice, frame: Frame) -> None:
  1478. if node.start is not None:
  1479. self.visit(node.start, frame)
  1480. self.write(":")
  1481. if node.stop is not None:
  1482. self.visit(node.stop, frame)
  1483. if node.step is not None:
  1484. self.write(":")
  1485. self.visit(node.step, frame)
  1486. @contextmanager
  1487. def _filter_test_common(
  1488. self, node: t.Union[nodes.Filter, nodes.Test], frame: Frame, is_filter: bool
  1489. ) -> t.Iterator[None]:
  1490. if self.environment.is_async:
  1491. self.write("await auto_await(")
  1492. if is_filter:
  1493. self.write(f"{self.filters[node.name]}(")
  1494. func = self.environment.filters.get(node.name)
  1495. else:
  1496. self.write(f"{self.tests[node.name]}(")
  1497. func = self.environment.tests.get(node.name)
  1498. # When inside an If or CondExpr frame, allow the filter to be
  1499. # undefined at compile time and only raise an error if it's
  1500. # actually called at runtime. See pull_dependencies.
  1501. if func is None and not frame.soft_frame:
  1502. type_name = "filter" if is_filter else "test"
  1503. self.fail(f"No {type_name} named {node.name!r}.", node.lineno)
  1504. pass_arg = {
  1505. _PassArg.context: "context",
  1506. _PassArg.eval_context: "context.eval_ctx",
  1507. _PassArg.environment: "environment",
  1508. }.get(
  1509. _PassArg.from_obj(func) # type: ignore
  1510. )
  1511. if pass_arg is not None:
  1512. self.write(f"{pass_arg}, ")
  1513. # Back to the visitor function to handle visiting the target of
  1514. # the filter or test.
  1515. yield
  1516. self.signature(node, frame)
  1517. self.write(")")
  1518. if self.environment.is_async:
  1519. self.write(")")
  1520. @optimizeconst
  1521. def visit_Filter(self, node: nodes.Filter, frame: Frame) -> None:
  1522. with self._filter_test_common(node, frame, True):
  1523. # if the filter node is None we are inside a filter block
  1524. # and want to write to the current buffer
  1525. if node.node is not None:
  1526. self.visit(node.node, frame)
  1527. elif frame.eval_ctx.volatile:
  1528. self.write(
  1529. f"(Markup(concat({frame.buffer}))"
  1530. f" if context.eval_ctx.autoescape else concat({frame.buffer}))"
  1531. )
  1532. elif frame.eval_ctx.autoescape:
  1533. self.write(f"Markup(concat({frame.buffer}))")
  1534. else:
  1535. self.write(f"concat({frame.buffer})")
  1536. @optimizeconst
  1537. def visit_Test(self, node: nodes.Test, frame: Frame) -> None:
  1538. with self._filter_test_common(node, frame, False):
  1539. self.visit(node.node, frame)
  1540. @optimizeconst
  1541. def visit_CondExpr(self, node: nodes.CondExpr, frame: Frame) -> None:
  1542. frame = frame.soft()
  1543. def write_expr2() -> None:
  1544. if node.expr2 is not None:
  1545. self.visit(node.expr2, frame)
  1546. return
  1547. self.write(
  1548. f'cond_expr_undefined("the inline if-expression on'
  1549. f" {self.position(node)} evaluated to false and no else"
  1550. f' section was defined.")'
  1551. )
  1552. self.write("(")
  1553. self.visit(node.expr1, frame)
  1554. self.write(" if ")
  1555. self.visit(node.test, frame)
  1556. self.write(" else ")
  1557. write_expr2()
  1558. self.write(")")
  1559. @optimizeconst
  1560. def visit_Call(
  1561. self, node: nodes.Call, frame: Frame, forward_caller: bool = False
  1562. ) -> None:
  1563. if self.environment.is_async:
  1564. self.write("await auto_await(")
  1565. if self.environment.sandboxed:
  1566. self.write("environment.call(context, ")
  1567. else:
  1568. self.write("context.call(")
  1569. self.visit(node.node, frame)
  1570. extra_kwargs = {"caller": "caller"} if forward_caller else None
  1571. loop_kwargs = {"_loop_vars": "_loop_vars"} if frame.loop_frame else {}
  1572. block_kwargs = {"_block_vars": "_block_vars"} if frame.block_frame else {}
  1573. if extra_kwargs:
  1574. extra_kwargs.update(loop_kwargs, **block_kwargs)
  1575. elif loop_kwargs or block_kwargs:
  1576. extra_kwargs = dict(loop_kwargs, **block_kwargs)
  1577. self.signature(node, frame, extra_kwargs)
  1578. self.write(")")
  1579. if self.environment.is_async:
  1580. self.write(")")
  1581. def visit_Keyword(self, node: nodes.Keyword, frame: Frame) -> None:
  1582. self.write(node.key + "=")
  1583. self.visit(node.value, frame)
  1584. # -- Unused nodes for extensions
  1585. def visit_MarkSafe(self, node: nodes.MarkSafe, frame: Frame) -> None:
  1586. self.write("Markup(")
  1587. self.visit(node.expr, frame)
  1588. self.write(")")
  1589. def visit_MarkSafeIfAutoescape(
  1590. self, node: nodes.MarkSafeIfAutoescape, frame: Frame
  1591. ) -> None:
  1592. self.write("(Markup if context.eval_ctx.autoescape else identity)(")
  1593. self.visit(node.expr, frame)
  1594. self.write(")")
  1595. def visit_EnvironmentAttribute(
  1596. self, node: nodes.EnvironmentAttribute, frame: Frame
  1597. ) -> None:
  1598. self.write("environment." + node.name)
  1599. def visit_ExtensionAttribute(
  1600. self, node: nodes.ExtensionAttribute, frame: Frame
  1601. ) -> None:
  1602. self.write(f"environment.extensions[{node.identifier!r}].{node.name}")
  1603. def visit_ImportedName(self, node: nodes.ImportedName, frame: Frame) -> None:
  1604. self.write(self.import_aliases[node.importname])
  1605. def visit_InternalName(self, node: nodes.InternalName, frame: Frame) -> None:
  1606. self.write(node.name)
  1607. def visit_ContextReference(
  1608. self, node: nodes.ContextReference, frame: Frame
  1609. ) -> None:
  1610. self.write("context")
  1611. def visit_DerivedContextReference(
  1612. self, node: nodes.DerivedContextReference, frame: Frame
  1613. ) -> None:
  1614. self.write(self.derive_context(frame))
  1615. def visit_Continue(self, node: nodes.Continue, frame: Frame) -> None:
  1616. self.writeline("continue", node)
  1617. def visit_Break(self, node: nodes.Break, frame: Frame) -> None:
  1618. self.writeline("break", node)
  1619. def visit_Scope(self, node: nodes.Scope, frame: Frame) -> None:
  1620. scope_frame = frame.inner()
  1621. scope_frame.symbols.analyze_node(node)
  1622. self.enter_frame(scope_frame)
  1623. self.blockvisit(node.body, scope_frame)
  1624. self.leave_frame(scope_frame)
  1625. def visit_OverlayScope(self, node: nodes.OverlayScope, frame: Frame) -> None:
  1626. ctx = self.temporary_identifier()
  1627. self.writeline(f"{ctx} = {self.derive_context(frame)}")
  1628. self.writeline(f"{ctx}.vars = ")
  1629. self.visit(node.context, frame)
  1630. self.push_context_reference(ctx)
  1631. scope_frame = frame.inner(isolated=True)
  1632. scope_frame.symbols.analyze_node(node)
  1633. self.enter_frame(scope_frame)
  1634. self.blockvisit(node.body, scope_frame)
  1635. self.leave_frame(scope_frame)
  1636. self.pop_context_reference()
  1637. def visit_EvalContextModifier(
  1638. self, node: nodes.EvalContextModifier, frame: Frame
  1639. ) -> None:
  1640. for keyword in node.options:
  1641. self.writeline(f"context.eval_ctx.{keyword.key} = ")
  1642. self.visit(keyword.value, frame)
  1643. try:
  1644. val = keyword.value.as_const(frame.eval_ctx)
  1645. except nodes.Impossible:
  1646. frame.eval_ctx.volatile = True
  1647. else:
  1648. setattr(frame.eval_ctx, keyword.key, val)
  1649. def visit_ScopedEvalContextModifier(
  1650. self, node: nodes.ScopedEvalContextModifier, frame: Frame
  1651. ) -> None:
  1652. old_ctx_name = self.temporary_identifier()
  1653. saved_ctx = frame.eval_ctx.save()
  1654. self.writeline(f"{old_ctx_name} = context.eval_ctx.save()")
  1655. self.visit_EvalContextModifier(node, frame)
  1656. for child in node.body:
  1657. self.visit(child, frame)
  1658. frame.eval_ctx.revert(saved_ctx)
  1659. self.writeline(f"context.eval_ctx.revert({old_ctx_name})")