python 上下文管理器

上下文管理器最常用的是確保正確關(guān)閉文件晓猛,

with open('/path/to/file', 'r') as f:
    f.read()

with 語(yǔ)句的基本語(yǔ)法戒职,

with expression [as variable]:
    with-block

expression是一個(gè)上下文管理器透乾,其實(shí)現(xiàn)了enterexit兩個(gè)函數(shù)磕秤。當(dāng)我們調(diào)用一個(gè)with語(yǔ)句時(shí), 依次執(zhí)行一下步驟市咆,
1.首先生成一個(gè)上下文管理器expression, 比如open('xx.txt').
2.執(zhí)行expression.enter()蒙兰。如果指定了[as variable]說(shuō)明符,將enter()的返回值賦給variable.
3.執(zhí)行with-block語(yǔ)句塊.
4.執(zhí)行expression.exit(),在exit()函數(shù)中可以進(jìn)行資源清理工作.
with語(yǔ)句不僅可以管理文件搜变,還可以管理鎖、連接等等挠他,如,

#管理鎖
import  threading
lock = threading.lock()
with lock:
    #執(zhí)行一些操作
    pass

#數(shù)據(jù)庫(kù)連接管理
def test_write():
    sql = """      #具體的sql語(yǔ)句
    """
    con = DBConnection()
    with con as cursor:   
        cursor.execute(sql)
        cursor.execute(sql)
        cursor.execute(sql)
自定義上下文管理器

上下文管理器就是實(shí)現(xiàn)了上下文協(xié)議的類(lèi) ,也就是要實(shí)現(xiàn) __enter__()__exit__()兩個(gè)方法殖侵。

__enter__():主要執(zhí)行一些環(huán)境準(zhǔn)備工作,同時(shí)返回一資源對(duì)象愉耙。如果上下文管理器open("test.txt")的enter()函數(shù)返回一個(gè)文件對(duì)象贮尉。
__exit__():完整形式為exit(type, value, traceback),這三個(gè)參數(shù)和調(diào)用sys.exec_info()函數(shù)返回值是一樣的,分別為異常類(lèi)型败砂、異常信息和堆棧。如果執(zhí)行體語(yǔ)句沒(méi)有引發(fā)異常昌犹,則這三個(gè)參數(shù)均被設(shè)為None。否則斜姥,它們將包含上下文的異常信息。_exit()方法返回True或False,分別指示被引發(fā)的異常有沒(méi)有被處理铸敏,如果返回False,引發(fā)的異常將會(huì)被傳遞出上下文杈笔。如果exit()函數(shù)內(nèi)部引發(fā)了異常,則會(huì)覆蓋掉執(zhí)行體的中引發(fā)的異常蒙具。處理異常時(shí)球榆,不需要重新拋出異常持钉,只需要返回False,with語(yǔ)句會(huì)檢測(cè)exit()返回False來(lái)處理異常融师。

class test_query:
    def __init__(self):
        pass

    def query(self):
        print('query')

    def __enter__(self):
        # 如果是數(shù)據(jù)庫(kù)連接就可以返回cursor對(duì)象
        # cursor = self.cursor
        # return cursor
        print('begin query,')
        return self #由于這里沒(méi)有資源對(duì)象就返回對(duì)象
        
    def __exit__(self,exc_type,exc_value,traceback):
        if traceback is None:
            print('End')
        else:
            print('Error')

        # 如果是數(shù)據(jù)庫(kù)連接提交操作
        # if traceback is None:
        #   self.commit()
        # else:
        #   self.rollback()
        
if __name__ == '__main__':
    with test_query() as q:
        q.query()

contextlib

編寫(xiě)enterexit仍然很繁瑣,因此Python的標(biāo)準(zhǔn)庫(kù)contextlib提供了更簡(jiǎn)單的寫(xiě)法舀射,
基本語(yǔ)法

   @contextmanager
        def some_generator(<arguments>):
            <setup>
            try:
                yield <value>
            finally:
                <cleanup>

生成器函數(shù)some_generator就和我們普通的函數(shù)一樣,它的原理如下:
some_generator函數(shù)在在yield之前的代碼等同于上下文管理器中的enter函數(shù).
yield的返回值等同于enter函數(shù)的返回值脆烟,即如果with語(yǔ)句聲明了as <variable>,則yield的值會(huì)賦給variable.
然后執(zhí)行<cleanup>代碼塊邢羔,等同于上下文管理器的exit函數(shù)。此時(shí)發(fā)生的任何異常都會(huì)再次通過(guò)yield函數(shù)返回拜鹤。
例,
自動(dòng)加括號(hào)

import contextlib

@contextlib.contextmanager
def tag(name):
    print('<{}>'.format(name))
    yield
    print('</{}>'.format(name))


