1. 程式人生 > >如何正確理解關鍵字"with"與上下文管理器(轉載)

如何正確理解關鍵字"with"與上下文管理器(轉載)

name self 限制 ioerror mysql ops tput 可能 簡化

  如果你有閱讀源碼的習慣,可能會看到一些優秀的代碼經常出現帶有 “with” 關鍵字的語句,它通常用在什麽場景呢?今天就來說說 with 和 上下文管理器。

  對於系統資源如文件、數據庫連接、socket 而言,應用程序打開這些資源並執行完業務邏輯之後,必須做的一件事就是要關閉(斷開)該資源。

  比如 Python 程序打開一個文件,往文件中寫內容,寫完之後,就要關閉該文件,否則會出現什麽情況呢?極端情況下會出現 “Too many open files” 的錯誤,因為系統允許你打開的最大文件數量是有限的。

  同樣,對於數據庫,如果連接數過多而沒有及時關閉的話,就可能會出現 “Can not connect to MySQL server Too many connections”,因為數據庫連接是一種非常昂貴的資源,不可能無限制的被創建。

  來看看如何正確關閉一個文件。

普通版:

def m1():
f = open("output.txt", "w")
f.write("python之禪")
f.close()

  這樣寫有一個潛在的問題,如果在調用 write 的過程中,出現了異常進而導致後續代碼無法繼續執行,close 方法無法被正常調用,因此資源就會一直被該程序占用者釋放。那麽該如何改進代碼呢?

進階版:

def m2():
f = open("output.txt", "w")
try:
f.write("python之禪")
except IOError:
print("oops error")
finally:
f.close()

  改良版本的程序是對可能發生異常的代碼處進行捕獲,使用 try/finally 語句,該語句表示如果在 try 代碼塊中程序出現了異常,那麽後續代碼不再執行,而直接跳轉到 except 代碼塊。不過,最終不管有沒有異常發生, finally 塊的代碼最終都會被執行。因此,即使在 write過程中報錯了,那麽最終還是執行到 finally 中去 close 文件。

高級版:

def m3():
with open("output.txt", "r") as f:
f.write("Python之禪")

  一種更加簡潔、優雅的方式就是用 with 關鍵字。open 的返回值賦值給變量 f,當離開 with 代碼塊的時候,系統會自動調用 f.close() 方法, with 的作用和使用 try/finally 語句是一樣的。那麽它的實現原理是什麽?在講 with 的原理前要涉及到另外一個概念,就是上下文管理器(Context Manager)。

上下文管理器

  實現了 __enter__()__exit__() 方法的對象都可稱之為上下文管理器,任何實現了上下文管理器的對象都可以使用 with 關鍵字。顯然,文件(file)對象也實現了上下文管理器。

那麽文件對象是如何實現這兩個方法的呢?我們可以模擬實現一個自己的文件類,讓該類實現 __enter__()__exit__() 方法。

class File():

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

def __enter__(self):
print("entering")
self.f = open(self.filename, self.mode)
return self.f

def __exit__(self, *args):
print("will exit")
self.f.close()

__enter__() 方法返回資源對象,這裏就是你將要打開的那個文件對象,__exit__() 方法處理一些清除工作。

因為 File 類實現了上下文管理器,現在就可以使用 with 語句了。

with File(‘out.txt‘, ‘w‘) as f:
print("writing")
f.write(‘hello, python‘)

這樣,你就無需在顯示地調用 close 方法了。這些有系統去調用。哪怕中間遇到異常 close 方法也會被調用。

contextlib

Python 還提供了一個 contextmanager 的裝飾器,更進一步簡化了上下文管理器的實現方式。通過 yield 將函數分割成兩部分,yield 之前的語句在 __enter__ 方法中執行,yield 之後的語句在 __exit__ 方法中執行。緊跟在 yield 後面的值是函數的返回值。例如:

from contextlib import contextmanager

@contextmanager
def my_open(path, mode):
f = open(path, mode)
yield f
f.close()

調用

with my_open(‘out.txt‘, ‘w‘) as f:
f.write("hello , the simplest context manager")

總結

  Python 提供了 with 語法用於簡化資源操作的後續清除操作,是 try/finally 的替代方法,實現原理建立在上下文管理器之上。此外,Python 還提供了一個 contextmanager 裝飾器,更進一步簡化上下管理器的實現方式。

如何正確理解關鍵字"with"與上下文管理器(轉載)