With語句是什嗎?
有一些任務,可能事先需要設定,事後做清理工作。對於這種情境,Python的with語句提供了一種非常方便的處理方式。一個很好的例子是檔案處理,你需要擷取一個檔案控制代碼,從檔案中讀取資料,然後關閉檔案控制代碼。
如果不用with語句,代碼如下:
代碼如下:
file = open("/tmp/foo.txt")
data = file.read()
file.close()
這裡有兩個問題。一是可能忘記關閉檔案控制代碼;二是檔案讀取資料發生異常,沒有進行任何處理。下面是處理異常的加強版本:
代碼如下:
file = open("/tmp/foo.txt")
try:
data = file.read()
finally:
file.close()
雖然這段代碼運行良好,但是太冗長了。這時候就是with一展身手的時候了。除了有更優雅的文法,with還可以很好的處理上下文環境產生的異常。下面是with版本的代碼:
代碼如下:
with open("/tmp /foo.txt") as file:
data = file.read()
with如何工作?
這看起來充滿魔法,但不僅僅是魔法,Python對with的處理還很聰明。基本思想是with所求值的對象必須有一個__enter__()方法,一個__exit__()方法。
緊跟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__()
正如你看到的,
__enter__()方法被執行
__enter__()方法返回的值 - 這個例子中是"Foo",賦值給變數'sample'
執行代碼塊,列印變數"sample"的值為 "Foo"
__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:
value: integer division or modulo by zero
trace:
Traceback (most recent call last):
File "./with_example02.py", line 19, in
sample.do_somet hing()
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__方法當中。
因此,Python的with語句是提供一個有效機制,讓代碼更簡練,同時在異常產生時,清理工作更簡單。
範例程式碼可以在Github上面找到。