上下文管理器和with塊，具體內(nèi)容如下

上下文管理器對(duì)象存在的目的是管理 with 語(yǔ)句，就像迭代器的存在是為了管理 for 語(yǔ)句一樣。

with 語(yǔ)句的目的是簡(jiǎn)化 try/finally 模式。這種模式用于保證一段代碼運(yùn)行完畢后執(zhí)行某項(xiàng)操作，即便那段代碼由于異常、 return 語(yǔ)句或 sys.exit() 調(diào)用而中止，也會(huì)執(zhí)行指定的操作。 finally 子句中的代碼通常用于釋放重要的資源，或者還原臨時(shí)變更的狀態(tài)。

==上下文管理器協(xié)議包含enter和exit兩個(gè)方法==。 with 語(yǔ)句開(kāi)始運(yùn)行時(shí)，會(huì)在上下文管理器對(duì)象上調(diào)用enter方法。 with 語(yǔ)句運(yùn)行結(jié)束后，會(huì)在上下文管理器對(duì)象上調(diào)用exit方法，以此扮演 finally 子句的角色。

==執(zhí)行 with 后面的表達(dá)式得到的結(jié)果是上下文管理器對(duì)象，把值綁定到目標(biāo)變量上（as 子句）是在上下文管理器對(duì)象上調(diào)用enter方法的結(jié)果==。with 語(yǔ)句的 as 子句是可選的。對(duì) open 函數(shù)來(lái)說(shuō)，必須加上 as子句，以便獲取文件的引用。不過(guò)，有些上下文管理器會(huì)返回 None，因?yàn)闆](méi)什么有用的對(duì)象能提供給用戶(hù)。

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

自定義的上下文類(lèi)：

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 模塊中還有一些類(lèi)和其他函數(shù)，使用范圍更廣。

closing：如果對(duì)象提供了 close() 方法，但沒(méi)有實(shí)現(xiàn)enter/exit協(xié)議，那么可以使用這個(gè)函數(shù)構(gòu)建上下文管理器。
suppress：構(gòu)建臨時(shí)忽略指定異常的上下文管理器。
@contextmanager：==這個(gè)裝飾器把簡(jiǎn)單的生成器函數(shù)變成上下文管理器==，這樣就不用創(chuàng)建類(lèi)去實(shí)現(xiàn)管理器協(xié)議了。
ContextDecorator：這是個(gè)基類(lèi)，用于定義基于類(lèi)的上下文管理器。這種上下文管理器也能用于裝飾函數(shù)，在受管理的上下文中運(yùn)行整個(gè)函數(shù)
ExitStack：這個(gè)上下文管理器能進(jìn)入多個(gè)上下文管理器。 with 塊結(jié)束時(shí)， ExitStack 按照后進(jìn)先出的順序調(diào)用棧中各個(gè)上下文管理器的exit方法。

==使用最廣泛的是 @contextmanager 裝飾器，因此要格外留心。這個(gè)裝飾器也有迷惑人的一面，因?yàn)樗c迭代無(wú)關(guān)，卻要使用 yield 語(yǔ)句==。

使用@contextmanager

@contextmanager 裝飾器能減少創(chuàng)建上下文管理器的樣板代碼量，不用編寫(xiě)一個(gè)完整的類(lèi)定義enter和exit方法，而只需實(shí)現(xiàn)有一個(gè) yield 語(yǔ)句的生成器，生成想讓enter方法返回的值。

在使用 @contextmanager 裝飾的生成器中， yield 語(yǔ)句的作用是把函數(shù)的定義體分成兩部分： ==yield 語(yǔ)句前面的所有代碼在 with 塊開(kāi)始時(shí)（即解釋器調(diào)用enter方法時(shí)）執(zhí)行， yield 語(yǔ)句后面的代碼在 with 塊結(jié)束時(shí)（即調(diào)用exit方法時(shí)）執(zhí)行==。

import contextlib

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

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

實(shí)現(xiàn)原理

contextlib.contextmanager 裝飾器會(huì)把函數(shù)包裝成實(shí)現(xiàn)enter和exit方法的類(lèi)。類(lèi)的名稱(chēng)是 _GeneratorContextManager。

這個(gè)類(lèi)的enter方法有如下作用:
1. 調(diào)用生成器函數(shù)，保存生成器對(duì)象（這里把它稱(chēng)為 gen）。
2. 調(diào)用 next(gen)，執(zhí)行到 yield 關(guān)鍵字所在的位置。
3. 返回 next(gen) 產(chǎn)出的值，以便把產(chǎn)出的值綁定到 with/as 語(yǔ)句中的目標(biāo)變量上。

with 塊終止時(shí)，exit方法會(huì)做以下幾件事：

1. 檢查有沒(méi)有把異常傳給 exc_type；如果有，調(diào)用 gen.throw(exception)，在生成器函數(shù)定義體中包含 yield 關(guān)鍵字的那一行拋出異常。
2. 否則，調(diào)用 next(gen)，繼續(xù)執(zhí)行生成器函數(shù)定義體中 yield 語(yǔ)句之后的代碼。

異常處理

為了告訴解釋器異常已經(jīng)處理了，exit方法會(huì)返回 True，此時(shí)解釋器會(huì)壓制異常。如果exit方法沒(méi)有顯式返回一個(gè)值，那么解釋器得到的是 None，然后向上冒泡異常。

使用 @contextmanager 裝飾器時(shí)，默認(rèn)的行為是相反的：裝飾器提供的exit方法假定發(fā)給生成器的所有異常都得到處理了，因此應(yīng)該壓制異常。 如果不想讓 @contextmanager 壓制異常，必須在被裝飾的函數(shù)中顯式重新拋出異常。

上面的代碼有個(gè)bug：如果在 with 塊中拋出了異常， Python 解釋器會(huì)將其捕獲，然后在 test 函數(shù)的 yield 表達(dá)式里再次拋出。但是，那里沒(méi)有處理錯(cuò)誤的代碼，因此 test 函數(shù)會(huì)中止。

使用 @contextmanager 裝飾器時(shí)，要把 yield 語(yǔ)句放在 try/finally 語(yǔ)句中,因?yàn)槲覀冇肋h(yuǎn)不知道上下文管理器的用戶(hù)會(huì)在 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')

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論