Python3通過字串訪問與修改區域性變數
技術背景
在Python中定義一個函式時，就會把變數空間劃分為全域性變數(global)與區域性變數(local)，如果是定義在一個類的成員函式中，那麼就還有額外的成員變數(self)空間。那麼，如果在實際操作中，想把這幾種不同的變數空間做一個分離的話，有沒有辦法呢？
讀取和修改區域性變數
首先來看一下區域性變數的讀取，一般有locals()、vars()和sys._getframe(0).f_code.co_varnames這幾種方法，另外有一種sys._getframe(0).f_locals的方法，其實等價於locals()，相關的實現程式碼如下：
x = 0 class Obj: def __init__(self,y): self.func(y) def func(y, z=1): m = 2 print (locals()) print (vars()) print (__import__('sys')._getframe(0).f_code.co_varnames) if __name__ == '__main__': Obj(2)
該程式碼的執行結果如下：
{'self': <__main__.Obj object at 0x7f5cf5e74e50>, 'y': 2, 'z': 1, 'm': 2}
{'self': <__main__.Obj object at 0x7f5cf5e74e50>, 'y': 2, 'z': 1, 'm': 2}
('self', 'y', 'z', 'm')
在vars方法不加具體變數名的時候，就是等價於locals方法，兩者返回的結果都是字典格式。如果是一個類中的成員函式下執行locals或者vars，會附帶一個__main__.Obj object的變數，相當於所有self的成員變數，其實也是區域性變數的一部分。而如果使用co_varnames
x = 0 class Obj: def __init__(self, y): self.p = 5 self.func(y) def func(self, y, z=1): m = 2 print(locals()) print(vars()) print(__import__('sys')._getframe(0).f_code.co_varnames) if __name__ == '__main__': Obj(2) # {'self': <__main__.Obj object at 0x7fe9aac0ce50>, 'y': 2, 'z': 1, 'm': 2} # {'self': <__main__.Obj object at 0x7fe9aac0ce50>, 'y': 2, 'z': 1, 'm': 2} # ('self', 'y', 'z', 'm')
可以發現，所有的成員變數都被放在了self中。並且需要注意的是，全域性變數x自始至終都沒有在區域性變數中出現。那麼既然我們可以通過這種方式分離出區域性變數，或者是區域性變數的名稱，那我們如何去調整或者修改這些區域性變數呢？首先我們需要知道，locals()方法返回的變數是一個copy，也就是說即使修改了locals方法返回的結果，也不能真正的改變區域性變數本身的值，這樣描述可能有點抽象，我們直接看下這個案例：
x = 0
class Obj:
def __init__(self,y):
self.func(y)
def func(self, y, z=1):
m = 2
vars()['z']=2
locals()['n']=3
print (locals())
print (z)
if __name__ == '__main__':
Obj(2)
在這個案例中分別通過vars方法和locals方法去修改區域性變數的值，最終的輸出結果如下：
{'self': <__main__.Obj object at 0x7f74d9470e50>, 'y': 2, 'z': 1, 'm': 2, 'n': 3}
1
首先要解釋一下為什麼這個案例中沒有列印n這個變數，前面提到vars和locals的返回值都是真實變數的一個copy，因此我們不管是修改也好，新增也好，內容不會同步到變數空間中去，也就是說，此時的區域性變數n還是處於一個沒有定義的狀態，只是在locals或者vars的字典中存在，此時列印只會報錯NameError。而z的最終列印輸出是1，這表明z的值確實沒有受到對vars的變數修改的影響。那到底有沒有辦法可以通過字串去修改區域性變數呢（不同步到全域性變數）？答案是有的，但是這個方案非常的hacky，請看如下示例：
import ctypes
x = 0
class Obj:
def __init__(self,y):
self.func(y)
def func(self, y, z=1):
m = 2
__import__('sys')._getframe(0).f_locals.update({
'z': 2,'n': 3
})
ctypes.pythonapi.PyFrame_LocalsToFast(
ctypes.py_object(__import__('sys')._getframe(0)), ctypes.c_int(0))
print (locals())
print (z)
if __name__ == '__main__':
Obj(2)
這個案例是使用了Cython的方案直接去修改了資料幀的內容，而這裡所使用的f_locals其實本質上就是locals。經過一番執行，輸出結果如下：
{'self': <__main__.Obj object at 0x7fea2e2
a1e80>, 'y': 2, 'z': 2, 'm': 2, 'n': 3}
2
此時區域性變數z是被成功修改了的，但是在前面提到的，即使我們通過這種方法修改了局部變數的值，但是依然不能通過這個方案去建立一個新的區域性變數，此時去執行print (n)的話，依然會有報錯提示。
讀取和修改全域性變數
相比於修改區域性變數，其實檢視修改全域性變數要顯的更加容易。首先我們用一個示例演示一下如何檢視所有的全域性變數：
x = 0
class Obj:
def __init__(self,y):
self.func(y)
def func(self, y, z=1):
m = 2
print (globals())
if __name__ == '__main__':
Obj(2)
獲取區域性變數的方式有很多，但是獲取全域性變數一般就是globals或者等價的f_globals。上述程式碼執行輸出如下：
{'__name__': '__main__', '__doc__': None, '__package__': None,
'__loader__': <_frozen_importlib_external.SourceFileLoader object at 0x7f202632ac40>,
'__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>,
'__file__': 'xxx.py', '__cached__': None, 'x': 0, 'Obj': <class '__main__.Obj'>}
用這種方法我們發現了全域性變數x，而在同一個函式內的幾個區域性變數，就沒有顯示在globals的key中。而不同於locals變數的是，globals函式返回的是一個真實的資料，是可以直接修改，並且在全域性生效的。比如我們在函式內定義或者修改全域性變數：
x = 0
class Obj:
def __init__(self,y):
self.func(y)
def func(self, y, z=1):
global m
m = 2
globals()['x']=3
if __name__ == '__main__':
Obj(2)
print(globals()['x'])
print(globals()['m'])
# 3
# 2
在這個例子中我們就可以發現，不僅僅是修改的x值生效了，新建的m也同步到了全域性變數中，這樣就可以比較容易的劃分全域性變數和區域性變數再進行統一賦值或者修改。
讀取和修改成員變數
在python中每一個定義的object都有一個隱藏屬性__dict__，這是一個字典，其中包含了所有的成員變數名和成員變數值。在前一篇部落格中，我們就介紹了通過__dict__去給類中的成員變數進行賦值，非常的方便。我們可以通過一個示例來看看__dict__中所包含的內容：
x = 0
class Obj:
def __init__(self,y):
self.m = 2
self.func(y)
def func(self, y, z=1):
print (self.__dict__)
if __name__ == '__main__':
Obj(2)
# {'m': 2}
從輸出結果中我們就可以看到，__dict__輸出的內容非常的純淨，就是所有的成員變數名和變數值。而成員變數雖然是一個物件的屬性，但是其操作方式跟全域性變數globals是非常接近的，不像locals一樣只讀，具體示例如下：
x = 0
class Obj:
def __init__(self,y):
self.m = 2
self.func(y)
def func(self, y, z=1):
self.m = 5
self.__dict__['n'] = 6
print (self.__dict__)
print (self.m, self.n)
if __name__ == '__main__':
Obj(2)
# {'m': 5, 'n': 6}
# 5
# 6
在這個案例中，我們修改了成員變數的值，也使用__dict__新建了一個成員變數的值，可以看到最終都有同步到變數空間中，這樣就完成了成員變數的修改。
總結概要
Python本身是一門比較靈活便捷的程式語言，但是便捷往往有可能伴隨著一些風險，比如exec和eval等內建函式的實現，有可能導致sandbox escaping的問題。而有時候我們又需要一些批量化的操作，比如批量化的建立或者修改區域性、全域性或者是成員變數，這樣就需要我們首先要把所有的變數名存成字串，在需要的時候再作為變數名去呼叫。在這篇文章中，我們介紹了一系列非exec和eval的操作（並不是說沒有風險，也引用了ctype和sys定義的資料幀），來檢視和定義、修改所需的各種變數。
版權宣告
本文首發連結為：https://www.cnblogs.com/dechinphy/p/modify-locals.html
作者ID：DechinPhy
更多原著文章請參考：https://www.cnblogs.com/dechinphy/
打賞專用連結：https://www.cnblogs.com/dechinphy/gallery/image/379634.html
騰訊雲專欄同步：https://cloud.tencent.com/developer/column/91958