Mako 模板中重复使用的变量会导致“UnboundLocalError：局部变量‘xyz’”赋值前引用”

Question

我有这个“有趣”的问题。我知道这个错误消息在很多地方都可以找到，但我找不到与 Mako 明确相关的错误消息。

在 Mako 模板中，我有 (snippet):

<%inherit file="other.mako"/>
<%def name="my_method()">Search for ${label}</%def>
[...]
<h2>${label.capitalize()} found: ${len(l)}</h2>
...
<ol>
% for (label, field_name) in some_list:
    <li>${label}: ${field_name}</li>
% endfor
</ol>

并且我会收到错误：

UnboundLocalError: local variable 'label' referenced before assignment

奇怪的是，如果我不使用第二个 ${label.capitalize()}，我不没有收到任何错误，并且 <%def> 中的 ${label} 的值是我想要的值，而不是 for 循环中的值。如果我对 <%def> 中的变量有同样的错误，那么很明显不重用相同的变量名，但在这种情况下，我对发生这种事情感到非常困惑。

谁能告诉我除了在 for 循环中重命名变量 label 之外，如何避免这种情况？如果我重命名 for 循环变量名称，问题就会消失。我正在从另一个没有此类错误的模板系统转移，因此这种类似的情况经常发生。

感谢您的任何指示，

D。

编辑清楚：

我使用以下方式调用我的模板：

renderers.render_to_response(my_mako_tmpl,
         {'label': 'value', 'somelist':[a,b,c], 'l':[]},
         request=request)

我的问题是：为什么我有 % for (label , field_name)-循环，变量 label 给我带来了 ${label.capitalize()} 中的错误，因为它没有给我任何搜索 ${label} 时出错。

如果我将 for 循环更改为：

% for (label_name, field_name) in some_list:

我不会收到错误。

如果我不更改 for 循环，但更改为：

<h2>${label.capitalize()} found: ${len(l)}</h2>

即使

<h2>Items found: ${len(l)}</h2>

在我的 <%def> 中使用 ${label} ，我也不会收到错误。

另外，为了添加模板使用信息，我添加了 <%inherit> ，以下是 other.mako 的定义方式（片段）：

<%def name="my_method()">Default value</%def>
Value of my_method() = ${self.my_method()}

所以我不'不需要将任何值传递给my_method()。

希望这能让问题更清楚。

Answer 1

最好将 Mako 模板视为类似于一段 Python 代码。因此，就像在 python 中一样，如果您希望变量同时具有本地作用域和全局（或嵌套作用域），则会遇到问题。

将模板视为一个接受变量的函数，并在其中定义各种其他函数（包括 body() 函数），那么您的问题实际上类似于以下内容

>>> def f(x):
...     def body():
...         print x
...         for x in range(5):
...             print x
...     body()
... 
>>> f(1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 6, in f
  File "<stdin>", line 3, in body
UnboundLocalError: local variable 'x' referenced before assignment

您不应该期望它能够在Python，同样，您不应该期望它能够在 Mako 模板中工作。

Answer 2

我认为您需要在 my_method 参数中包含标签。

<%def name="my_method(label)">Search for ${label}</%def>
[...]
<h2>${label.capitalize()} found: ${len(l)}</h2>
...
<ol>
% for (label, field_name) in some_list:
    <li>${label}: ${field_name}</li>
% endfor
</ol>

后续

据我所知，您必须更改循环变量名称。这可能是 Mako 或 Python 命名空间的细微差别，我并不完全理解，但这似乎是最安全的选择。在我看来，重用这样的变量名无论如何都是不好的形式，会导致意外的行为，容易出错等。

从我的评估来看，这可能是 mako 处理命名空间的一个特性。考虑以下示例。第一个引发相同的 UnboundLocalError 异常。第二个结构相同，不会引发异常。

示例 1 引发 UnboundLocalError：

from mako.template import Template

src = """
Text in "label": ${label}
Elements of "some_list": ${some_list}

Labels and names in "some_list"
% for (label,name) in some_list:
    label: name -> ${label}: ${name}
% endfor

${label.capitalize()}
"""

my_template = Template(src)

s = [('foo', 'bar'), ('spam', 'eggs')]
data = {'label': 'bogus', 'some_list':s, 'l':[1, 2, 3, 4]}

print(my_template.render(**data))

输出：

    Traceback (most recent call last):

      ...

      File "C:\Python26\ArcGIS10.0\Lib\site-packages\mako-0.6.2-py2.6.egg\mako\runtime.py", line 704, in _exec_template
        callable_(context, *args, **kwargs)
      File "memory:0xb5b6b0", line 22, in render_body
    UnboundLocalError: local variable 'label' referenced before assignment

示例 2 评估成功：

from mako.template import Template

src = """
Text in "label": ${label}
Elements of "some_list": ${some_list}

Labels and names in "some_list"
% for (loop_label,name) in some_list:
    label: name -> ${loop_label}: ${name}
% endfor

${label.capitalize()}
"""

my_template = Template(src)

s = [('foo', 'bar'), ('spam', 'eggs')]
data = {'label': 'bogus', 'some_list':s, 'l':[1, 2, 3, 4]}

print(my_template.render(**data))

输出：

    Text in "label": eggs
    Elements of "some_list": [('foo', 'bar'), ('spam', 'eggs')]

    Labels and names in "some_list"
        label: name -> foo: bar
        label: name -> spam: eggs

    Eggs

为了证明 Mako 没有像您预期的那样评估模板，这里有一个结构类似的纯 Python 示例，它的评估效果很好。

src = """
print('Text in "label": %s' % label)
print('Elements of "some_list": %s' % some_list)

print('')
print('Labels and names in "some_list"')
for (label,name) in some_list:
    print('    label: name -> %s:%s' % (label, name))

print('')
print('Caps "label": %s' % label.capitalize())
"""

code = compile(src, 'None', 'exec')

s = [('foo', 'bar'), ('spam', 'eggs')]
data = {'label': 'bogus', 'some_list':s, 'l':[1, 2, 3, 4]}

eval(code, {}, data)

输出：

    Text in "label": bogus
    Elements of "some_list": [('foo', 'bar'), ('spam', 'eggs')]

    Labels and names in "some_list"
        label: name -> foo:bar
        label: name -> spam:eggs

    Caps "label": Spam