第7章：函数装饰器和闭包-变量作用域规则、闭包、nonlocal 声明

Python 的变量作用域规则

先来看一段示例：

b = 6


def func(a):
    print(a)
    print(b)
    b = 9


func(3)

上面的代码中，a 变量会正常打印，打印 b 的变量时竟然会报错：UnboundLocalError: local variable 'b' referenced before assignment，这是为什么呢？

这是因为 Python 在编译函数的定义体时，判断 b 是局部变量，而不是全局变量，因为 b 在函数体中被赋值了，在调用函数打印 b 时，发现在局部变量中查找不到 b 绑定的值，所以会报错；

这一点是设计如此，Python 不要求声明变量，但是会假定在函数体中赋值的变量为局部变量；

如果要避免报错，需要在函数体的顶部声明变量是全局变量：

b = 6


def func(a):
    # 声明 b 为全局变量
    global b
    print(a)
    print(b)
    b = 9  # 修改全局变量


func(3)

print(b)  # 9

闭包

闭包是指延伸了作用域的函数，其中包含了函数定义体中引用，但是不再定义体中定义的非全局变量；

这里面还涉及到一个名词：自由变量，就是上面所说的在函数定义体中引用，但是不在函数定义体中定义的非全局变量。

# 假如有个名为 avg 的函数，它的作用是计算不断增加的系列值的平均值
def make_average():
    # =============================两行注释之间便是闭包=========================
    series_value = []

    def averager(value):
        series_value.append(value)  # series_value：自由变量，函数定义体中引用、但是不再定义体中定义的非全局变量；
        total = sum(series_value)
        avg_value = total / len(series_value)
        return avg_value
    # =============================两行注释之间便是闭包=========================
    return averager


if __name__ == '__main__':
    avg = make_average()
    print(avg(3))  # 3.0
    print(avg(6))  # 4.5
    print(avg(9))  # 6.0
    print(avg(12))  # 7.5

审查 make_average 返回的 averager 对象，我们发现  Python 在 __code__ 属性中保存的局部变量和自由变量的名称：

print(avg.__code__.co_varnames)  # ('value', 'total', 'avg_value')
print(avg.__code__.co_freevars)  # ('series_value',)

series_value 的值绑定在返回的 avg 函数的 __closure__ 属性中。avg.__closuer__ 中的各个元素对应于 avg.__code__.co_freevars 中的一个名称。这些是 cell 对象，有个 cell_contents 属性，保存着真正的值：

print(avg.__closure__)  # (<cell at 0x10a9cdaf8: list object at 0x10a8d7f88>,)
print(avg.__closure__[0].cell_contents)  # [3, 6, 9, 12]

综上，闭包是一种函数，它会保留定义函数时存在的自由变量的绑定，这样调用函数时，虽然定义作用域不可用了，但是仍然可以使用那些绑定。

nonlocal 声明

前面 make_average 实现的效率并不高，因为它每次都要计算历史系列值的总和，更好的实现方式是只存储目前的总值和元素个数，然后用这两个值计算均值：

def make_average():
    # =============================两行注释之间便是闭包=========================
    total = 0
    count = 0

    def averager(value):
        total += value
        count += 1
        avg_value = total / count
        return avg_value

    # =============================两行注释之间便是闭包=========================
    return averager


if __name__ == '__main__':
    avg = make_average()
    print(avg(3))  # UnboundLocalError: local variable 'total' referenced before assignment

上面的代码思路是没问题的，但是在执行时会报错：UnboundLocalError: local variable 'total' referenced before assignment，问题是当自由变量 total、count 是数字或者任何不可变类型时，count += 1 的作用其实与 count = count + 1 一样，因此这相当于我们在 averager 定义体中为 count 赋值了，这会把 count 变成局部变量，但是在局部变量中又找不到 count 局部变量，所以会出现此错误。

那么为什么在上一个实例中没有问题呢，那是因为上个实例中的自由变量 series_value 是可变类型，我们只是调用 series_value.append，更新了它本身的元素，没有给它重新赋值，但是对于不可变类型来说，只能读取，不能更新。如果尝试 count += 1 的操作，其实会隐式的创建局部变量，这样 count 就不是自由变量了，因此不会保留在闭包中。

为了解决这个问题，Python3 引入了 nonlocal 声明，它的作用就是把变量标记为自由变量，即使在函数中为变量重新赋值了，它也是自由变量。如果为 nonlocal 声明的变量赋予了新的值，闭包中保存的绑定会同步更新：

def make_average():
    # =============================两行注释之间便是闭包=========================
    total = 0
    count = 0

    def averager(value):
        nonlocal total, count  # 声明自由变量
        total += value
        count += 1
        avg_value = total / count
        return avg_value

    # =============================两行注释之间便是闭包=========================
    return averager


if __name__ == '__main__':
    avg = make_average()
    print(avg(3))  # 3.0
    print(avg(6))  # 4.5
    print(avg(9))  # 6.0
    print(avg(12))  # 7.5