test_idtracking.py 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. from jinja2 import nodes
  2. from jinja2.idtracking import symbols_for_node
  3. def test_basics():
  4. for_loop = nodes.For(
  5. nodes.Name("foo", "store"),
  6. nodes.Name("seq", "load"),
  7. [nodes.Output([nodes.Name("foo", "load")])],
  8. [],
  9. None,
  10. False,
  11. )
  12. tmpl = nodes.Template(
  13. [nodes.Assign(nodes.Name("foo", "store"), nodes.Name("bar", "load")), for_loop]
  14. )
  15. sym = symbols_for_node(tmpl)
  16. assert sym.refs == {
  17. "foo": "l_0_foo",
  18. "bar": "l_0_bar",
  19. "seq": "l_0_seq",
  20. }
  21. assert sym.loads == {
  22. "l_0_foo": ("undefined", None),
  23. "l_0_bar": ("resolve", "bar"),
  24. "l_0_seq": ("resolve", "seq"),
  25. }
  26. sym = symbols_for_node(for_loop, sym)
  27. assert sym.refs == {
  28. "foo": "l_1_foo",
  29. }
  30. assert sym.loads == {
  31. "l_1_foo": ("param", None),
  32. }
  33. def test_complex():
  34. title_block = nodes.Block(
  35. "title", [nodes.Output([nodes.TemplateData("Page Title")])], False, False
  36. )
  37. render_title_macro = nodes.Macro(
  38. "render_title",
  39. [nodes.Name("title", "param")],
  40. [],
  41. [
  42. nodes.Output(
  43. [
  44. nodes.TemplateData('\n <div class="title">\n <h1>'),
  45. nodes.Name("title", "load"),
  46. nodes.TemplateData("</h1>\n <p>"),
  47. nodes.Name("subtitle", "load"),
  48. nodes.TemplateData("</p>\n "),
  49. ]
  50. ),
  51. nodes.Assign(
  52. nodes.Name("subtitle", "store"), nodes.Const("something else")
  53. ),
  54. nodes.Output(
  55. [
  56. nodes.TemplateData("\n <p>"),
  57. nodes.Name("subtitle", "load"),
  58. nodes.TemplateData("</p>\n </div>\n"),
  59. nodes.If(
  60. nodes.Name("something", "load"),
  61. [
  62. nodes.Assign(
  63. nodes.Name("title_upper", "store"),
  64. nodes.Filter(
  65. nodes.Name("title", "load"),
  66. "upper",
  67. [],
  68. [],
  69. None,
  70. None,
  71. ),
  72. ),
  73. nodes.Output(
  74. [
  75. nodes.Name("title_upper", "load"),
  76. nodes.Call(
  77. nodes.Name("render_title", "load"),
  78. [nodes.Const("Aha")],
  79. [],
  80. None,
  81. None,
  82. ),
  83. ]
  84. ),
  85. ],
  86. [],
  87. [],
  88. ),
  89. ]
  90. ),
  91. ],
  92. )
  93. for_loop = nodes.For(
  94. nodes.Name("item", "store"),
  95. nodes.Name("seq", "load"),
  96. [
  97. nodes.Output(
  98. [
  99. nodes.TemplateData("\n <li>"),
  100. nodes.Name("item", "load"),
  101. nodes.TemplateData("</li>\n <span>"),
  102. ]
  103. ),
  104. nodes.Include(nodes.Const("helper.html"), True, False),
  105. nodes.Output([nodes.TemplateData("</span>\n ")]),
  106. ],
  107. [],
  108. None,
  109. False,
  110. )
  111. body_block = nodes.Block(
  112. "body",
  113. [
  114. nodes.Output(
  115. [
  116. nodes.TemplateData("\n "),
  117. nodes.Call(
  118. nodes.Name("render_title", "load"),
  119. [nodes.Name("item", "load")],
  120. [],
  121. None,
  122. None,
  123. ),
  124. nodes.TemplateData("\n <ul>\n "),
  125. ]
  126. ),
  127. for_loop,
  128. nodes.Output([nodes.TemplateData("\n </ul>\n")]),
  129. ],
  130. False,
  131. False,
  132. )
  133. tmpl = nodes.Template(
  134. [
  135. nodes.Extends(nodes.Const("layout.html")),
  136. title_block,
  137. render_title_macro,
  138. body_block,
  139. ]
  140. )
  141. tmpl_sym = symbols_for_node(tmpl)
  142. assert tmpl_sym.refs == {
  143. "render_title": "l_0_render_title",
  144. }
  145. assert tmpl_sym.loads == {
  146. "l_0_render_title": ("undefined", None),
  147. }
  148. assert tmpl_sym.stores == {"render_title"}
  149. assert tmpl_sym.dump_stores() == {
  150. "render_title": "l_0_render_title",
  151. }
  152. macro_sym = symbols_for_node(render_title_macro, tmpl_sym)
  153. assert macro_sym.refs == {
  154. "subtitle": "l_1_subtitle",
  155. "something": "l_1_something",
  156. "title": "l_1_title",
  157. "title_upper": "l_1_title_upper",
  158. }
  159. assert macro_sym.loads == {
  160. "l_1_subtitle": ("resolve", "subtitle"),
  161. "l_1_something": ("resolve", "something"),
  162. "l_1_title": ("param", None),
  163. "l_1_title_upper": ("resolve", "title_upper"),
  164. }
  165. assert macro_sym.stores == {"title", "title_upper", "subtitle"}
  166. assert macro_sym.find_ref("render_title") == "l_0_render_title"
  167. assert macro_sym.dump_stores() == {
  168. "title": "l_1_title",
  169. "title_upper": "l_1_title_upper",
  170. "subtitle": "l_1_subtitle",
  171. "render_title": "l_0_render_title",
  172. }
  173. body_sym = symbols_for_node(body_block)
  174. assert body_sym.refs == {
  175. "item": "l_0_item",
  176. "seq": "l_0_seq",
  177. "render_title": "l_0_render_title",
  178. }
  179. assert body_sym.loads == {
  180. "l_0_item": ("resolve", "item"),
  181. "l_0_seq": ("resolve", "seq"),
  182. "l_0_render_title": ("resolve", "render_title"),
  183. }
  184. assert body_sym.stores == set()
  185. for_sym = symbols_for_node(for_loop, body_sym)
  186. assert for_sym.refs == {
  187. "item": "l_1_item",
  188. }
  189. assert for_sym.loads == {
  190. "l_1_item": ("param", None),
  191. }
  192. assert for_sym.stores == {"item"}
  193. assert for_sym.dump_stores() == {
  194. "item": "l_1_item",
  195. }
  196. def test_if_branching_stores():
  197. tmpl = nodes.Template(
  198. [
  199. nodes.If(
  200. nodes.Name("expression", "load"),
  201. [nodes.Assign(nodes.Name("variable", "store"), nodes.Const(42))],
  202. [],
  203. [],
  204. )
  205. ]
  206. )
  207. sym = symbols_for_node(tmpl)
  208. assert sym.refs == {"variable": "l_0_variable", "expression": "l_0_expression"}
  209. assert sym.stores == {"variable"}
  210. assert sym.loads == {
  211. "l_0_variable": ("resolve", "variable"),
  212. "l_0_expression": ("resolve", "expression"),
  213. }
  214. assert sym.dump_stores() == {
  215. "variable": "l_0_variable",
  216. }
  217. def test_if_branching_stores_undefined():
  218. tmpl = nodes.Template(
  219. [
  220. nodes.Assign(nodes.Name("variable", "store"), nodes.Const(23)),
  221. nodes.If(
  222. nodes.Name("expression", "load"),
  223. [nodes.Assign(nodes.Name("variable", "store"), nodes.Const(42))],
  224. [],
  225. [],
  226. ),
  227. ]
  228. )
  229. sym = symbols_for_node(tmpl)
  230. assert sym.refs == {"variable": "l_0_variable", "expression": "l_0_expression"}
  231. assert sym.stores == {"variable"}
  232. assert sym.loads == {
  233. "l_0_variable": ("undefined", None),
  234. "l_0_expression": ("resolve", "expression"),
  235. }
  236. assert sym.dump_stores() == {
  237. "variable": "l_0_variable",
  238. }
  239. def test_if_branching_multi_scope():
  240. for_loop = nodes.For(
  241. nodes.Name("item", "store"),
  242. nodes.Name("seq", "load"),
  243. [
  244. nodes.If(
  245. nodes.Name("expression", "load"),
  246. [nodes.Assign(nodes.Name("x", "store"), nodes.Const(42))],
  247. [],
  248. [],
  249. ),
  250. nodes.Include(nodes.Const("helper.html"), True, False),
  251. ],
  252. [],
  253. None,
  254. False,
  255. )
  256. tmpl = nodes.Template(
  257. [nodes.Assign(nodes.Name("x", "store"), nodes.Const(23)), for_loop]
  258. )
  259. tmpl_sym = symbols_for_node(tmpl)
  260. for_sym = symbols_for_node(for_loop, tmpl_sym)
  261. assert for_sym.stores == {"item", "x"}
  262. assert for_sym.loads == {
  263. "l_1_x": ("alias", "l_0_x"),
  264. "l_1_item": ("param", None),
  265. "l_1_expression": ("resolve", "expression"),
  266. }