526互联

Python中的UnboundLocalError是什么错误？怎样解决？详解全局变量、局部变量与关键字global

发布时间 2023-11-20 23:01:35作者: overxus

在一个月黑风高的夜晚，我们满心欢喜地写出以下代码：

money = 10000  # 当前的财产，单位为元


def add_money(value):
    money += value


print('当前财产: ', money)
add_money(10)
print('当前财产: ', money)

以上代码中，定义了函数add_money, 将money增加value. 我们期待着运行代码后，程序能够依次输出10000和10010. 可惜事与愿违，运行后程序会报以下错误：

  money += value
     ^^^^^

UnboundLocalError: cannot access local variable 'money' where it is not associated with a value

根据报错信息，money += value这行代码出现了错误，而且报错为UnboundLocalError.：无法访问局部变量money.

那么，什么是局部变量（local variable）呢？为了搞清楚这个问题，我们首先需要了解Python中变量的作用域。

 

1. 变量的作用域

所谓的作用域，指的是可以访问到变量的范围。请看下面这个例子：

def add(a, b):
    c = a + b
    return c


print(c)

这段代码运行时会报错，编译器会提示未定义变量c：因为变量c定义在函数add内部，函数外是访问不到变量c的。因此，可以说变量c的作用域在函数add内部。

 

再来看下面这段代码：

name = '高尔夫的基'


def print_name():
    print(name)


print_name()

这段代码可以正常运行。变量name定义在函数print_name外部，但是函数能访问到这个变量。定义在模块顶层的变量，类似于这里的name，我们称之为全局变量（global variable）.

如果你不太明白什么叫定义在模块顶层的变量，可以理解为在函数外定义的变量。

 

2. 局部变量

现在，来看下面这段代码：

name = '高尔夫的基'


def print_name():
    name = '赵奔三'
    print(name)


print_name()
print(name)

上述代码运行后，输出如下：

赵奔三
高尔夫的基

在函数print_name内，将变量name赋值为字符串 '赵奔三' ，因此调用print_name()后，会输出字符串'赵奔三', 这并不奇怪。“奇怪”的是，代码运行到print(name)后，会输出字符串'高尔夫的基', 看起来全局变量name没有受到函数print_name的影响，这是为什么呢？

在Python中，当变量名出现在赋值运算符（也就是=，当然+=, -=这种也算）的左边时，会创建一个新的变量，这样的变量称为局部变量。例如，在函数print_name中，对于name = '赵奔三'这行代码，在=的左边出现了变量名name，Python就会创建一个局部变量name供函数print_name内部使用。

为什么要这么设计呢？大家可以想一想，如果一个变量可以在代码的任意位置被随意修改，随着我们的代码越写越长，如果哪天不小心定义了一个同名的变量，那么这个变量到底代表什么呢？从而，我们的代码会更容易出错。

 

说到这里，我必须强调一点：在函数体内部，当变量名出现在赋值运算符的左边时，才会创建局部变量。请看下面这个例子：

lst = [123, 'abc', 3.45]


def set_lst0(value):
    lst[0] = value


print(lst)
set_lst0('针不戳')
print(lst)

以上代码运行后的输出为：

[123, 'abc', 3.45]
['针不戳', 'abc', 3.45]

这里，函数set_lst0将列表lst（它是个全局变量）的第0项修改为传入的参数value. 可以看到，调用函数set_lst0后，列表lst的第0项成功被修改。究其原因，在函数set_lst中，对于语句lst[0] = value，=的左边lst[0]并不是变量名，因此谈不上创建局部变量，函数内使用的lst是全局变量lst.

 

3. 解决方法

现在再来看看一开始的那行代码money += value，这行代码等价于money = money + value. 

这行代码位于函数add_money内，而且变量money出现在赋值运算符=的左边，因此Python认为money是一个局部变量，从而此函数内的变量money与函数外定义的全局变量money没有半毛钱关系。

然而，在这行代码的右边出现了变量money, 局部变量money被创建前，程序就要读取它的值，这不是耍流氓吗？所以会报错，这种错误就称为UnboundLocalError.

 

但如果我们非要在函数内修改全局变量money呢？很简单，在函数内告诉Python, 我们这里使用的是全局变量money. 怎么告诉Python呢？通过global关键词告诉Python:

money = 10000  # 当前的财产，单位为元


def add_money(value):
    global money
    money += value


print('当前财产: ', money)
add_money(10)
print('当前财产: ', money)

现在运行以上程序，会输出预期的结果。

 

4. 为什么之前没遇到这种问题

很多人困惑的是：自己以前好像从来没有遇到这种情况，怎么学到global这里就突然出现了这种问题？

事实上，我们很少写出本文开始时的那种代码。例如，我们定义了一个全局变量a，它是一个空列表：

a = []

如果你在函数内部修改这个列表，多数情况下你会在函数内通过a.append或者a.remove这些方法修改列表，例如：

def do_sth_a():
    a.append(XXX)
    ...
    a.remove(XXX)

而不会写成：

def do_sth_a():
    a = []

或者：

def do_sth_a():
    a = 123

也就是说，你不大可能直接通过=修改列表a. 当然，如果你这么写过，那么你一定遇到过一些“谜之错误”，代码或许可以运行，但运行结果和你的预期总是不一样。

 

5. 小结

编程专家告诉我们，在代码中慎用全局变量，因此关键字global并不受待见。如果你已经学到了类，那么用到global的概率会进一步降低。只有在极其特殊的几种情况下，global会很有用，不过大多数人在以后的编程生涯中都不会再用到它。我在学习global这个关键字后，也只在教别人的时候用到过?。

Python中还有个关键字nonlocal, 用起来和global差不多，只是适用的条件不同：它用于函数内定义的嵌套函数，这里就不再细说了。

如有错误之处，还请多多指正，Thanks!