前言

with 這個關鍵字，對於每一學習Python的人，都不會陌生。

操作文字物件的時候，幾乎所有的人都會讓我們要用 with open ，這就是一個上下文管理的例子。你一定已經相當熟悉了，我就不再廢話了。

with open('test.txt') as f:
  print f.readlines()

什麼是上下文管理器？

基本語法

with EXPR as VAR:
  BLOCK

先理清幾個概念

1. 上下文表達式：with open('test.txt') as f:

2. 上下文管理器：open('test.txt')

3. f 不是上下文管理器，應該是資源物件。

如何寫上下文管理器？

要自己實現這樣一個上下文管理，要先知道上下文管理協議。

簡單點說，就是在一個類裡，實現了__enter__和__exit__的方法，這個類的例項就是一個上下文管理器。

例如這個示例：

class Resource():
  def __enter__(self):
    print('===connect to resource===')
    return self
  def __exit__(self,exc_type,exc_val,exc_tb):
    print('===close resource connection===')     
  def operate(self):
    print('===in operation===')     
with Resource() as res:
  res.operate()

我們執行一下，通過日誌的列印順序。可以知道其執行過程。
===connect to resource==
===in operation===
===close resource connection===

從這個示例可以很明顯的看出，在編寫程式碼時，可以將資源的連線或者獲取放在__enter__中，而將資源的關閉寫在__exit__ 中。

為什麼要用上下文管理器？

學習時多問自己幾個為什麼，養成對一些細節的思考，有助於加深對知識點的理解。

為什麼要使用上下文管理器？

在我看來，這和 Python 崇尚的優雅風格有關。

• 可以以一種更加優雅的方式，操作（建立/獲取/釋放）資源，如檔案操作、資料庫連線；
• 可以以一種更加優雅的方式，處理異常；

第一種，我們上面已經以資源的連線為例講過了。

而第二種，會被大多數人所忽略。這裡會重點講一下。

大家都知道，處理異常，通常都是使用 try...execept.. 來捕獲處理的。這樣做一個不好的地方是，在程式碼的主邏輯裡，會有大量的異常處理代理，這會很大的影響我們的可讀性。

好一點的做法呢，可以使用 with 將異常的處理隱藏起來。

仍然是以上面的程式碼為例，我們將1/0 這個一定會丟擲異常的程式碼寫在 operate 裡

class Resource():
  def __enter__(self):
    print('===connect to resource===')
    return self
 
  def __exit__(self,exc_tb):
    print('===close resource connection===')
    return True
 
  def operate(self):
    1/0
 
with Resource() as res:
  res.operate()

執行一下，驚奇地發現，居然不會報錯。

這就是上下文管理協議的一個強大之處，異常可以在__exit__ 進行捕獲並由你自己決定如何處理，是丟擲呢還是在這裡就解決了。在__exit__ 裡返回 True（沒有return 就預設為 return False），就相當於告訴 Python直譯器，這個異常我們已經捕獲了，不需要再往外拋了。

在 寫__exit__ 函式時，需要注意的事，它必須要有這三個引數：

• exc_type：異常型別
• exc_val：異常值
• exc_tb：異常的錯誤棧資訊

當主邏輯程式碼沒有報異常時，這三個引數將都為None。

理解並使用 contextlib

在上面的例子中，我們只是為了構建一個上下文管理器，卻寫了一個類。如果只是要實現一個簡單的功能，寫一個類未免有點過於繁雜。這時候，我們就想，如果只寫一個函式就可以實現上下文管理器就好了。

這個點Python早就想到了。它給我們提供了一個裝飾器，你只要按照它的程式碼協議來實現函式內容，就可以將這個函式物件變成一個上下文管理器。

我們按照 contextlib 的協議來自己實現一個開啟檔案（with open）的上下文管理器。

import contextlib
 @contextlib.contextmanager
def open_func(file_name):
  # __enter__方法
  print('open file:',file_name,'in __enter__')
  file_handler = open(file_name,'r')
     # 【重點】：yield
  yield file_handler
   # __exit__方法
  print('close file:','in __exit__')
  file_handler.close()
  return
 with open_func('/Users/MING/mytest.txt') as file_in:
  for line in file_in:
    print(line)

在被裝飾函式裡，必須是一個生成器（帶有yield），而yield之前的程式碼，就相當於__enter__裡的內容。yield 之後的程式碼，就相當於__exit__ 裡的內容。

上面這段程式碼只能實現上下文管理器的第一個目的（管理資源），並不能實現第二個目的（處理異常）。

如果要處理異常，可以改成下面這個樣子。

import contextlib
@contextlib.contextmanager
def open_func(file_name):
  # __enter__方法
  print('open file:','r')
  try:
    yield file_handler
  except Exception as exc:
    # deal with exception
    print('the exception was thrown')
  finally:
    print('close file:','in __exit__')
    file_handler.close()
    return
with open_func('/Users/MING/mytest.txt') as file_in:
  for line in file_in:
    1/0
    print(line)

好像只要講到上下文管理器，大多數人都會談到開啟檔案這個經典的例子。

但是在實際開發中，可以使用到上下文管理器的例子也不少。我這邊舉個我自己的例子。

在OpenStack中，給一個虛擬機器建立快照時，需要先建立一個臨時資料夾，來存放這個本地快照映象，等到本地快照映象建立完成後，再將這個映象上傳到Glance。然後刪除這個臨時目錄。

這段程式碼的主邏輯是建立快照，而建立臨時目錄，屬於前置條件，刪除臨時目錄，是收尾工作。

雖然程式碼量很少，邏輯也不復雜，但是“建立臨時目錄，使用完後再刪除臨時目錄”這個功能，在一個專案中很多地方都需要用到，如果可以將這段邏輯處理寫成一個工具函式作為一個上下文管理器，那程式碼的複用率也大大提高。

程式碼是這樣的

總結起來，使用上下文管理器有三個好處：

• 提高程式碼的複用率；
• 提高程式碼的優雅度；
• 提高程式碼的可讀性；

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支援我們。