最直觀的上下文，莫過于小學(xué)的語文課，經(jīng)常會(huì)問
聯(lián)系上下文，推測...，回答...，表明作者...
。文章里的上下文比較好懂，無非就是
前
與
后
。
在了解了計(jì)算機(jī)的執(zhí)行狀態(tài)，程式的運(yùn)行，才稍微對計(jì)算機(jī)的上下文(context)有了一定的認(rèn)識，多半還是只可意會(huì)，不可言傳。本文所討論的上下文，簡而言之，就是程式所執(zhí)行的環(huán)境狀態(tài)，或者說程式運(yùn)行的情景。
提及上下文，就不可避免的涉及Python中關(guān)于上下文的魔法，即上下文管理器（contextor）。
資源的創(chuàng)建和釋放場景
上下文管理器的常用于一些資源的操作，需要在資源的獲取與釋放相關(guān)的操作，一個(gè)典型的例子就是數(shù)據(jù)庫的連接，查詢，關(guān)閉處理。
先看如下一個(gè)例子：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
class Database(object): ? ????def __init__(self): ????????self.connected = False ? ????def connect(self): ????????self.connected = True ? ????def close(self): ????????self.connected = False ? ????def query(self): ????????if self.connected: ????????????return 'query data' ????????else: ????????????raise ValueError('DB not connected ') ? def handle_query(): ????db = Database() ????db.connect() ????print 'handle --- ', db.query() ????db.close() ? def main(): ????handle_query() ? if __name__ == '__main__': ????main() |
上述的代碼很簡單，針對
Database
這個(gè)數(shù)據(jù)庫類，提供了
connect
query
和
close
三種常見的db交互接口?？蛻舳说拇a中，需要查詢數(shù)據(jù)庫并處理查詢結(jié)果。當(dāng)然這個(gè)操作之前，需要連接數(shù)據(jù)庫（db.connect()）和操作之后關(guān)閉數(shù)據(jù)庫連接（ db.close()）。上述的代碼可以work，可是如果很多地方有類似handle_query的邏輯，連接和關(guān)閉這樣的代碼就得copy很多遍，顯然不是一個(gè)優(yōu)雅的設(shè)計(jì)。
對于這樣的場景，在python黑魔法—裝飾器中有討論如何優(yōu)雅的處理。下面使用裝飾器進(jìn)行改寫如下：.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
class Database(object): ????... ? def dbconn(fn): ????def wrapper(*args, **kwargs): ????????db = Database() ????????db.connect() ????????ret = fn(db, *args, **kwargs) ????????db.close() ????????return ret ????return wrapper ? @dbconn def handle_query(db=None): ????print 'handle --- ', db.query() ? def main(): ????... |
編寫一個(gè)dbconn的裝飾器，然后在針對handle_query進(jìn)行裝飾即可。使用裝飾器，復(fù)用了很多數(shù)據(jù)庫連接和釋放的代碼邏輯，看起來不錯(cuò)。
裝飾器解放了生產(chǎn)力。可是，每個(gè)裝飾器都需要事先定義一下db的資源句柄，看起來略丑，不夠優(yōu)雅。
?
優(yōu)雅的With as語句
Python提供了With語句語法，來構(gòu)建對資源創(chuàng)建與釋放的語法糖。給Database添加兩個(gè)魔法方法：
|
1 2 3 4 5 6 7 8 9 10 |
class Database(object): ? ????... ? ????def __enter__(self): ????????self.connect() ????????return self ? ????def __exit__(self, exc_type, exc_val, exc_tb): ????????self.close() |
然后修改handle_query函數(shù)如下：
|
1 2 3 |
def handle_query(): ????with Database() as db: ????????print 'handle ---', db.query() |
在Database類實(shí)例的時(shí)候，使用with語句。一切正常work。比起裝飾器的版本，雖然多寫了一些字符，但是代碼可讀性變強(qiáng)了。
?
上下文管理協(xié)議
前面初略的提及了上下文，那什么又是上下文管理器呢？與python黑魔法—迭代器類似，實(shí)現(xiàn)了迭代協(xié)議的函數(shù)/對象即為迭代器。實(shí)現(xiàn)了上下文協(xié)議的函數(shù)/對象即為上下文管理器。
迭代器協(xié)議是實(shí)現(xiàn)了
__iter__
方法。上下文管理協(xié)議則是
_
_enter__
、
__exit__
。對于如下代碼結(jié)構(gòu)：
|
1 2 3 4 5 6 7 8 9 10 11 |
class Contextor: ????def __enter__(self): ????????pass ? ????def __exit__(self, exc_type, exc_val, exc_tb): ????????pass ? contextor = Contextor() ? with contextor [as var]: ????with_body |
Contextor
實(shí)現(xiàn)了
__enter__
和
__exit__
這兩個(gè)上下文管理器協(xié)議，當(dāng)Contextor調(diào)用/實(shí)例化的時(shí)候，則創(chuàng)建了上下文管理器
contextor
。類似于實(shí)現(xiàn)迭代器協(xié)議類調(diào)用生成迭代器一樣。
配合with語句使用的時(shí)候，上下文管理器會(huì)自動(dòng)調(diào)用
__enter__
方法，然后進(jìn)入運(yùn)行時(shí)上下文環(huán)境，如果有as 從句，返回自身或另一個(gè)與運(yùn)行時(shí)上下文相關(guān)的對象，值賦值給var。當(dāng)with_body執(zhí)行完畢退出with語句塊或者with_body代碼塊出現(xiàn)異常，則會(huì)自動(dòng)執(zhí)行
__exit__
方法，并且會(huì)把對于的異常參數(shù)傳遞進(jìn)來。如果
__exit__
函數(shù)返回
True
。則with語句代碼塊不會(huì)顯示的拋出異常，終止程序，如果返回None或者False，異常會(huì)被主動(dòng)raise，并終止程序。
大致對with語句的執(zhí)行原理總結(jié)Python上下文管理器與with語句:
- 執(zhí)行 contextor 以獲取上下文管理器
- 加載上下文管理器的 exit () 方法以備稍后調(diào)用
- 調(diào)用上下文管理器的 enter () 方法
- 如果有 as var 從句，則將 enter () 方法的返回值賦給 var
- 執(zhí)行子代碼塊 with_body
- 調(diào)用上下文管理器的 exit () 方法，如果 with_body 的退出是由異常引發(fā)的，那么該異常的 type、value 和 traceback 會(huì)作為參數(shù)傳給 exit ()，否則傳三個(gè) None
- 如果 with_body 的退出由異常引發(fā)，并且 exit () 的返回值等于 False，那么這個(gè)異常將被重新引發(fā)一次；如果 exit () 的返回值等于 True，那么這個(gè)異常就被無視掉，繼續(xù)執(zhí)行后面的代碼
了解了with語句和上下文管理協(xié)議，或許對上下文有了一個(gè)更清晰的認(rèn)識。即代碼或函數(shù)執(zhí)行的時(shí)候，調(diào)用函數(shù)時(shí)候有一個(gè)環(huán)境，在不同的環(huán)境調(diào)用，有時(shí)候效果就不一樣，這些不同的環(huán)境就是上下文。例如數(shù)據(jù)庫連接之后創(chuàng)建了一個(gè)數(shù)據(jù)庫交互的上下文，進(jìn)入這個(gè)上下文，就能使用連接進(jìn)行查詢，執(zhí)行完畢關(guān)閉連接退出交互環(huán)境。創(chuàng)建連接和釋放連接都需要有一個(gè)共同的調(diào)用環(huán)境。不同的上下文，通常見于異步的代碼中。
?
上下文管理器工具
通過實(shí)現(xiàn)上下文協(xié)議定義創(chuàng)建上下文管理器很方便，Python為了更優(yōu)雅，還專門提供了一個(gè)模塊用于實(shí)現(xiàn)更函數(shù)式的上下文管理器用法。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
import contextlib ? @contextlib.contextmanager def database(): ????db = Database() ????try: ????????if not db.connected: ????????????db.connect() ????????yield db ????except Exception as e: ????????db.close() ? def handle_query(): ????with database() as db: ????????print 'handle ---', db.query() |
使用contextlib 定義一個(gè)上下文管理器函數(shù)，通過with語句，database調(diào)用生成一個(gè)上下文管理器，然后調(diào)用函數(shù)隱式的
__enter__
方法，并將結(jié)果通yield返回。最后退出上下文環(huán)境的時(shí)候，在except代碼塊中執(zhí)行了
__exit__
方法。當(dāng)然我們可以手動(dòng)模擬上述代碼的執(zhí)行的細(xì)節(jié)。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
In [1]: context = database()????# 創(chuàng)建上下文管理器 ? In [2]: context ? ? In [3]: db = context.__enter__() # 進(jìn)入with語句 ? In [4]: db???????????????????????????? # as語句，返回 Database實(shí)例 Out[4]: ? In [5]: db.query()?????? Out[5]: 'query data' ? In [6]: db.connected Out[6]: True ? In [7]: db.__exit__(None, None, None)????# 退出with語句 ? In [8]: db Out[8]: ? In [9]: db.connected Out[9]: False |
?
上下文管理器的用法
既然了解了上下文協(xié)議和管理器，當(dāng)然是運(yùn)用到實(shí)踐啦。通常需要切換上下文環(huán)境，往往是在多線程/進(jìn)程這種編程模型。當(dāng)然，單線程異步或者協(xié)程的當(dāng)時(shí)，也容易出現(xiàn)函數(shù)的上下文環(huán)境經(jīng)常變動(dòng)。
異步式的代碼經(jīng)常在定義和運(yùn)行時(shí)存在不同的上下文環(huán)境。此時(shí)就需要針對異步代碼做上下文包裹的hack。看下面一個(gè)例子：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
import tornado.ioloop ? ioloop = tornado.ioloop.IOLoop.instance() ? ? def callback(): ????print 'run callback' ????raise ValueError('except in callback') ? def async_task(): ????print 'run async task' ????ioloop.add_callback(callback=callback) ? def main(): ? ????try: ????????async_task() ????except Exception as e: ????????print 'exception {}'.format(e) ????print 'end' ? main() ioloop.start() ? 運(yùn)行上述代碼得到如下結(jié)果 ? run async task end run callback ERROR:root:Exception in callback Traceback (most recent call last): ??... ????raise ValueError('except in callback') ValueError: except in callback |
主函數(shù)中main中，定義了異步任務(wù)函數(shù)async_task的調(diào)用。async_task中異常，在except中很容易catch，可是callback中出現(xiàn)的異常，則無法捕捉。原因就是定義的時(shí)候上下文為當(dāng)前的線程執(zhí)行環(huán)境，而使用了tornado的ioloop.add_callback方法，注冊了一個(gè)異步的調(diào)用。當(dāng)callback異步執(zhí)行的時(shí)候，他的上下文已經(jīng)和async_task的上下文不一樣了。因此在main的上下文，無法catch異步中callback的異常。
下面使用上下文管理器包裝如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
class Contextor(object): ????def __enter__(self): ????????pass ? ????def __exit__(self, exc_type, exc_val, exc_tb): ????????if all([exc_type, exc_val, exc_tb]): ????????????print 'handler except' ????????????print 'exception {}'.format(exc_val) ????????return True ? def main(): ????with tornado.stack_context.StackContext(Contextor): ????????async_task() ? 運(yùn)行main之后的結(jié)果如下： ? run async task handler except run callback handler except exception except in callback |
可見，callback的函數(shù)的異常，在上下文管理器Contextor中被處理了，也就是說callback調(diào)用的時(shí)候，把之前main的上下文保存并傳遞給了callback。當(dāng)然，上述的代碼也可以改寫如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
@contextlib.contextmanager def contextor(): ????try: ????????yield ????except Exception as e: ????????print 'handler except' ????????print 'exception {}'.format(e) ????finally:???? ????????print 'release' ? def main(): ????with tornado.stack_context.StackContext(contextor): ????????async_task() |
效果類似。當(dāng)然，也許有人會(huì)對StackContext這個(gè)tornado的模塊感到迷惑。其實(shí)他恰恰應(yīng)用上下文管理器的魔法的典范。查看StackContext的源碼，實(shí)現(xiàn)非常精秒，非常佩服tornado作者的編碼設(shè)計(jì)能力。至于StackContext究竟如何神秘，已經(jīng)超出了本篇的范圍，將會(huì)在介紹tonrado異步上下文管理器中介紹
更多文章、技術(shù)交流、商務(wù)合作、聯(lián)系博主
微信掃碼或搜索：z360901061
微信掃一掃加我為好友
QQ號聯(lián)系： 360901061
您的支持是博主寫作最大的動(dòng)力，如果您喜歡我的文章，感覺我的文章對您有幫助，請用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧，狠狠點(diǎn)擊下面給點(diǎn)支持吧，站長非常感激您！手機(jī)微信長按不能支付解決辦法：請將微信支付二維碼保存到相冊，切換到微信，然后點(diǎn)擊微信右上角掃一掃功能，選擇支付二維碼完成支付。
【本文對您有幫助就好】元
