您好,登錄后才能下訂單哦!
本文章向大家介紹使用Python怎么實(shí)現(xiàn)一個(gè)上下文管理器,主要包括使用Python怎么實(shí)現(xiàn)一個(gè)上下文管理器的使用實(shí)例、應(yīng)用技巧、基本知識(shí)點(diǎn)總結(jié)和需要注意事項(xiàng),具有一定的參考價(jià)值,需要的朋友可以參考一下。
Python是一種編程語(yǔ)言,內(nèi)置了許多有效的工具,Python幾乎無(wú)所不能,該語(yǔ)言通俗易懂、容易入門、功能強(qiáng)大,在許多領(lǐng)域中都有廣泛的應(yīng)用,例如最熱門的大數(shù)據(jù)分析,人工智能,Web開發(fā)等。
什么是上下文管理器?
基本語(yǔ)法
with EXPR as VAR: BLOCK
先理清幾個(gè)概念
1. 上下文表達(dá)式:with open('test.txt') as f:
2. 上下文管理器:open('test.txt')
3. f 不是上下文管理器,應(yīng)該是資源對(duì)象。
如何寫上下文管理器?
要自己實(shí)現(xiàn)這樣一個(gè)上下文管理,要先知道上下文管理協(xié)議。
簡(jiǎn)單點(diǎn)說(shuō),就是在一個(gè)類里,實(shí)現(xiàn)了__enter__和__exit__的方法,這個(gè)類的實(shí)例就是一個(gè)上下文管理器。
例如這個(gè)示例:
class Resource(): def __enter__(self): print('===connect to resource===') return self def __exit__(self, exc_type, exc_val, exc_tb): print('===close resource connection===') def operate(self): print('===in operation===') with Resource() as res: res.operate()
我們執(zhí)行一下,通過(guò)日志的打印順序。可以知道其執(zhí)行過(guò)程。
===connect to resource==
===in operation===
===close resource connection===
從這個(gè)示例可以很明顯的看出,在編寫代碼時(shí),可以將資源的連接或者獲取放在__enter__中,而將資源的關(guān)閉寫在__exit__ 中。
為什么要用上下文管理器?
學(xué)習(xí)時(shí)多問(wèn)自己幾個(gè)為什么,養(yǎng)成對(duì)一些細(xì)節(jié)的思考,有助于加深對(duì)知識(shí)點(diǎn)的理解。
為什么要使用上下文管理器?
在我看來(lái),這和 Python 崇尚的優(yōu)雅風(fēng)格有關(guān)。
可以以一種更加優(yōu)雅的方式,操作(創(chuàng)建/獲取/釋放)資源,如文件操作、數(shù)據(jù)庫(kù)連接;
可以以一種更加優(yōu)雅的方式,處理異常;
第一種,我們上面已經(jīng)以資源的連接為例講過(guò)了。
而第二種,會(huì)被大多數(shù)人所忽略。這里會(huì)重點(diǎn)講一下。
大家都知道,處理異常,通常都是使用 try...execept.. 來(lái)捕獲處理的。這樣做一個(gè)不好的地方是,在代碼的主邏輯里,會(huì)有大量的異常處理代理,這會(huì)很大的影響我們的可讀性。
好一點(diǎn)的做法呢,可以使用 with 將異常的處理隱藏起來(lái)。
仍然是以上面的代碼為例,我們將1/0 這個(gè)一定會(huì)拋出異常的代碼寫在 operate 里
class Resource(): def __enter__(self): print('===connect to resource===') return self def __exit__(self, exc_type, exc_val, exc_tb): print('===close resource connection===') return True def operate(self): 1/0 with Resource() as res: res.operate()
運(yùn)行一下,驚奇地發(fā)現(xiàn),居然不會(huì)報(bào)錯(cuò)。
這就是上下文管理協(xié)議的一個(gè)強(qiáng)大之處,異??梢栽赺_exit__ 進(jìn)行捕獲并由你自己決定如何處理,是拋出呢還是在這里就解決了。在__exit__ 里返回 True(沒(méi)有return 就默認(rèn)為 return False),就相當(dāng)于告訴 Python解釋器,這個(gè)異常我們已經(jīng)捕獲了,不需要再往外拋了。
在 寫__exit__ 函數(shù)時(shí),需要注意的事,它必須要有這三個(gè)參數(shù):
exc_type:異常類型
exc_val:異常值
exc_tb:異常的錯(cuò)誤棧信息
當(dāng)主邏輯代碼沒(méi)有報(bào)異常時(shí),這三個(gè)參數(shù)將都為None。
理解并使用 contextlib
在上面的例子中,我們只是為了構(gòu)建一個(gè)上下文管理器,卻寫了一個(gè)類。如果只是要實(shí)現(xiàn)一個(gè)簡(jiǎn)單的功能,寫一個(gè)類未免有點(diǎn)過(guò)于繁雜。這時(shí)候,我們就想,如果只寫一個(gè)函數(shù)就可以實(shí)現(xiàn)上下文管理器就好了。
這個(gè)點(diǎn)Python早就想到了。它給我們提供了一個(gè)裝飾器,你只要按照它的代碼協(xié)議來(lái)實(shí)現(xiàn)函數(shù)內(nèi)容,就可以將這個(gè)函數(shù)對(duì)象變成一個(gè)上下文管理器。
我們按照 contextlib 的協(xié)議來(lái)自己實(shí)現(xiàn)一個(gè)打開文件(with open)的上下文管理器。
import contextlib @contextlib.contextmanager def open_func(file_name): # __enter__方法 print('open file:', file_name, 'in __enter__') file_handler = open(file_name, 'r') # 【重點(diǎn)】:yield yield file_handler # __exit__方法 print('close file:', file_name, 'in __exit__') file_handler.close() return with open_func('/Users/MING/mytest.txt') as file_in: for line in file_in: print(line)
在被裝飾函數(shù)里,必須是一個(gè)生成器(帶有yield),而yield之前的代碼,就相當(dāng)于__enter__里的內(nèi)容。yield 之后的代碼,就相當(dāng)于__exit__ 里的內(nèi)容。
上面這段代碼只能實(shí)現(xiàn)上下文管理器的第一個(gè)目的(管理資源),并不能實(shí)現(xiàn)第二個(gè)目的(處理異常)。
如果要處理異常,可以改成下面這個(gè)樣子。
import contextlib @contextlib.contextmanager def open_func(file_name): # __enter__方法 print('open file:', file_name, 'in __enter__') file_handler = open(file_name, 'r') try: yield file_handler except Exception as exc: # deal with exception print('the exception was thrown') finally: print('close file:', file_name, 'in __exit__') file_handler.close() return with open_func('/Users/MING/mytest.txt') as file_in: for line in file_in: 1/0 print(line)
好像只要講到上下文管理器,大多數(shù)人都會(huì)談到打開文件這個(gè)經(jīng)典的例子。
但是在實(shí)際開發(fā)中,可以使用到上下文管理器的例子也不少。我這邊舉個(gè)我自己的例子。
在OpenStack中,給一個(gè)虛擬機(jī)創(chuàng)建快照時(shí),需要先創(chuàng)建一個(gè)臨時(shí)文件夾,來(lái)存放這個(gè)本地快照鏡像,等到本地快照鏡像創(chuàng)建完成后,再將這個(gè)鏡像上傳到Glance。然后刪除這個(gè)臨時(shí)目錄。
這段代碼的主邏輯是創(chuàng)建快照,而創(chuàng)建臨時(shí)目錄,屬于前置條件,刪除臨時(shí)目錄,是收尾工作。
雖然代碼量很少,邏輯也不復(fù)雜,但是“創(chuàng)建臨時(shí)目錄,使用完后再刪除臨時(shí)目錄”這個(gè)功能,在一個(gè)項(xiàng)目中很多地方都需要用到,如果可以將這段邏輯處理寫成一個(gè)工具函數(shù)作為一個(gè)上下文管理器,那代碼的復(fù)用率也大大提高。
代碼是這樣的
總結(jié)起來(lái),使用上下文管理器有三個(gè)好處:
提高代碼的復(fù)用率;
提高代碼的優(yōu)雅度;
提高代碼的可讀性;
到此這篇關(guān)于使用Python怎么實(shí)現(xiàn)一個(gè)上下文管理器的文章就介紹到這了,更多相關(guān)的內(nèi)容請(qǐng)搜索億速云以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持億速云!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。