玩轉python中with的使用與上下文管理器

        人是隨着時間不斷進化而來的,同樣編程語言也是隨着IT行業的更新換代,功能模塊不斷地優化與豐富才壯大起來的。比如在python2.5之前使用open讀寫文件操作就要注意。比如Python 程序打開一個文件後,往文件中寫內容,寫完之後,就要關閉該文件,否則會出現什麼情況呢?極端情況下會出現 "Too many open files" 的錯誤,因爲系統允許你打開的最大文件數量是有限的,默認打開文件最大文件數1024。

       所以實際開發中要對可能發生異常的代碼處進行 try 捕獲,使用 try/finally 語句,因爲如果在 try 代碼塊中程序出現了異常,後續代碼就不再執行,而直接跳轉到 except 代碼塊,但finally 塊的代碼無路如何最終都會被執行。因此,只要把 close 放在 finally 代碼中,文件就一定會關閉,解決了這種隱藏的問題。

1.使用open讀寫文件,try捕捉異常處理,finally關閉文件

def f1():
    f = open("aaa.txt", "w+")
    try:
        f.write("hello ,world")
    except IOError:
        print("io 異常了啦")
    finally:
        f.close()
f1()

  使用上面處理當然沒有任何問題,但在python2.5以後,基於之前的try....except....finally增加了一個功能更加簡潔的方式with關鍵字。with語句相對try/finally來說簡潔了很多,而且也不需要每一個用戶都去寫f.close()來關閉文件了。

2.使用with關鍵字進行文件操作

def m2():
    with open("aaaa.txt","w+") as f : #open 方法的返回值給變量f,所以這裏f可以自定義名稱
        f.write("hahhahaha")
m2()
  1.  open 方法的返回值賦值給變量 f,這裏f只是變量名,指向open返回值的引用。
  2.  當離開 with 代碼塊的時候,系統會自動調用 f.close() 方法, with 的作用和使用 try/finally 語句是一樣的,所以這裏不用手動寫close()了

      上面那麼爲什麼with可以實現這麼強大的功能呢,即替代了try...finally,不用捕捉異常了,也不用手動調用close了,要想弄明白這個問題,先了解下python中的上下文管理器(Context Manager)。

3.什麼是上下文管理器

       查看官網看是說:任何實現(重寫)了 __enter__() 和 __exit__() 方法的對象都可稱之爲上下文管理器,搞不清context manager,內容管理器,爲啥翻譯成上下文管理器。使用pycharm可以查看原來__enter__() 和 __exit__() 是object類中自帶的魔法方法。

      細心的人用ctrl鍵打開查看該方法的源碼,發現打開不了,這是爲啥子呢?因爲python的解釋器底層是用c語言寫的(也有用java的)。所以底層很多方法,都是查看不了源碼的。要想查看源碼可以到github上搜搜。但是一些導入的python庫,用python實現的,是可以直接查看源碼的。

       所謂的上下文管理器其實是一個遵守了context management protocol 協議的對象就是一個對象,一個重寫了object類中__enter__() 和 __exit__() 方法的對象。這樣的對象被稱爲上下文管理器Content Manager,它可以使用with關鍵字進行操作這個對象。

3.1 with語句使用的格式

with expression [as variable]:
    with-block
----------------------------------------------------------------------------
案例1:
 with open("aaaa.txt","w+") as f : #open方法的返回值給變量f,相當於起個別名。
        f.write("hahhahaha")
  1. 這裏expression是一個表達式,該表達式的結果必須是一個支持上下文管理協議的對象(即具有__enter__()和__exit__()方法的對象),比如案例中操作文件就是用的open("aaaa.txt","w+"),這個表達式返回的結果就是file對象。具體返回的結果根據打開模式不同,返回值也不同,比如當open()用於以文本模式('w')打開文件時,它返回一個TextIOWrapper。那麼這麼說,既然open()可以用with進行操作,底層必然實現了上下文管理器協議的。查看官網可知。一些標準Python對象現在都支持上下文管理協議,並且可以與with語句一起使用。文件對象就是一個例子。  
  2. 既然支持上下文管理協議,也就是實現底層實現了__enter__()和__exit__()方法。對象的__enter__()方法在with-block執行之前被調用,因此可以在類重寫的__enter__方法里根據實際需求添加特定條件的過濾代碼,__enter__方法。具體使用後面再說。
  3. 在with-block 塊的執行完成後,會調用對象的_exit__()方法,即使with-block塊執行中引發異常,也可以運行這個__exit__方法,執行一些特定的操作(類似於try finally,finally無論是否有異常,都會執行其中的代碼)。比如文件對象就在這個__exit__方法裏調用了close()函數,這樣不管open操作是否異常,文件最終都會關閉。

3.2自定義一個實現了上下文管理器協議的對象:上下文管理器

     根據官網定義很簡單,只要該類重寫了object類中__enter__()和__exit__()方法即可。

#自定義一個上下文管理器,實現原open()函數的功能
class MyOpen(object):

    def __init__(self, filename, mode):
        self.filename = filename
        self.mode = mode

    def __enter__(self):
        print("entering")
        self.f = open(self.filename, self.mode)
        return self.f

    def __exit__(self, *args):
        print("will exit")
        self.f.close()

#下面使用自定義的上下文管理器,
#1.首先MyOpen("bbbb.txt","w") 先執行__init__,完成初始化,返回的是一個支持上下文管理器協議的對象給f
#2.然後執行__enter__函數,該函數執行open()方法操作文件,並且返回這個file對象。
#3.根據返回的file對象f,這個時候執行f.f.write("hello ,hahahhah")
#4.不管第三步是否異常,最後都會調用__exit__執行文件的close.
with MyOpen("bbbb.txt","w") as f:
    f.write("hello ,hahahhah")

4.實現上線文管理器的其他方式

          Python 還提供了一個 contextmanager 的裝飾器,更進一步簡化了上下文管理器的實現方式。通過 yield 將函數分割成兩部分,yield 之前的語句在 __enter__ 方法中執行,yield 之後的語句在 __exit__ 方法中執行。緊跟在 yield 後面的值是函數的返回值。具體詳細參考python官網:https://docs.python.org/release/2.6/whatsnew/2.6.html#pep-343-the-with-statement

from contextlib import contextmanager

@contextmanager
def my_open(path, mode):
    f = open(path, mode)
    yield f
    f.close()

使用演示:

with my_open('out.txt', 'w') as f:
    f.write("hello , the simplest context manager")

尖叫提示: 

          Python 提供了 with 語法用於簡化資源操作的後續清除操作,是 try/finally 的替代方法,實現原理建立在上下文管理器之上。此外,Python 還提供了一個 contextmanager 裝飾器,更進一步簡化上下管理器的實現方式。但是實際開中,一般不需要不要開發者掌握with的實現原理,會使用即可哈。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章