Python上下文管理器你學會了嗎？

公眾號老韓隨筆發表於2021-07-12
Python

​什麼是上下文管理器

    對於像檔案操作、連線資料庫等資源管理的操作，我們必須在使用完之後進行釋放，不然就容易造成資源洩露。為了解決這個問題，Python的解決方式便是上下文管理器。上下文管理器能夠幫助你自動分配並且釋放資源，其中最典型的應用便是with語句。我們來看一下開啟檔案的例子。

for x in range(10000): 
    f = open('test.txt', 'w')
    f.write('hello world')

　　這段程式碼表示我們開啟了1萬個檔案，但是用完之後沒有進行關閉，這是一個典型的資源洩露的例子，這是一個錯誤的示例。我們應該這麼寫。

for x in range(10000):
    with open('test.txt', 'w') as f:
        f.write('hello world')

　　這樣我們每次開啟檔案“test.txt”，並寫入“hello world”之後，這個檔案便會自動關閉，相應的資源也會釋放，防止資源洩露。with語句的程式碼，我們還可以用下面的形式代替。

f = open('test.txt', 'w')
try:
    f.write('hello world')
finally:
    f.close()

　　

       要注意的是，最後的 finally語句尤其重要，哪怕在寫入檔案時發生錯誤異常，它也可以保證該檔案最終被關閉。不過與 with 語句相比，這樣的程式碼就顯得冗餘了，並且還容易漏寫，因此我們一般更傾向於使用 with 語句。

上下文管理器的實現

       接下來我們詳細分析一下它的內部原理和實現。這裡我們定義了一個上下管理器類FileManager，模擬Python開啟、關閉檔案的操作。

class FileManager:
    def __init__(self, name, mode):
        print('calling __init__ method')
        self.name = name
        self.mode = mode 
        self.file = None
        
    def __enter__(self):
        print('calling __enter__ method')
        self.file = open(self.name, self.mode)
        return self.file
​
​
    def __exit__(self, exc_type, exc_val, exc_tb):
        print('calling __exit__ method')
        if self.file:
            self.file.close()
            
with FileManager('test.txt', 'w') as f:
    f.write('hello world')
    print('write success')
    
####輸出####
calling __init__ method
calling __enter__ method
write success
calling __exit__ method

　　

     這個是基於類的上下文管理器的實現，當我們使用類來建立上下文管理器時，我們需要包含“__enter__”和“__exit__”方法。其中，“__enter__”方法返回需要被管理的資源，方法“__exit__”裡通常會做一些釋放、清理資源的操作。當我們用with語句執行這個上下文管理器時，依次會執行如下操作。

  1. 首先方法“__init__()”被呼叫，程式初始化物件 FileManager，使得檔名（name）是“test.txt”，檔案模式 (mode) 是“w”；

  2. 方法“__enter__()”被呼叫，檔案“test.txt”以寫入的模式被開啟，並且返回 FileManager 物件賦予變數 f；

  3. 字串“hello world”被寫入檔案“test.txt”；

  4. 方法“__exit__()”被呼叫，負責關閉之前開啟的檔案流。

   值得一提的是，方法“__exit__()”中的引數“exc_type, exc_val, exc_tb”，分別表示 exception_type、exception_value 和 traceback。當我們執行含有上下文管理器的 with 語句時，如果有異常丟擲，異常的資訊就會包含在這三個變數中，傳入方法“__exit__()”。因此，如果你需要處理可能發生的異常，可以在“__exit__()”新增相應的處理異常的程式碼。

    python中的上下文管理器除了基於類的實現還可以基於生成器的實現，我們接著來看下面這個例子。你可以使用裝飾器 contextlib.contextmanager，來定義自己所需的基於生成器的上下文管理器，用以支援 with 語句。還是拿前面的類上下文管理器 FileManager 來說，我們也可以用下面形式來表示：

    

from contextlib import contextmanager
​
@contextmanager
def file_manager(name, mode):
    try:
        f = open(name, mode)
        yield f
    finally:
        f.close()
        
with file_manager('test.txt', 'w') as f:
    f.write('hello world')

　　

      這段程式碼中，函式 file_manager() 是一個生成器，當我們執行 with 語句時，便會開啟檔案，並返回檔案物件 f；當 with 語句執行完後，finally block 中的關閉檔案操作便會執行。

     到此，我們已經把兩種上下文管理器的實現都介紹完了。這兩者在功能上是一致的，只不過，基於類的上下文管理器更加靈活，適用於大型的系統開發。而基於生成器的上下文管理器更加方便、簡潔，適用於中小型程式。

 

歡迎大家留言和我交流。更多有趣的內容，請關注公眾號 老韓隨筆

 

 

相關文章