Python深入學習之上下文管理器

上下文管理器(context manager)是Python2.5開始支援的一種文法，用於規定某個對象的使用範圍。一旦進入或者離開該使用範圍，會有特殊操作被調用 (比如為對象分配或者釋放記憶體)。它的文法形式是with...as...

關閉檔案

我們會進行這樣的操作：開啟檔案，讀寫，關閉檔案。程式員經常會忘記關閉檔案。上下文管理器可以在不需要檔案的時候，自動關閉檔案。

下面我們看一下兩段程式：

代碼如下:

# without context manager
f = open("new.txt", "w")
print(f.closed) # whether the file is open
f.write("Hello World!")
f.close()
print(f.closed)

以及：

代碼如下:

# with context manager
with open("new.txt", "w") as f:
print(f.closed)
f.write("Hello World!")
print(f.closed)

兩段程式實際上執行的是相同的操作。我們的第二段程式就使用了上下文管理器 (with...as...)。上下文管理器有隸屬於它的程式塊。當隸屬的程式塊執行結束的時候(也就是不再縮排)，上下文管理器自動關閉了檔案 (我們通過f.closed來查詢檔案是否關閉)。我們相當於使用縮排規定了檔案對象f的使用範圍。

上面的上下文管理器基於f對象的__exit__()特殊方法(還記得我們如何利用特殊方法來實現各種文法？參看特殊方法與多範式)。當我們使用上下文管理器的文法時，我們實際上要求Python在進入程式塊之前調用對象的__enter__()方法，在結束程式塊的時候調用__exit__()方法。對於檔案對象f來說，它定義了__enter__()和__exit__()方法(可以通過dir(f)看到)。在f的__exit__()方法中，有self.close()語句。所以在使用上下文管理器時，我們就不用明文關閉f檔案了。

自訂

任何定義了__enter__()和__exit__()方法的對象都可以用於上下文管理器。檔案對象f是內建對象，所以f自動帶有這兩個特殊方法，不需要自訂。

下面，我們自訂用於上下文管理器的對象，就是下面的myvow：

代碼如下:

# customized object

class VOW(object):
def __init__(self, text):
self.text = text
def __enter__(self):
self.text = "I say: " + self.text # add prefix
return self # note: return an object
def __exit__(self,exc_type,exc_value,traceback):
self.text = self.text + "!" # add suffix

with VOW("I'm fine") as myvow:
print(myvow.text)

print(myvow.text)

我們的運行結果如下:

代碼如下:

I say: I'm fine
I say: I'm fine!

我們可以看到，在進入上下文和離開上下文時，對象的text屬性發生了改變(最初的text屬性是"I'm fine")。

__enter__()返回一個對象。上下文管理器會使用這一對象作為as所指的變數，也就是myvow。在__enter__()中，我們為myvow.text增加了首碼 ("I say: ")。在__exit__()中，我們為myvow.text增加了尾碼("!")。

注意: __exit__()中有四個參數。當程式塊中出現異常(exception)，__exit__()的參數中exc_type, exc_value, traceback用於描述異常。我們可以根據這三個參數進行相應的處理。如果正常運行結束，這三個參數都是None。在我們的程式中，我們並沒有用到這一特性。

總結：

通過上下文管理器，我們控制對象在程式不同區間的特性。上下文管理器(with EXPR as VAR)大致相當於如下流程:

代碼如下:

# with EXPR as VAR:

VAR = EXPR
VAR = VAR.__enter__()
try:
BLOCK
finally:
VAR.__exit__()

由於上下文管理器帶來的便利，它是一個值得使用的工具。

