python3的變數作用域規則和nonlocal關鍵字
也許你已經覺得自己可以熟練使用python並能勝任許多開發任務,所以這篇文章是在浪費你的時間。不過彆著急,我們先從一個例子開始:
i = 0 def f(): print(i) i += 1 print(i) f() print(i)
猜猜看輸出是什麼?你會說不就是0,1,1麼,真的是這樣嗎?
> python test.py Traceback (most recent call last): File "a.py", line 7, in <module> f() File "a.py", line 3, in f print(i) UnboundLocalError: local variable 'i' referenced before assignment
這是為什麼?如果你還不清楚產生錯誤的原因,那就請繼續往下閱讀吧!
本文索引
LEGB原則
變數的作用域,這是一個老生常談的問題了。
在python中作用域規則可以簡單的歸納為LEGB原則
,也就是說,對於一個變數name
,首先會從當前的作用域開始查詢,如果它不在函式裡那就從global開始,沒找到就查詢builtin作用域,如果它位於函式中,就先從local作用域查詢,接著如果當前的函式是一個閉包,那麼就查詢外層閉包的作用域,也就是規則中的E
,接著是global和builtin,如果都沒找到name
這個變數,則丟擲NameError
。
那麼我們來看一段程式碼:
i = 100 def f(): print(i)
在這段程式碼中,print位於builtin作用域,i位於global,那麼:
- 在函式f中找不到這兩個名字,所以從local向上查詢,
- 首先f不是閉包,因此跳過閉包作用域的查詢,
- 然後查詢global,找到了i,但print還未找到,
- 然後查詢builtin,找到了print的builtin模組裡的一個函式。
至此名字查詢結束,呼叫找到的函式,輸出結果100。
現在你可能更加疑惑了,既然查詢規則按照LEGB
的方向進行,那麼test.py中的f不就應該找到i為global中的變數嗎,為什麼會報錯呢?
名字隱藏和暫時性死區
在揭曉答案之前,我們先複習一下名字隱藏。
它是指一個宣告在區域性作用中的名字會隱藏外層作用域中的同名的物件。許多語言都遵守這一特性,python也不例外。
那麼暫時性死區是什麼呢?這是es6的一個概念,當你在區域性作用域中定義了一個非全域性的名字時,這個名字會繫結在當前作用域中,並將外部作用域的同名物件隱藏:
var i = 'hello' function f() { i = 'world' let i }
這段程式碼中函式中的i被繫結在區域性作用域(也就是函式體內)中,在繫結的作用域中可見,並將外部的名字隱藏,而對一個未宣告的區域性變數賦值會導致錯誤,所以上面的程式碼會引發ReferenceError: i is not defined
。
對於python來說也是一樣的問題,python程式碼在執行前首先會被編譯成位元組碼,這就會導致某些時候實際執行的程式會和我們看到的產生出入。不過我們有dis
模組幫忙,它可以輸出python物件的位元組碼,下面我們就來看下經過編譯後的f
:
> dis(f) 20 LOAD_GLOBAL0 (print) 2 LOAD_FAST0 (i) 4 CALL_FUNCTION1 6 POP_TOP 38 LOAD_CONST1 ('a') 10 STORE_FAST0 (i) 412 LOAD_GLOBAL0 (print) 14 LOAD_FAST0 (i) 16 CALL_FUNCTION1 18 POP_TOP 20 LOAD_CONST0 (None) 22 RETURN_VALUE
位元組碼的解釋在這裡 。
其中LOAD_FAST
和STORE_FAST
是讀取和儲存local作用域的變數,我們可以看到,i變成了區域性作用域的變數!而對i的賦值早於i的定義,所以報錯了。
產生這種現象的原因也很簡單,python對函式的程式碼是獨立編譯的,如果未加說明而在函式內對一個變數賦值,那麼就認為你定義了一個區域性變數,從而把外部的同名物件遮蔽了。這麼做無可厚非,畢竟python沒有獨立的宣告一個區域性變數的語法,但結果就會造成我們看到的類似暫時性死區的現象。所以請允許我把es6的概念套用在python身上。
消除暫時性死區
既然知道問題的癥結在於python無法區分區域性變數的宣告和定義,那麼我們就來解決它。
對於一個可以區分宣告和定義的語言來說是沒有這種煩惱的,比如c:
int i = 0; void f(void) { i++; printf("%d\n", i); // 1 const char *i = "hello"; printf("%s\n", i); // "hello" }
python中不能這麼做,但是我們可以換一個思路,宣告一個變數是全域性作用域的,這樣不就解決了嗎?
global
運算子就是為了這個目的而存在的,它宣告一個變數始終是全域性作用域的變數,因此只要存在global宣告,那麼當前作用域裡的這個名字就是一個對同名全域性變數的引用。改進後的函式如下:
def f(): global i print(i) i += 1 print(i)
現在執行程式就會是你想要的結果了:
> python test.py 0 1 1
如果你還是不放心,那麼我們再來看看位元組碼:
> dis(f) 30 LOAD_GLOBAL0 (print) 2 LOAD_GLOBAL1 (i) 4 CALL_FUNCTION1 6 POP_TOP 48 LOAD_CONST1 ('a') 10 STORE_GLOBAL1 (i) 512 LOAD_GLOBAL0 (print) 14 LOAD_GLOBAL1 (i) 16 CALL_FUNCTION1 18 POP_TOP 20 LOAD_CONST0 (None) 22 RETURN_VALUE
對於i的存取已經由LOAD_GLOBAL
和STORE_GLOBAL
接手了,沒問題。
當然global
也有它的侷限性:
- 一旦宣告global,那麼這個名字始終是global作用域的一個變數,不可以再是區域性變數
- 名字必須存在於global裡,因為python在執行時進行名字查詢,所以你的變數在global裡找不到的話對它的引用將會出錯
- 接上一條,因為global限定了名字查詢的範圍,所以像閉包作用域的變數就找不到了
事實上需要引用非global名字的需求是極其常見的,因此為了解決global的不足,python3引入了nonlocal
使用nonlocal宣告閉包作用域變數
假設我們有一個需求,一個函式需要知道自己被呼叫了多少次,最簡單的實現就是使用閉包:
def closure(): count = 0 def func(): # other code count += 1 print(f'I have be called {count} times') return func
還是老問題,這樣寫對嗎?
答案是不對,你又製造暫時性死區啦!
>>> f=closure() >>> f() Traceback (most recent call last): File "<stdin>", line 1, in <module> File "<stdin>", line 5, in func UnboundLocalError: local variable 'count' referenced before assignment
這時候就要nonlocal
出場了,它宣告一個名字位於閉包作用域中,如果閉包作用域中未找到就報錯。
所以修正後的函式如下:
def closure(): count = 0 def func(): # other code nonlocal count count += 1 print(f'I have be called {count} times') return func
測試一下:
>>> f=closure() >>> f() I have be called 1 times >>> f() I have be called 2 times >>> f() I have be called 3 times >>> f2=closure() >>> f2() I have be called 1 times
現在可以正常使用和修改閉包作用域的變量了。
總結
當然,在函式裡修改外部變數往往會導致潛在的缺陷,但有時這樣做又是對的,所以希望你在好好了解作用域規則的前提下合理地利用它們。
作用域規則可以總結為下:
- 名字查詢按照LEGB規則進行,如果當前程式碼在global中則從global作用域開始查詢,否則從local開始
- builtin作用域中是內建型別和函式,所以它們總是能被找到,前提是不要在區域性作用域中對它們賦值
- global中存放著所有定義在當前模組和匯入的名字
- local是區域性作用域,存放在形成區域性作用於的程式碼中有賦值行為的名字
- 閉包作用域是閉包函式的外層作用域,裡面可以存放一些自定義的狀態
- global宣告一個名字在global作用域中
- nonlocal宣告一個名字在閉包作用域中
- 最重要的一條,當你在能產生區域性作用域的程式碼中對一個名字進行賦值,那麼這個名字就會被認為是一個local作用域的變數從而遮蔽其他作用域中的同名物件
只要記住這些規則你就可以和因作用域引起的各種問題說再見了。而且理解了這些規則還會為你探索更深層次的python打下堅實的基礎,所以請將它牢記於心。