使用Python字符串訪問與修改局部變量

在Python中定義一個函數時,就會把變量空間劃分爲全局變量(global)與局部變量(local),如果是定義在一個類的成員函數中,那麼就還有額外的成員變量(self)空間。那麼,如果在實際操作中,想把這幾種不同的變量空間做一個分離的話,有沒有辦法呢?

1.讀取和修改局部變量

首先來看一下局部變量的讀取,一般有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的方法,那麼得到的就是所有局部變量的名稱,我們也可以在例子中額外定義一個self的成員變量:

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)的話,依然會有報錯提示。

2.讀取和修改全局變量

相比於修改局部變量,其實查看修改全局變量要顯的更加容易。首先我們用一個示例演示一下如何查看所有的全局變量:

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也同步到了全局變量中,這樣就可以比較容易的劃分全局變量和局部變量再進行統一賦值或者修改。

3.讀取和修改成員變量

在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__)
#學習中遇到問題沒人解答?小編創建了一個Python學習交流羣:711312441 
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__新建了一個成員變量的值,可以看到最終都有同步到變量空間中,這樣就完成了成員變量的修改。

4.總結

Python本身是一門比較靈活便捷的編程語言,但是便捷往往有可能伴隨着一些風險,比如exec和eval等內置函數的實現,有可能導致sandbox escaping的問題。而有時候我們又需要一些批量化的操作,比如批量化的創建或者修改局部、全局或者是成員變量,這樣就需要我們首先要把所有的變量名存成字符串,在需要的時候再作爲變量名去調用。

在這篇文章中,我們介紹了一系列非exec和eval的操作(並不是說沒有風險,也引用了ctype和sys定義的數據幀),來查看和定義、修改所需的各種變量。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章