with/as

使用open開啟過檔案的對with/as都已經非常熟悉，其實with/as是對try/finally的一種替代方案。

當某個物件支援一種稱為"環境管理協議"的協議時，就會通過環境管理器來自動執行某些善後清理工作，就像finally一樣：不管中途是否發生異常，最終都會執行某些清理操作。

用法：

with expression [as var]:
    with_block_code

當expression返回的物件是支援環境管理協議的時候，就可以使用with。as var是可選的，如果不使用as var，expression返回物件將被丟棄，如果使用as var，就會將expression的返回物件賦值給變數var。

整個流程大致如下：先評估expression，如果支援環境管理協議，然後開始with/as語句塊結構，當準備退出with語句塊的時候，將執行物件中定義的善後操作。工作機制的細節見下文。

例如，open()返回的檔案物件是支援環境管理協議的，所以可以用with/as來安全地開啟檔案：

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

整個過程是先open()，然後with/as，輸出每一行後將要退出with語句塊的時候，環境管理器根據檔案物件中定義的操作關閉檔案。

它實際上等價於：

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

雖然在檔案不被引用之後，垃圾回收器會自動回收這個檔案物件，但是垃圾回收器的回收操作是有等待時間的。換句話說，如果不使用with/as開啟檔案，也不顯示close()關閉檔案，那麼這個檔案很可能會在用完之後保持空閒一段時間，然後才被垃圾回收器回收。

with/as不僅用於檔案開啟/關閉，鎖操作也支援環境管理協議，也就是說，在有需要的時候會自動釋放鎖資源。

巢狀多個環境管理器

在python 3.1之後，with as支援多個環境管理器，使用逗號隔開即可。

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

它等價於巢狀的with：

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

多環境管理器管理的多個物件會在with語句塊中出現異常的時候，或者執行完with語句塊的時候全部自動被清理(例如檔案關閉操作)。

例如，開啟兩個檔案，將它們的內容通過zip()合併在一起，並且同時關閉它們：

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

自定義環境管理器

無論是檔案還是鎖，都是別人已經寫好了環境管理器的物件。我們自己也可以寫環境管理器，讓它可以使用with/as，這實際上屬於運算子過載的範疇。

要寫自己的環境管理器，先了解with/as的工作機制的細節：

1. 先評估expression，評估的返回結果是一個物件，這個物件要具有__enter__和__exit__方法，返回的物件稱為"環境管理器"
   
2. 然後呼叫環境管理器的__enter__方法。__enter__方法的返回值賦值給 as 指定的變數，或者直接丟棄(沒有使用as)
   
3. 然後執行with語句塊中的內容
   
4. 如果執行with語句塊中的內容時丟擲了異常，將呼叫__exit__(type,value,traceback)方法，其中這3個和異常相關的引數來源於sys.exc_info。如果__exit__返回值為False，則會自動重新拋異常以便傳播異常，否則異常被認為合理處理
   
5. 如果with語句塊中的內容沒有拋異常，則直接呼叫__exit__(None,None,None)，即這三個引數都傳遞為None值

看一個簡單的示例：

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__方法返回的物件會賦值給as關鍵字指定的變數，在這個示例中即將物件自身返回。如果有需求，可以返回其它物件。

上面的__exit__中，如果異常的型別為None，說明with語句塊中的語句執行過程沒有拋異常，正常結束即可。但是如果有異常，則要求返回False，實際上上面的return False可以去掉，因為函式沒有return時預設返回None，它的布林值代表的就時False。

測試下：

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")

結果如下：

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

定義環境管理器不是件簡單的事。一般來說，如果不是很複雜的需求，直接使用try/finally來定義相關操作即可。