詳解有關Python上下文管理器和with區塊

這篇文章主要為大家詳細介紹了Python上下文管理器和with塊的相關資料，具有一定的參考價值，有興趣的小伙伴們可以參考一下

##上下文管理器和with區塊，具體內容如下

上下文管理器物件存在的目的是管理with 語句，就像迭代器的存在是為了管理for 語句一樣。

with 語句的目的是簡化 try/finally 模式。此模式用來確保一段程式碼運行完畢後執行某項操作，即便那段程式碼因例外狀況、 return 語句或 sys.exit() 呼叫而中止，也會執行指定的操作。 finally 子句中的程式碼通常用於釋放重要的資源，或還原暫時變更的狀態。

==上下文管理器協定包含enter和exit兩個方法==。 with 語句開始運作時，會在上下文管理器物件上呼叫enter方法。 with 語句運作結束後，會在上下文管理器物件上呼叫exit方法，以此扮演 finally 子句的角色。

==執行with 後面的表達式得到的結果是上下文管理器對象，把值綁定到目標變數上（as 子句）是在上下文管理器對像上呼叫enter方法的結果== 。 with 語句的 as 子句是可選的。對 open 函數來說，必須加上 as子句，以便取得檔案的參考。不過，有些上下文管理器會回傳 None，因為沒什麼有用的物件能提供給使用者。

with open('mirror.py') as fp:
  ...

自訂的上下文類別：

#

class A:
  def __init__(self, name):
    self.name = name

  def __enter__(self):
    print('enter')
    return self.name

  def __exit__(self, exc_type, exc_val, exc_tb):
    print('gone')

with A('xiaozhe') as dt:
  print(dt)

contextlib模組

contextlib 模組中還有一些類別和其他函數，使用範圍更廣。

closing：如果物件提供了 close() 方法，但沒有實作

enter/exit協議，那麼可以使用這個函數來建構上下文管理器。 suppress：建置暫時忽略指定異常的上下文管理器。
@contextmanager：==這個裝飾器把簡單的生成器函數變成上下文管理器==，這樣就不用建立類別去實現管理器協定了。
ContextDecorator：這是個基類，用於定義基於類別的上下文管理器。這種上下文管理器也能用於裝飾函數，在受管理的上下文中運行整個函數
ExitStack：這個上下文管理器可以進入多個上下文管理器。 with 區塊結束時， ExitStack 依照後進先出的順序呼叫堆疊中各個上下文管理器的
exit方法。

==使用最廣泛的是 @contextmanager 裝飾器，因此要格外留心。這個裝飾器也有迷惑人的一面，因為它與迭代無關，卻要使用 yield 語句==。

使用@contextmanager

@contextmanager 裝飾器能減少建立上下文管理器的樣板程式碼量，不用寫一個完整的類別定義enter和exit方法，而只需實作有一個yield 語句的生成器，產生想讓enter方法回傳的值。

在使用 @contextmanager 裝飾的生成器中，yield 語句的作用是把函數的定義體分成兩部分： ==yield 語句前面的所有程式碼在with 區塊開始時（即解釋器呼叫enter方法時）執行， yield 語句後面的程式碼在with 區塊結束時（即呼叫exit方法時）執行==。

import contextlib

@contextlib.contextmanager
def test(name):
  print('start')
  yield name
  print('end')

with test('zhexiao123') as dt:
  print(dt)
  print('doing something')

實作原理

#contextlib.contextmanager 裝飾器會把函數包裝成實作enter和exit方法的類別。類別的名稱是 _GeneratorContextManager。

這個類別的enter方法有如下作用:

1. 呼叫生成器函數，保存生成器物件（這裡稱它為 gen）。
2. 呼叫 next(gen)，執行到 yield 關鍵字所在的位置。
3. 傳回 next(gen) 產出的值，以便把產出的值綁定到 with/as 語句中的目標變數。

with 區塊終止時，exit方法會做以下幾件事：

1. 檢查有沒有把異常傳給exc_type；如果有，呼叫gen.throw(exception) ，在生成器函數定義體中包含yield 關鍵字的那一行拋出異常。

2. 否則，呼叫 next(gen)，繼續執行生成器函數定義體中 yield 語句之後的程式碼。

異常處理

為了告訴解釋器異常已經處理了，exit方法會傳回 True，此時解譯器會壓制異常。如果exit方法沒有明確回傳一個值，那麼解釋器得到的是 None，然後向上冒泡異常。

使用 @contextmanager 裝飾器時，預設的行為是相反的：裝飾器提供的exit方法假定發給生成器的所有異常都得到處理了，因此應該壓制異常。 如果不想讓 @contextmanager 壓制異常，必須在被裝飾的函數中明確重新拋出異常。

上面的程式碼有個bug：如果在 with 區塊中拋出了異常， Python 解釋器會將其捕獲，然後在 test 函數的 yield 表達式中再次拋出。但是，那裡沒有處理錯誤的程式碼，因此 test 函數會中止。

使用 @contextmanager 装饰器时，要把 yield 语句放在 try/finally 语句中,因为我们永远不知道上下文管理器的用户会在 with 块中做什么。

import contextlib

@contextlib.contextmanager
def test(name):
  print('start')

  try:
    yield name
  except:
    raise ValueError('error')
  finally:
    print('end')

with test('zhexiao123') as dt:
  print(dt)
  print('doing something')

以上是詳解有關Python上下文管理器和with區塊的詳細內容。更多資訊請關注PHP中文網其他相關文章！