Python中的with關(guān)鍵字原理詳解

file = "test.txt"

def fun1():
    """
    普通版
    """
    f = open(file, "w")
    f.write("hello python")
    f.close()

file = "test.txt"

def fun2():
    """
    異常處理
    """
    try:
        f = open(file, "w")
        f.write("hello python")
    except Exception as e:
        print(e)
    finally:
        f.close()

file = "test.txt"

def fun3():
    """
    with 關(guān)鍵字
    """
    with open(file, "w") as f:
        f.write("hello python")

上下文管理器

什么是上下文？

上下文在不同的地方表示不同的含義。在編程中 context 上下文其實(shí)說(shuō)白了就是環(huán)境。

例如 一個(gè) APP 應(yīng)用，在切換界面的時(shí)候，要保存你是在哪個(gè)屏幕跳過(guò)來(lái)的等等信息，以便你點(diǎn)擊返回的時(shí)候能正確跳回，如果不存肯定就無(wú)法正確跳回了。

再比如線程、協(xié)程進(jìn)行任務(wù)切換時(shí)，程序怎么能知道切換到另一個(gè)任務(wù)，是從頭開(kāi)始執(zhí)行還是從中間呢？其上下文就起到作用，就是任務(wù)本身會(huì)對(duì)其環(huán)境進(jìn)行保存，做到哪里了，做了多少，各種狀態(tài)都會(huì)標(biāo)識(shí)記錄，從而形成了上下文環(huán)境，因此在切換時(shí)根據(jù)每個(gè)任務(wù)的上下文環(huán)境，繼續(xù)執(zhí)行，從而達(dá)到多任務(wù)。

上下文管理器

任何類實(shí)現(xiàn)了 __enter__() 和 __exit__() 方法的對(duì)象都可稱之為上下文管理器。

上下文管理器對(duì)象可以使用 with 關(guān)鍵字。

file = "test.txt"

def fun3():
    """
    with 關(guān)鍵字
    """
    with open(file, "w") as f:
        # with 代碼塊
        f.write("hello python")
        
    print("with 語(yǔ)句結(jié)束")

• __enter__(self)：進(jìn)入上下文管理器自動(dòng)調(diào)用的方法，該方法會(huì)在 with as 代碼塊 執(zhí)行之前執(zhí)行。如果 with 語(yǔ)句有 as子句，那么該方法的返回值會(huì)被賦值給 as 子句后的變量；該方法可以返回多個(gè)值，因此在 as 子句后面也可以指定多個(gè)變量（多個(gè)變量必須由()括起來(lái)組成元組）。
• __exit__(self, exc_type, exc_value, exc_traceback)：退出上下文管理器自動(dòng)調(diào)用的方法。該方法會(huì)在 with as 代碼塊 執(zhí)行之后執(zhí)行。如果 with as 代碼塊成功執(zhí)行結(jié)束，程序自動(dòng)調(diào)用該方法，調(diào)用該方法的三個(gè)參數(shù)都為 None，如果 with as 代碼塊 因?yàn)?異常而中止，程序也自動(dòng)調(diào)用該方法，使用 sys.exc_info 得到的異常信息將作為調(diào)用該方法的參數(shù)。

基于類的上下文管理器

我們可以模擬實(shí)現(xiàn)一個(gè)自己的文件類，讓該類實(shí)現(xiàn) __enter__() 和 __exit__()方法。

"""
with關(guān)鍵字的實(shí)現(xiàn)原理
上下文管理器
"""

