嵌套函数中的局部变量

Local variables in nested functions

提问人:noio 提问时间:9/14/2012 最后编辑:martineaunoio 更新时间:10/6/2022 访问量:15228

问:

好吧,请耐心等待,我知道它看起来会非常复杂,但请帮助我了解正在发生的事情。

from functools import partial

class Cage(object):
    def __init__(self, animal):
        self.animal = animal

def gotimes(do_the_petting):
    do_the_petting()

def get_petters():
    for animal in ['cow', 'dog', 'cat']:
        cage = Cage(animal)

        def pet_function():
            print "Mary pets the " + cage.animal + "."

        yield (animal, partial(gotimes, pet_function))

funs = list(get_petters())

for name, f in funs:
    print name + ":", 
    f()

给:

cow: Mary pets the cat.
dog: Mary pets the cat.
cat: Mary pets the cat.

所以基本上,为什么我没有得到三种不同的动物?“打包”不是嵌套函数的本地范围吗?如果不是,对嵌套函数的调用如何查找局部变量?cage

我知道遇到这类问题通常意味着一个人“做错了”,但我想知道会发生什么。

python 范围 闭包 nested-function

评论

1赞 Jon Clements 9/14/2012
尝试。。。我相信有人会过来解释这一点——这是 Python 的陷阱之一:)for animal in ['cat', 'dog', 'cow']

答:

122赞 Martijn Pieters 9/14/2012 #1

嵌套函数在执行时从父作用域中查找变量,而不是在定义时查找变量。

编译函数体,并验证“free”变量(未在函数本身中通过赋值定义),然后作为闭包单元格绑定到函数,代码使用索引来引用每个单元格。 因此有一个自由变量 (),然后通过闭包单元格 index 0 引用该变量。闭包本身指向函数中的局部变量。pet_functioncagecageget_petters

当您实际调用该函数时,该闭包将用于在调用该函数时查看周围作用域中的值。这就是问题所在。当您调用函数时,该函数已经完成了对其结果的计算。在执行过程中的某个时间点,局部变量被分配了每个 、 和 字符串,但在函数的末尾,包含最后一个值 。因此,当您调用每个动态返回的函数时,您将获得打印的值。cageget_petterscage'cow''dog''cat'cage'cat''cat'

解决方法是不依赖闭包。您可以改用分部函数、创建新的函数作用域或将变量绑定为关键字参数的默认值

  • 分部函数示例,使用 functools.partial():

    from functools import partial
    
    def pet_function(cage=None):
        print "Mary pets the " + cage.animal + "."
    
    yield (animal, partial(gotimes, partial(pet_function, cage=cage)))
    
  • 创建新的范围示例:

    def scoped_cage(cage=None):
        def pet_function():
            print "Mary pets the " + cage.animal + "."
        return pet_function
    
    yield (animal, partial(gotimes, scoped_cage(cage)))
    
  • 将变量绑定为关键字参数的默认值:

    def pet_function(cage=cage):
        print "Mary pets the " + cage.animal + "."
    
    yield (animal, partial(gotimes, pet_function))
    

无需在循环中定义函数,编译只进行一次,而不是在循环的每次迭代中进行。scoped_cage

评论

1赞 DrEsperanto 3/7/2018
今天,我在这面墙上撞了 3 个小时,写着工作脚本。你的最后一点很重要,也是我遇到这个问题的主要原因。我在整个代码中都有大量带有闭包的回调,但是在循环中尝试相同的技术是我的原因。
7赞 Andy Hayden 9/14/2012 #2

这源于以下几点

for i in range(2): 
    pass

print(i)  # prints 1

迭代后,的值被懒惰地存储为其最终值。i

作为生成器,该函数将起作用(即依次打印每个值),但是当转换为列表时,它会在生成器上运行,因此所有对 () 的调用都会返回 cats。cagecage.animal

12赞 Nicolas Barbey 9/14/2012 #3

我的理解是,当实际调用生成的pet_function时,而不是之前,会在父函数命名空间中寻找 cage。

所以当你这样做时

funs = list(get_petters())

您将生成 3 个函数,这些函数将找到最后创建的笼子。

如果将最后一个循环替换为 :

for name, f in get_petters():
    print name + ":", 
    f()

你实际上会得到:

cow: Mary pets the cow.
dog: Mary pets the dog.
cat: Mary pets the cat.
1赞 Mateen Ulhaq 1/21/2020 #4

让我们简化这个问题。定义:

def get_petters():
    for animal in ['cow', 'dog', 'cat']:
        def pet_function():
            return "Mary pets the " + animal + "."

        yield (animal, pet_function)

然后,就像在问题中一样,我们得到:

>>> for name, f in list(get_petters()):
...     print(name + ":", f())

cow: Mary pets the cat.
dog: Mary pets the cat.
cat: Mary pets the cat.

但是,如果我们避免创建第一个:list()

>>> for name, f in get_petters():
...     print(name + ":", f())

cow: Mary pets the cow.
dog: Mary pets the dog.
cat: Mary pets the cat.

这是怎么回事?为什么这种细微的差异会完全改变我们的结果?


如果我们看一下,从不断变化的内存地址中可以清楚地看出,我们确实产生了三个不同的函数:list(get_petters())

>>> list(get_petters())

[('cow', <function get_petters.<locals>.pet_function at 0x7ff2b988d790>),
 ('dog', <function get_petters.<locals>.pet_function at 0x7ff2c18f51f0>),
 ('cat', <function get_petters.<locals>.pet_function at 0x7ff2c14a9f70>)]

但是,请看一下这些函数绑定到的 s:cell

>>> for _, f in list(get_petters()):
...     print(f(), f.__closure__)

Mary pets the cat. (<cell at 0x7ff2c112a9d0: str object at 0x7ff2c3f437f0>,)
Mary pets the cat. (<cell at 0x7ff2c112a9d0: str object at 0x7ff2c3f437f0>,)
Mary pets the cat. (<cell at 0x7ff2c112a9d0: str object at 0x7ff2c3f437f0>,)

>>> for _, f in get_petters():
...     print(f(), f.__closure__)

Mary pets the cow. (<cell at 0x7ff2b86b5d00: str object at 0x7ff2c1a95670>,)
Mary pets the dog. (<cell at 0x7ff2b86b5d00: str object at 0x7ff2c1a952f0>,)
Mary pets the cat. (<cell at 0x7ff2b86b5d00: str object at 0x7ff2c3f437f0>,)

对于这两个循环,单元格对象在整个迭代过程中保持不变。但是,正如预期的那样,它在第二个循环中引用的特定内容会有所不同。该对象引用 ,它是在调用时创建的。但是,更改它在运行生成器函数时引用的对象。strcellanimalget_petters()animalstr

在第一个循环中,在每次迭代中,我们创建所有 s,但我们只有在生成器完全耗尽并且已经创建了函数之后才调用它们。fget_petters()list

在第二个循环中,在每次迭代期间,我们都会暂停生成器,并在每次暂停后调用。因此,我们最终检索了生成器函数暂停的那一刻的值。get_petters()fanimal

正如@Claudiu对类似问题的回答:

创建了三个独立的函数,但它们每个函数都具有定义它们所处的环境的闭包 - 在本例中为全局环境(如果循环放置在另一个函数中,则为外部函数的环境)。不过,这正是问题所在——在这种环境中,是变异的,并且闭包都引用了相同的内容。animalanimal

[编者注:已更改为 .]ianimal