if __name__ == '__main__':
    with tag('h1') as t:
        print('hello')
        print('context')

管理鎖

@contextmanager
def locked(lock):
    lock.acquire()
    try:
        yield
    finally:
        lock.release()

with locked(myLock):
    #代碼執(zhí)行到這里時(shí)敏簿,myLock已經(jīng)自動(dòng)上鎖
    pass
    #執(zhí)行完后會(huì),會(huì)自動(dòng)釋放鎖

管理文件關(guān)閉

@contextmanager
def myopen(filename, mode="r"):
    f = open(filename,mode)
    try:
        yield f
    finally:
        f.close()

with myopen("test.txt") as f:
    for line in f:
        print(line)

管理數(shù)據(jù)庫(kù)回滾

@contextmanager
def transaction(db):
    db.begin()
    try:
        yield 
    except:
        db.rollback()
        raise
    else:
        db.commit()

with transaction(mydb):
    mydb.cursor.execute(sql)
    mydb.cursor.execute(sql)
    mydb.cursor.execute(sql)
    mydb.cursor.execute(sql)

這就很方便惯裕!
如果一個(gè)對(duì)象沒(méi)有實(shí)現(xiàn)上下文绣硝,我們就不能把它用于with語(yǔ)句。這個(gè)時(shí)候鹉胖,可以用closing()來(lái)把該對(duì)象變?yōu)樯舷挛膶?duì)象。它的exit函數(shù)僅僅調(diào)用傳入?yún)?shù)的close函數(shù).
例如甫菠,用with語(yǔ)句使用urlopen():

import contextlib
from urllib.request import urlopen

if __name__ == '__main__':
    with contextlib.closing(urlopen('https://www.python.org')) as page:
        for line in page:
            print(line)

closing也是一個(gè)經(jīng)過(guò)@contextmanager裝飾的generator,這個(gè)generator編寫(xiě)起來(lái)其實(shí)非常簡(jiǎn)單:

@contextmanager
def closing(thing):
    try:
        yield thing
    finally:
        thing.close()

嵌套使用

import contextlib
from urllib.request import urlopen

if __name__ == '__main__':
    with contextlib.closing(urlopen('https://www.python.org')) as page,\
            contextlib.closing(urlopen('https://www.python.org')) as p:
        for line in page:
            print(line)
                print(p)

在2.x中需要使用contextlib.nested()才能使用嵌套淑蔚,3.x中可以直接使用。
更多函數(shù)可以參考官方文檔https://docs.python.org/3/library/contextlib.html

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末醋寝,一起剝皮案震驚了整個(gè)濱河市搞挣,隨后出現(xiàn)的幾起案子音羞,更是在濱河造成了極大的恐慌,老刑警劉巖嗅绰,帶你破解...
    沈念sama閱讀 212,884評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異窘面,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)财边,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,755評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)酣难,“玉大人,你說(shuō)我怎么就攤上這事憨募。” “怎么了菜谣?”我有些...
    開(kāi)封第一講書(shū)人閱讀 158,369評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)葛菇。 經(jīng)常有香客問(wèn)我橡羞,道長(zhǎng),這世上最難降的妖魔是什么卿泽? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,799評(píng)論 1 285
  • 正文 為了忘掉前任,我火速辦了婚禮签夭,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘第租。我一直安慰自己措拇,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,910評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布丐吓。 她就那樣靜靜地躺著浅悉,像睡著了一般术健。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上荞估,一...
    開(kāi)封第一講書(shū)人閱讀 50,096評(píng)論 1 291
  • 那天,我揣著相機(jī)與錄音勘伺,去河邊找鬼。 笑死褂删,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的笤妙。 我是一名探鬼主播,決...
    沈念sama閱讀 39,159評(píng)論 3 411
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼蹲盘,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了召衔?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 37,917評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤苍凛,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后醇蝴,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,360評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡悠栓,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,673評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了惭适。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,814評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡癞志,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 34,509評(píng)論 4 334
  • 正文 年R本政府宣布捡遍,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜酌摇,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,156評(píng)論 3 317
  • 文/蒙蒙 一窑多、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧埂息,春花似錦、人聲如沸遥巴。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,882評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至摆霉,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間携栋,已是汗流浹背搭盾。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,123評(píng)論 1 267
  • 我被黑心中介騙來(lái)泰國(guó)打工鸯隅, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人磅摹。 一個(gè)月前我還...
    沈念sama閱讀 46,641評(píng)論 2 362
  • 正文 我出身青樓滋迈,卻偏偏與公主長(zhǎng)得像户誓,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子帝美,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,728評(píng)論 2 351

推薦閱讀更多精彩內(nèi)容