with 這個關(guān)鍵字，對于每一學(xué)習(xí)Python的人，都不會陌生。

操作文本對象的時候，幾乎所有的人都會讓我們要用 with open ，這就是一個上下文管理的例子。你一定已經(jīng)相當熟悉了，我就不再廢話了。

with open('test.txt') as f:

print f.readlines()

1. what context manager？

基本語法

with EXPR as VAR:

BLOCK

先理清幾個概念

1. 上下文表達式：with open('test.txt') as f:

2. 上下文管理器：open('test.txt')

3. f 不是上下文管理器，應(yīng)該是資源對象。

2. how context manager？

要自己實現(xiàn)這樣一個上下文管理，要先知道上下文管理協(xié)議。

簡單點說，就是在一個類里，實現(xiàn)了__enter__和__exit__的方法，這個類的實例就是一個上下文管理器。

例如這個示例：

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í)行一下，通過日志的打印順序。可以知道其執(zhí)行過程。

===connect to resource===

===in operation===

===close resource connection===

從這個示例可以很明顯的看出，在編寫代碼時，可以將資源的連接或者獲取放在__enter__中，而將資源的關(guān)閉寫在__exit__ 中。

3. why context manager？

學(xué)習(xí)時多問自己幾個為什么，養(yǎng)成對一些細節(jié)的思考，有助于加深對知識點的理解。

為什么要使用上下文管理器？

在我看來，這和 Python 崇尚的優(yōu)雅風(fēng)格有關(guān)。

可以以一種更加優(yōu)雅的方式，操作(創(chuàng)建/獲取/釋放)資源，如文件操作、數(shù)據(jù)庫連接；

可以以一種更加優(yōu)雅的方式，處理異常；

第一種，我們上面已經(jīng)以資源的連接為例講過了。

而第二種，會被大多數(shù)人所忽略。這里會重點講一下。

大家都知道，處理異常，通常都是使用 try...execept.. 來捕獲處理的。這樣做一個不好的地方是，在代碼的主邏輯里，會有大量的異常處理代理，這會很大的影響我們的可讀性。

好一點的做法呢，可以使用 with 將異常的處理隱藏起來。

仍然是以上面的代碼為例，我們將1/0 這個一定會拋出異常的代碼寫在 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()

運行一下，驚奇地發(fā)現(xiàn)，居然不會報錯。

這就是上下文管理協(xié)議的一個強大之處，異常可以在__exit__ 進行捕獲并由你自己決定如何處理，是拋出呢還是在這里就解決了。在__exit__ 里返回 True(沒有return 就默認為 return False)，就相當于告訴 Python解釋器，這個異常我們已經(jīng)捕獲了，不需要再往外拋了。

在 寫__exit__ 函數(shù)時，需要注意的事，它必須要有這三個參數(shù)：

exc_type：異常類型

exc_val：異常值

exc_tb：異常的錯誤棧信息

當主邏輯代碼沒有報異常時，這三個參數(shù)將都為None。

4. how contextlib?

在上面的例子中，我們只是為了構(gòu)建一個上下文管理器，卻寫了一個類。如果只是要實現(xiàn)一個簡單的功能，寫一個類未免有點過于繁雜。這時候，我們就想，如果只寫一個函數(shù)就可以實現(xiàn)上下文管理器就好了。

這個點Python早就想到了。它給我們提供了一個裝飾器，你只要按照它的代碼協(xié)議來實現(xiàn)函數(shù)內(nèi)容，就可以將這個函數(shù)對象變成一個上下文管理器。

我們按照 contextlib 的協(xié)議來自己實現(xiàn)一個打開文件(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')

# 【重點】：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ù)里，必須是一個生成器(帶有yield)，而yield之前的代碼，就相當于__enter__里的內(nèi)容。yield 之后的代碼，就相當于__exit__ 里的內(nèi)容。

上面這段代碼只能實現(xiàn)上下文管理器的第一個目的(管理資源)，并不能實現(xiàn)第二個目的(處理異常)。

如果要處理異常，可以改成下面這個樣子。

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ù)人都會談到打開文件這個經(jīng)典的例子。

但是在實際開發(fā)中，可以使用到上下文管理器的例子也不少。我這邊舉個我自己的例子。

在OpenStack中，給一個虛擬機創(chuàng)建快照時，需要先創(chuàng)建一個臨時文件夾，來存放這個本地快照鏡像，等到本地快照鏡像創(chuàng)建完成后，再將這個鏡像上傳到Glance。然后刪除這個臨時目錄。

這段代碼的主邏輯是創(chuàng)建快照，而創(chuàng)建臨時目錄，屬于前置條件，刪除臨時目錄，是收尾工作。

雖然代碼量很少，邏輯也不復(fù)雜，但是“創(chuàng)建臨時目錄，使用完后再刪除臨時目錄”這個功能，在一個項目中很多地方都需要用到，如果可以將這段邏輯處理寫成一個工具函數(shù)作為一個上下文管理器，那代碼的復(fù)用率也大大提高。

代碼是這樣的

總結(jié)起來，使用上下文管理器有三個好處：

提高代碼的復(fù)用率；

提高代碼的優(yōu)雅度；

提高代碼的可讀性；

推薦下我本人原創(chuàng)的 《PyCharm 中文指南》電子書，內(nèi)含大量(300張)的圖解，制作之精良，值得每個 Python 工程師點個收藏。

總結(jié)

以上是生活随笔為你收集整理的python上下文管理关键字_详解 Python 中的 with 与 上下文管理器的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。