with/as

使用open打開(kāi)過(guò)文件的對(duì)with/as都已經(jīng)非常熟悉，其實(shí)with/as是對(duì)try/finally的一種替代方案。

當(dāng)某個(gè)對(duì)象支持一種稱(chēng)為"環(huán)境管理協(xié)議"的協(xié)議時(shí)，就會(huì)通過(guò)環(huán)境管理器來(lái)自動(dòng)執(zhí)行某些善后清理工作，就像finally一樣：不管中途是否發(fā)生異常，最終都會(huì)執(zhí)行某些清理操作。

用法：

with expression [as var]:
 with_block_code

當(dāng)expression返回的對(duì)象是支持環(huán)境管理協(xié)議的時(shí)候，就可以使用with。as var是可選的，如果不使用as var，expression返回對(duì)象將被丟棄，如果使用as var，就會(huì)將expression的返回對(duì)象賦值給變量var。

整個(gè)流程大致如下：先評(píng)估expression，如果支持環(huán)境管理協(xié)議，然后開(kāi)始with/as語(yǔ)句塊結(jié)構(gòu)，當(dāng)準(zhǔn)備退出with語(yǔ)句塊的時(shí)候，將執(zhí)行對(duì)象中定義的善后操作。工作機(jī)制的細(xì)節(jié)見(jiàn)下文。

例如，open()返回的文件對(duì)象是支持環(huán)境管理協(xié)議的，所以可以用with/as來(lái)安全地打開(kāi)文件：

with open(r'd:\a\b\c\a.log') as logfile:
 for line in logfile:
  print(line)
  ...more code here...

整個(gè)過(guò)程是先open()，然后with/as，輸出每一行后將要退出with語(yǔ)句塊的時(shí)候，環(huán)境管理器根據(jù)文件對(duì)象中定義的操作關(guān)閉文件。

它實(shí)際上等價(jià)于：

myfile = open(r'd:\a\b\c\a.log')
try:
 for line in myfile:
  print(line)
  ...more code here...
finally:
 myfile.close()

雖然在文件不被引用之后，垃圾回收器會(huì)自動(dòng)回收這個(gè)文件對(duì)象，但是垃圾回收器的回收操作是有等待時(shí)間的。換句話(huà)說(shuō)，如果不使用with/as打開(kāi)文件，也不顯示close()關(guān)閉文件，那么這個(gè)文件很可能會(huì)在用完之后保持空閑一段時(shí)間，然后才被垃圾回收器回收。

with/as不僅用于文件打開(kāi)/關(guān)閉，鎖操作也支持環(huán)境管理協(xié)議，也就是說(shuō)，在有需要的時(shí)候會(huì)自動(dòng)釋放鎖資源。

嵌套多個(gè)環(huán)境管理器

在python 3.1之后，with as支持多個(gè)環(huán)境管理器，使用逗號(hào)隔開(kāi)即可。

with A() as a, B() as b:
 ...statements...

它等價(jià)于嵌套的with：

with A() as a:
 with B() as b:
  ...statements...

多環(huán)境管理器管理的多個(gè)對(duì)象會(huì)在with語(yǔ)句塊中出現(xiàn)異常的時(shí)候，或者執(zhí)行完with語(yǔ)句塊的時(shí)候全部自動(dòng)被清理(例如文件關(guān)閉操作)。

例如，打開(kāi)兩個(gè)文件，將它們的內(nèi)容通過(guò)zip()合并在一起，并且同時(shí)關(guān)閉它們：

with open('a.file') as f1, open('b.file') as f2:
 for pair in zi[(f1, f2):
  print(pair)

自定義環(huán)境管理器

無(wú)論是文件還是鎖，都是別人已經(jīng)寫(xiě)好了環(huán)境管理器的對(duì)象。我們自己也可以寫(xiě)環(huán)境管理器，讓它可以使用with/as，這實(shí)際上屬于運(yùn)算符重載的范疇。

要寫(xiě)自己的環(huán)境管理器，先了解with/as的工作機(jī)制的細(xì)節(jié)：

1. 先評(píng)估expression，評(píng)估的返回結(jié)果是一個(gè)對(duì)象，這個(gè)對(duì)象要具有 __enter__ 和 __exit__ 方法，返回的對(duì)象稱(chēng)為"環(huán)境管理器"
2. 然后調(diào)用環(huán)境管理器的 __enter__ 方法。 __enter__ 方法的返回值賦值給 as 指定的變量，或者直接丟棄(沒(méi)有使用as)
3. 然后執(zhí)行with語(yǔ)句塊中的內(nèi)容
4. 如果執(zhí)行with語(yǔ)句塊中的內(nèi)容時(shí)拋出了異常，將調(diào)用 __exit__(type,value,traceback) 方法，其中這3個(gè)和異常相關(guān)的參數(shù)來(lái)源于 sys.exc_info 。如果 __exit__ 返回值為False，則會(huì)自動(dòng)重新拋異常以便傳播異常，否則異常被認(rèn)為合理處理
5. 如果with語(yǔ)句塊中的內(nèi)容沒(méi)有拋異常，則直接調(diào)用 __exit__(None,None,None) ，即這三個(gè)參數(shù)都傳遞為None值

看一個(gè)簡(jiǎn)單的示例：

class TraceBlock:
 def message(self, arg):
  print('running ' + arg)

 def __enter__(self):
  print('starting with block')
  return self

 def __exit__(self, exc_type, exc_value, exc_tb):
  if exc_type is None:
   print('exited normally\n')
  else:
   print('raise an exception! ' + str(exc_type))
   return False

上面的 __enter__ 方法返回的對(duì)象會(huì)賦值給as關(guān)鍵字指定的變量，在這個(gè)示例中即將對(duì)象自身返回。如果有需求，可以返回其它對(duì)象。

上面的 __exit__ 中，如果異常的類(lèi)型為None，說(shuō)明with語(yǔ)句塊中的語(yǔ)句執(zhí)行過(guò)程沒(méi)有拋異常，正常結(jié)束即可。但是如果有異常，則要求返回False，實(shí)際上上面的 return False 可以去掉，因?yàn)楹瘮?shù)沒(méi)有return時(shí)默認(rèn)返回None，它的布爾值代表的就時(shí)False。

測(cè)試下：

with TraceBlock() as action:
 action.message("test 1")
 print("reached")
 
print('-' * 20, "\n")

with TraceBlock() as action:
 action.message("test 2")
 raise TypeError
 print("not reached")

結(jié)果如下：

starting with block
running test 1
reached
exited normally

--------------------

starting with block
running test 2
raise an exception! <class 'TypeError'>
Traceback (most recent call last):
  File "g:/pycode/list.py", line 23, in <module>
    raise TypeError
TypeError

定義環(huán)境管理器不是件簡(jiǎn)單的事。一般來(lái)說(shuō)，如果不是很復(fù)雜的需求，直接使用try/finally來(lái)定義相關(guān)操作即可。

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

最新評(píng)論