# 基于類實(shí)現(xiàn)上下文管理器
class File(object):

    def __init__(self, filename, mode):
        self.filename = filename
        self.mode = mode
        self.file = None

    def __enter__(self):
        """
        進(jìn)入with as 語(yǔ)句的時(shí)候被with調(diào)用
        返回值作為 as 后面的變量
        """
        print("__enter__ called")
        self.file = open(self.filename, self.mode)
        return self.file

    def __exit__(self, exc_type, exc_value, exc_traceback):
        """
        離開(kāi)with語(yǔ)句的時(shí)候被with調(diào)用
        """
        print("__exit__ called")
        print("exc_type: ", exc_type)
        print("exc_value: ", exc_value)
        print("exc_traceback: ", exc_traceback)
        self.file.close()
        print("文件關(guān)閉操作")


def main():

    with File("test.txt", "w") as f:
        print("with 代碼塊")
        f.write("hello python1")
        f.write("hello python2")
        # a = 1 / 0
        f.write("hello python3")

    print("with 語(yǔ)句結(jié)束")


if __name__ == '__main__':
    main()

__enter__() 方法返回資源對(duì)象，這里就是你將要打開(kāi)的那個(gè)文件對(duì)象，__exit__()方法處理一些清除工作。

因?yàn)?File 類實(shí)現(xiàn)了上下文管理器，現(xiàn)在就可以使用 with 語(yǔ)句了。其運(yùn)行結(jié)果如下：

__enter__ called
with 代碼塊
__exit__ called
exc_type:  None
exc_value:  None
exc_traceback:  None
文件關(guān)閉操作
with 語(yǔ)句結(jié)束

把 除0異常 的代碼注釋去了看看結(jié)果

__enter__ called
with 代碼塊
__exit__ called
exc_type:  <class 'ZeroDivisionError'>
exc_value:  division by zero
exc_traceback:  <traceback object at 0x0000021F0780BCC8>
文件關(guān)閉操作
Traceback (most recent call last):
  File "C:\Users\Administrator\Desktop\pycode\withdemo.py", line 113, in <module>
    main()
  File "C:\Users\Administrator\Desktop\pycode\withdemo.py", line 106, in main
    a = 1 / 0
ZeroDivisionError: division by zero

基于contextmanager裝飾器

Python 在 contextlib 模塊中還提供了一個(gè) contextmanager 的裝飾器，更進(jìn)一步簡(jiǎn)化了上下文管理器的實(shí)現(xiàn)方式。通過(guò) yield 將函數(shù)分割成兩部分，yield 之前的語(yǔ)句在  __enter__  方法中執(zhí)行，yield 之后的語(yǔ)句在 __exit__ 方法中執(zhí)行。緊跟在 yield 后面的值是函數(shù)的返回值。

# 基于contextmanager裝飾器
from contextlib import contextmanager

@contextmanager
def file_manager(name, mode):
    print("file_manager() called")
    try:
        f = open(name, mode)
        yield f
    finally:
        f.close()
        print("文件關(guān)閉操作")

調(diào)用

with file_manager('test.txt', 'w') as f:
    print("with 代碼塊")
    f.write('hello world')
    # a = 1 / 0

print("with 語(yǔ)句結(jié)束")

結(jié)果

file_manager() called
with 代碼塊
文件關(guān)閉操作
with 語(yǔ)句結(jié)束

總結(jié)

Python 提供了 with 語(yǔ)法用于簡(jiǎn)化資源操作的后續(xù)清除操作，是 try/finally 的替代方法，實(shí)現(xiàn)原理建立在上下文管理器之上。此外，Python 還提供了一個(gè) contextmanager 裝飾器，更進(jìn)一步簡(jiǎn)化上下文管理器的實(shí)現(xiàn)方式?；陬惡突?contextmanager 的上下文管理器，這兩者在功能上是一致的。只不過(guò)，基于類的上下文管理器 更加靈活，適用于大型的系統(tǒng)開(kāi)發(fā)，而基于 contextmanager 的上下文管理器 更加方便、簡(jiǎn)潔，適用于中小型程序。

無(wú)論使用哪一種，不要忘記在方法 __exit__() 或者是 finally 塊中釋放資源，這一點(diǎn)尤其重要。

作者：編程小灰

_往期文章推薦_