python的with用法(參考)


一、With語句是什么?

有一些任務,可能事先需要設置,事后做清理工作。對於這種場景,Python的with語句提供了一種非常方便的處理方式。一個很好的例子是文件處理,你需要獲取一個文件句柄,從文件中讀取數據,然后關閉文件句柄。

如果不用with語句,代碼如下:

file = open("/tmp/foo.txt") data = file.read() file.close()

這里有兩個問題:

一是可能忘記關閉文件句柄; 
二是文件讀取數據發生異常,沒有進行任何處理。

下面是處理異常的加強版本:

try: f = open('xxx') except: print 'fail to open' exit(-1) try: do something except: do something finally: f.close()

雖然這段代碼運行良好,但是太冗長了。

這時候就是with一展身手的時候了。除了有更優雅的語法,with還可以很好的處理上下文環境產生的異常。

下面是with版本的代碼:

with open("/tmp/foo.txt") as file: data = file.read()
-----------------------------------------------------------------------------------------------------------------------------
二、
with如何工作?

緊跟with后面的語句被求值后,返回對象的 __enter__() 方法被調用,這個方法的返回值將被賦值給as后面的變量。 
當with后面的代碼塊全部被執行完之后,將調用前面返回對象的 __exit__()方法。

下面例子可以具體說明with如何工作:

#!/usr/bin/env python # with_example01.py class Sample: def __enter__(self): print "In __enter__()" return "Foo" def __exit__(self, type, value, trace): print "In __exit__()" def get_sample(): return Sample() with get_sample() as sample: print "sample:", sample

 

運行代碼,輸出如下

bash-3.2$ ./with_example01.py In __enter__() sample: Foo In __exit__()
正如你看到的: 1. __enter__()方法被執行 2. __enter__()方法返回的值 - 這個例子中是”Foo”,賦值給變量’sample’ 3. 執行代碼塊,打印變量”sample”的值為 “Foo” 4. __exit__()方法被調用 
with真正強大之處是它可以處理異常。可能你已經注意到Sample類的 __exit__ 方法有三個參數 val, type 和 trace。 這些參數在異常處理中相當有用。我們來改一下代碼,看看具體如何工作的。
#!/usr/bin/env python
# with_example02.py class Sample:
def __enter__(self):
return self
def __exit__(self, type, value, trace):
print "type:", type
print "value:", value
print "trace:", trace
def do_something(self):
bar = 1/0
return bar + 10
with Sample() as sample:
sample.do_something()

這個例子中,with后面的get_sample()變成了Sample()。這沒有任何關系,只要緊跟with后面的語句所返回的對象有 __enter__() 和 __exit__() 方法即可。此例中,Sample()的 __enter__() 方法返回新創建的Sample對象,並賦值給變量sample。

代碼執行后:

bash-3.2$ ./with_example02.py type: <type 'exceptions.ZeroDivisionError'> value: integer division or modulo by zero trace: <traceback object at 0x1004a8128> Traceback (most recent call last): File "./with_example02.py", line 19, in <module> sample.do_something() File "./with_example02.py", line 15, in do_something bar = 1/0 ZeroDivisionError: integer division or modulo by zero


實際上,在with后面的代碼塊拋出任何異常時,__exit__() 方法被執行。正如例子所示,異常拋出時,與之關聯的type,value和stack trace傳給 __exit__() 方法,因此拋出的ZeroDivisionError異常被打印出來了。開發庫時,清理資源,關閉文件等等操作,都可以放在 __exit__ 方法當中。

另外,__exit__ 除了用於tear things down,還可以進行異常的監控和處理,注意后幾個參數。要跳過一個異常,只需要返回該函數True即可。

下面的樣例代碼跳過了所有的TypeError,而讓其他異常正常拋出。

def __exit__(self, type, value, traceback): return isinstance(value, TypeError)

總之,with-as表達式極大的簡化了每次寫finally的工作,這對保持代碼的優雅性是有極大幫助的。

如果有多個項,我們可以這么寫:

with open("x.txt") as f1, open('xxx.txt') as f2: do something with f1,f2

 

因此,Python的with語句是提供一個有效的機制,讓代碼更簡練,同時在異常產生時,清理工作更簡單。

三、相關術語

要使用 with 語句,首先要明白上下文管理器這一概念。有了上下文管理器,with 語句才能工作。 
下面是一組與上下文管理器和with 語句有關的概念。 
上下文管理協議(Context Management Protocol):包含方法 __enter__() 和 __exit__(),支持該協議的對象要實現這兩個方法。 
上下文管理器(Context Manager):支持上下文管理協議的對象,這種對象實現了__enter__() 和 __exit__() 方法。上下文管理器定義執行 with 語句時要建立的運行時上下文,負責執行 with 語句塊上下文中的進入與退出操作。通常使用 with 語句調用上下文管理器,也可以通過直接調用其方法來使用。 
運行時上下文(runtime context):由上下文管理器創建,通過上下文管理器的 __enter__() 和__exit__() 方法實現,__enter__() 方法在語句體執行之前進入運行時上下文,__exit__() 在語句體執行完后從運行時上下文退出。with 語句支持運行時上下文這一概念。 
上下文表達式(Context Expression):with 語句中跟在關鍵字 with 之后的表達式,該表達式要返回一個上下文管理器對象。 
語句體(with-body):with 語句包裹起來的代碼塊,在執行語句體之前會調用上下文管理器的 __enter__() 方法,執行完語句體之后會執行__exit__() 方法。




免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2026 CODEPRJ.COM